Cases

cases can be managed throw API interface. API can be used to create , edit or View cases.

 

View Cases

This API helps you to view information for specific case or retrieve a list of cases/sub-cases based on specific view or filter.

It also allow search on cases with specific subtitles and return all case having this subtitle.

This API allow retrieving of one or more case details.  

 

Request

 

METHOD

URL

GET

https://nabdsys.nabdsys.com/api/GetCases

 

Parameters

ATTRIBUTE

TYPE

DESCRIPTION
api-token* string (Header)

Pass “api-token” into request header to validate the calling

e.g.

“api-token” = “FWArGpxA1uKdeKPCa+b3SJiONmSey+as”
clientName* string Subscribed Account Name.
<clientName>.NABD.com
userName* string

Authenticated user Name
Searchtext string

Search by case number or case subject.
StartingRowNo* number

The index of starting row number
RequestedRowCount* number

Number of returned cases with max of 100 cases
languageId number

Language Id of the requested view. default language is English.

Refer to properties table for supported values.

 

Fields marked with * are mandatory.

 

Language Properties

SOURCE

VALUE

Arabic

 1

English

 2

French

6

German

7

Italian

8

Danish

9

 

Response   

 

{

   "errorCode":0,

   "errorDescription":null,

   "technicalError":null,

   "count":"1",

   "data":[

      {

         "ComplaintId":202,

         "CaseNumber":2,

         "Subject":"Title of the case",

         "SubmitDate":"12/1/2018 11:28:25 AM",

         "UserName":"agent1",

         "ComplaintStatus":"Closed",

         "LastUpdatedTime":"",

         "LastUpdatedBy":null,

         "Priority":"High",

         "CaseSource":1,

         "CustomerName":"John Smith",

         "UserIds":[

            29,

            35,

            36

         ],

         "RoleIds":[

         ],

         "OuIds":[

         ],

         "UserGroupIds":[

         ]

      }

   ]

}