ACacculynx
contacts

Get Jobs for a Contact

Changed on

Retrieves a paginated list of all jobs that the contact is associated with.

Pagination:

  • PageStartIndex: Zero-based index of the first record to return (default: 0)
  • PageSize: Number of records per page (default: 25, max: 50)
  • Both pagination parameters are optional

Behavior:

  • Returns 200 with an empty items array if the contact exists but has no jobs associated
  • Returns 400 if any path or a query string parameter (contactId, pageSize, pageStartIndex) doesn't fulfill the validations
  • Returns 404 if the contactId does not exist
  • Returns 416 if pageStartIndex or pageSize are negative, or exceeds the maximum allowed
  • Returns 500 if an internal error occurs.
get/contacts/{contactId}/jobs

Request

  • Base URL
    https://api.acculynx.com/api/v2
  • URL
    https://api.acculynx.com/api/v2/contacts/{contactId}/jobs
  • Auth
    HTTP bearer

Path parameters

contactIdstring uuid required

The contact's unique identifier

Query parameters

pageSizeinteger

How many items to be returned at a time.

pageStartIndexinteger

The value of pageStartIndex will specify the index of the record that the list begins with.

Response

OK

countinteger

The total number of items matching the current query.

pageSizeinteger

The requested or default page size.

pageStartIndexinteger

The requested or default index of the first element to return.

Example response

{
  "items": [
    {
      "id": "2656d230-82bb-4c41-ae04-aa38426eebad",
      "_link": "https://api.acculynx.com/v2/jobs/2656d230-82bb-4c41-ae04-aa38426eebad"
    },
    {
      "id": "94935bc9-63e5-4b9c-af17-430661a699f9",
      "_link": "https://api.acculynx.com/v2/jobs/94935bc9-63e5-4b9c-af17-430661a699f9"
    }
  ]
}

Changes

  • 443924b00f43Revision changes
    • breaking

      for the query request parameter pageSize, default value 25 was removed

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • warning

      deleted the query request parameter recordStartIndex

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • info

      added the new optional query request parameter pageStartIndex

    • info

      added the optional property to the response with the status