Endpoint Parameters

  • Request parameters

    Name Type Origin Description
    $top Integer Query-String The number of entries to return from the beginning of the collection
    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
    __count Number The total count of items in the feed.
    __next String The link for the next page of items in the feed.
    Data CaseSummary [] The collection of entities for this feed.
    MaxRows Number The maximum number of rows that can be returned (if applicable).
  • Request Example

    Request URL
    GET /cs/v1/partner/support/cases?$top=1&FromDateTime=2019-01-01&Status=InProgress&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"
        }
      ]
    }