POST Cases

Case Enqueue for FIFO

Request Information

URI Parameters

None.

Body Parameters

Case Information

Name	Description	Type	Additional information
CaseId	Return value CaseId	integer	None.
ServiceId	Service ID to enqueue into	integer	Required
ServiceIdExtRef		string	None.
CustomerId	Existing Customer ID (optional)	integer	None.
ExtRef	ExtRef (Sometimes used for mobile # if no customer record is attached)	string	Max length: 200
Notes	Case Notes	string	Max length: 4000
Subject	Case Subject line	string	Max length: 100
ClassificationCode	Classification Code	string	None.
AutoClose	Enqueue and close the case (for statistics). Default false	boolean	None.
CustomProperties	Collection of all custom properties for this case process	Dictionary of string [key] and string [value]	None.
ProcedureExtRef		string	None.
ProcedureOptionExtRef		string	None.

Request Formats

application/json, text/json

Sample:

{
  "CaseId": 1,
  "ServiceId": 2,
  "ServiceIdExtRef": "sample string 3",
  "CustomerId": 4,
  "ExtRef": "sample string 5",
  "Notes": "sample string 6",
  "Subject": "sample string 7",
  "ClassificationCode": "sample string 8",
  "AutoClose": true,
  "CustomProperties": {
    "sample string 1": "sample string 2",
    "sample string 3": "sample string 4"
  },
  "ProcedureExtRef": "sample string 10",
  "ProcedureOptionExtRef": "sample string 11"
}

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

CaseEnqueue

Name	Description	Type	Additional information
CaseId	Return value CaseId	integer	None.
ServiceId	Service ID to enqueue into	integer	Required
ServiceIdExtRef		string	None.
CustomerId	Existing Customer ID (optional)	integer	None.
ExtRef	ExtRef (Sometimes used for mobile # if no customer record is attached)	string	Max length: 200
Notes	Case Notes	string	Max length: 4000
Subject	Case Subject line	string	Max length: 100
ClassificationCode	Classification Code	string	None.
AutoClose	Enqueue and close the case (for statistics). Default false	boolean	None.
CustomProperties	Collection of all custom properties for this case process	Dictionary of string [key] and string [value]	None.
ProcedureExtRef		string	None.
ProcedureOptionExtRef		string	None.

Response Formats

application/json, text/json

Sample:

{
  "CaseId": 1,
  "ServiceId": 2,
  "ServiceIdExtRef": "sample string 3",
  "CustomerId": 4,
  "ExtRef": "sample string 5",
  "Notes": "sample string 6",
  "Subject": "sample string 7",
  "ClassificationCode": "sample string 8",
  "AutoClose": true,
  "CustomProperties": {
    "sample string 1": "sample string 2",
    "sample string 3": "sample string 4"
  },
  "ProcedureExtRef": "sample string 10",
  "ProcedureOptionExtRef": "sample string 11"
}