Getting Started

    Overview

    The REST APIs provide programmatic access to read and write TempBuddy data.

    Before using the API you need to request your credentials. You can do it from the admin settings panel in TempBuddy.

    Basic Information

    All calls are done using POST or GET methods.

    All content, unless specified, must be send as Form Data (application/x-www-form-urlencoded).

    All response, unless specified, are in JSON. Some exceptions are: Profile Pictures and Files.

    Authentication

    Get API Credentials from admin settings panel.

    Send the client_id and client_secret as body parameters in each request.

    Examples

    You can have a look to the Api Example Section to know how to call the API.

    Parameters: Formats and Operators

    Operators usually work as: parameter=value and parameter_op=operator

    Some types available:

    • [type]:Array of elements of type 'type'

    Some operators available:

    • multi: allows to send only one value or multiple separated by comma.
    • eq: search for entities with that value in that parameter.
    • LIKE: search for entities that contains that value in that field.
    • =,<,>,<=,>=: Operators for number. It does the comparison as tempbuddy_value 'op' parameter_value

    Sort

    If request allows to sort data it should be as:

    • Parameter Name: orderBy
    • Parameter Value: 'field_to_sort' 'direction'. Ex: orderBy=name ASC.

    Allowed directions are: ASC or DESC.

  • AgencyApprovers

        • GET /apiC/1.0/agencyApprovers.json stable

          • Get the list of agency approvers.
  • Application

        • GET /apiC/1.0/application.json stable

          • Gets the application information.
        • POST /apiC/1.0/application/post.json stable

          • Insert an application
        • PUT /apiC/1.0/application/put.json stable

          • Update an application
  • Assignment

        • GET /apiC/1.0/assignment.json stable

          • Gets the assignment information.
        • PUT /apiC/1.0/assignment/cancel/put.json stable

          • Cancel an assignment
        • DELETE /apiC/1.0/assignment/delete.json stable

          • Cancel or stop an assignment
        • POST /apiC/1.0/assignment/post.json stable

          • Insert an assignment
        • PUT /apiC/1.0/assignment/put.json stable

          • Update an assignment
        • PUT /apiC/1.0/assignment/recover/put.json stable

          • Recover an assignment
  • Branch

        • GET /apiC/1.0/branch.json stable

          • Gets the branches information.
        • DELETE /apiC/1.0/branch/delete.json stable

          • Delete a branch
        • POST /apiC/1.0/branch/post.json stable

          • Add a branch
        • PUT /apiC/1.0/branch/put.json stable

          • Edit a branch
  • Candidate

        • GET /apiC/1.0/candidate.json stable

          • Gets the candidate information.
        • DELETE /apiC/1.0/candidate/delete.json stable

          • Delete a candidate
        • POST /apiC/1.0/candidate/post.json stable

          • Insert a candidate
        • GET /apiC/1.0/candidate/profilePicture stable

          • Gets candidate profile pictures. Max of 50 pictures at once.
        • PUT /apiC/1.0/candidate/put.json stable

          • Update a candidate
  • Client

        • GET /apiC/1.0/client.json stable

          • Gets the client information.
        • DELETE /apiC/1.0/client/contact/delete.json stable

          • Delete a client contact
        • GET /apiC/1.0/client/contact/get.json stable

          • Get a client contact.
        • POST /apiC/1.0/client/contact/post.json stable

          • Add a new contact to a client
        • PUT /apiC/1.0/client/contact/put.json stable

          • Edit a client contact
        • DELETE /apiC/1.0/client/delete.json stable

          • Delete a client
        • DELETE /apiC/1.0/client/location/delete.json stable

          • Delete a client location
        • GET /apiC/1.0/client/location/get.json stable

          • Get a client location.
        • POST /apiC/1.0/client/location/post.json stable

          • Add a new location to a client.
        • PUT /apiC/1.0/client/location/put.json stable

          • Edit a client location