Znode

GET caserequests

Gets a list of case requests.

Request Information

» Expands

Name Description Usage
casePriority This will retrieve the related case priority. GET caserequests?expand=casepriority
caseStatus This will retrieve the related case status. GET caserequests?expand=casestatus
caseType This will retrieve the related case type. GET caserequests?expand=casetype

» Filters

Name Description Usage
accountId This will filter the request by account ID. GET caserequests?filter=accountid~{operator}~{value}
casePriorityId This will filter the request by case priority ID. GET caserequests?filter=casepriorityid~{operator}~{value}
caseStatusId This will filter the request by case status ID. GET caserequests?filter=casestatusid~{operator}~{value}
caseTypeId This will filter the request by case type ID. GET caserequests?filter=casetypeid~{operator}~{value}
createDate This will filter the request by create date. GET caserequests?filter=createdate~{operator}~{value}
email This will filter the request by email. GET caserequests?filter=email~{operator}~{value}
lastName This will filter the request by last name. GET caserequests?filter=lastname~{operator}~{value}
ownerAccountId This will filter the request by owner account ID. GET caserequests?filter=owneraccountid~{operator}~{value}
portalId This will filter the request by portal ID. GET caserequests?filter=portalid~{operator}~{value}

» Sorting

Name Description Usage
casePriorityId This will sort the response by case priority ID. GET caserequests?sort=casepriorityid
caseRequestId This will sort the response by case request ID. GET caserequests?sort=caserequestid
caseStatusId This will sort the response by case status ID. GET caserequests?sort=casestatusid
caseTypeId This will sort the response by case type ID. GET caserequests?sort=casetypeid
createDate This will sort the response by create date. GET caserequests?sort=createdate
lastName This will sort the response by last name. GET caserequests?sort=lastname

» Paging

Name Description Usage
index The index to retrieve when requesting paged results. GET caserequests?page=index~{value}
size The size of the page when retrieving paged results. GET caserequests?page=size~{value}

Response Information

» Response Body Formats

If this endpoint supports expands, they will be included in the sample response body below. However, please note that expands are NOT included in the response body by default. Expands are only included in the response body if they came through as part of the request.

Sample:
	{
  "CaseRequests": [
    {
      "AccountId": 11522,
      "CaseOrigin": "Contact Us Form",
      "CasePriority": {
        "CasePriorityId": 2,
        "DisplayOrder": 2,
        "Name": "Medium"
      },
      "CasePriorityId": 3,
      "CaseRequestId": 1,
      "CaseStatus": {
        "CaseStatusId": 1,
        "DisplayOrder": 1,
        "Name": "Pending"
      },
      "CaseStatusId": 1,
      "CaseType": {
        "CaseTypeId": 1,
        "Name": "Case associated with Account"
      },
      "CaseTypeId": 0,
      "CompanyName": "Test",
      "CreateDate": "2018-12-14T20:11:34.9657927-05:00",
      "CreateUser": "",
      "Description": "This is a test message.",
      "Email": "test@znode.com",
      "FirstName": "John",
      "LastName": "Smith",
      "OwnerAccountId": 11522,
      "PhoneNumber": "13453453453",
      "PortalId": 1,
      "Title": "Contact Us Form",
      "StoreName": null,
      "CaseStatusName": null,
      "CasePriorityName": null,
      "CaseNote": null,
      "CaseOldStatusName": null,
      "CaseNewStatusName": null
    }
  ],
  "PageIndex": null,
  "PageSize": null,
  "TotalPages": null,
  "TotalResults": null,
  "ErrorCode": null,
  "ErrorMessage": null,
  "HasError": false
}