Endpoint Parameters

  • Request parameters

    Name Type Origin Description
    CaseId String Route The case ID
  • Response Parameters

    View Response Codes
    Name Type Description
    Case CaseDetails Case details
  • Request Example

    Request URL
    GET /cs/v1/partner/support/cases/SAX-567846-K5W7Q6
  • Response Example

    Response body
    {
      "Case": {
        "Activities": [
          {
            "ActivityPriority": "Low",
            "ActivityTime": "2019-04-04T10:07:46Z",
            "ActivityType": "Email",
            "From": {
              "EmailAddress": "johndoe@email.com",
              "Name": "John Doe"
            },
            "PhoneNumber": "+457372863",
            "Status": "Open"
          }
        ],
        "CaseId": "5464-XSDD-434-3DDS",
        "CaseLatestActivityTime": "2019-04-04T10:07:46Z",
        "CaseStatus": "InProgress",
        "CaseType": "Problem",
        "ClientId": "3748352",
        "ClientName": "John Doe",
        "ClientSegment": "Vip",
        "ContactPersonId": "3748352",
        "ContactPersonName": "John Doe",
        "CreatedOn": "2019-04-04T10:07:46Z",
        "Description": "Requesting instrument details",
        "FirstResponseSent": false,
        "FollowUpDateTime": "2019-04-15T10:07:46Z",
        "HandledByPartner": true,
        "InternalComments": [
          {
            "Comment": "This is a comment",
            "CreatedOn": "2019-04-04T10:07:46Z"
          }
        ],
        "IsEscalated": false,
        "Notes": [
          {
            "Attachment": {
              "FileName": "Support_Issue.jpg",
              "MimeType": "image/jpeg"
            },
            "CreatedOn": "2019-04-04T10:07:46Z",
            "NoteOrigin": "Other",
            "NoteText": "This is a note",
            "NoteTitle": "Note title"
          }
        ],
        "Origin": "Web",
        "ReassignmentCount": 0,
        "ServiceLanguage": "EN",
        "ShowInPortal": true,
        "Subject": "Viewing Instruments",
        "Title": "Instrument Details"
      }
    }