SMsmileapi
Employments

Get Employment

Changed on

Get a user's employment by ID.

get/employments/{id}

Request

  • Base URL
    https://sandbox.smileapi.io/v1
  • URL
    https://sandbox.smileapi.io/v1/employments/{id}
  • Auth
    HTTP basic

Response

OK

code'OK' | 'CREATED' | 'INVALID_CREDENTIALS' | 'INVALID_PARAMETERS' | 'INVALID_TOKEN' | 'UNAUTHORIZED_ACCESS' | 'MISSING_RESOURCE' | 'REQUEST_LIMIT_EXCEEDED' | 'SERVER_ERROR' | 'UNSUPPORTED_METHOD' | 'SERVER_UNAVAILABLE' | 'TIME_LIMIT_EXCEEDED'

Request status code

messagestring

Message response to the request

requestIdstring

Unique ID that is added to the body of every response for easy traceability of the request in our logs.

Example response

{
  "code": "OK",
  "message": "Success",
  "requestId": "5b79399a-6852-4234-bb0e-ad472648282d",
  "data": {
    "id": "17bbf36498de4d68a0d4f86c7b62f69f",
    "name": "Digital Marketing",
    "description": "Gathering and reporting relevant data, maintaining specific reports and dashboards, using platforms and programs to address marketing requirements, and updating specific marketing materials.",
    "jobTitle": "Digital Marketing Assistant",
    "department": "Marketing",
    "employeeNumber": "EMP-123456",
    "employerNumber": "ER-654321",
    "employer": "ABC Corporation",
    "status": "Permanent",
    "startDate": "2016-02-24",
    "endDate": "2019-08-24",
    "reportedDate": "2019-08-25",
    "metadata": {
      "itemCreatedAt": "2021-04-14T09:30:24Z",
      "createdAt": "2021-04-14T09:30:24Z",
      "sourceType": "Account"
    }
  }
}

Changes

  • v13bcbeecafbabRevision changes
    • info

      removed the non-success response with the status

    • info

      removed the non-success response with the status

    • info

      removed the non-success response with the status

    • info

      removed the non-success response with the status

    • info

      removed the non-success response with the status

    • info

      removed the non-success response with the status

    • info

      removed the non-success response with the status

    • info

      removed the non-success response with the status

    • info

      removed the non-success response with the status

    • info

      removed the non-success response with the status

  • v16ee094b51780Revision changes
    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property ///// to the response with the status