Endpoint Parameters

  • Request parameters

    Name Type Origin Description
    $top Int Query-String Optional number of elements to retrieve.
    FromDateTime UtcDateTime Query-String Includes cases with latest activity time greater than or equal to FromDateTime
    Status CaseStatus [] Query-String Status: If specified will only return entries with the specified case status
    ToDateTime UtcDateTime Query-String Includes cases with latest activity time less than or equal to ToDateTime
  • Response Parameters

    View Response Codes
    Name Type Description
    CaseId String Case id
    CaseLatestActivityTime UtcDateTime DateTime of case latest activity
    CaseStatus CaseStatus Case status
    ClientId String Customer Id
    CreatedOn UtcDateTime DateTime when the case was created
    CustomerName String Customer Name
    Deadline UtcDateTime Case deadline
    FollowUpDateTime UtcDateTime Date time of when the case is due to follow up
    HandledByPartner Bool Is handled by Partner
    IsEscalated Bool Represents if the case has been escalated
    Title String Title of case
  • Request Example

    Request URL
    GET cs/v1/partner/support/cases/?$top=99&Status=InProgress&FromDateTime=2019-01-01&ToDateTime=2019-04-04
  • Response Example

    Response body
    {
      "__count": 1,
      "Data": [
        {
          "CaseId": "5464-XSDD-434-3DDS",
          "CaseLatestActivityTime": "2019-04-04T10:07:46Z",
          "CaseStatus": "InProgress",
          "ClientId": "4334435",
          "CreatedOn": "2019-04-04T10:07:46Z",
          "CustomerName": "John Doe",
          "FollowUpDateTime": "2019-04-15T10:07:46Z",
          "HandledByPartner": false,
          "IsEscalated": true,
          "Title": "Instrument request"
        }
      ]
    }