|
CaseStatus
CaseStatus is a property of the Case object. It represents a Case Status lookup value.
Supported API Calls: List | Add | Update | Delete
Object Properties
CaseStatus shares all properties with its base LookupValue object. Plus the following unique flags:
|
Property |
Type |
Description |
|
IsClosed |
boolean |
Indicates if the case status represents a closed condition. |
|
IsEscalated |
boolean |
Indicates if the case status represents an escalated condition. |
List
Description
Returns a list of Case Status lookup values.
URL
https://{company}.bluecamroo.com/api/casestatus/list
HTTP Method
GET
Data Return
Returns a list of existing casestatus objects in the requested format (e.g., JSON or XML)
HTTP Return Status Code
200: Ok
400: Bad Request (One or more input data items is not valid, for example a mandatory field is blank)
401: Not authorized (you need to log in)
403: Forbidden (you don't have permission to this resource)
Add
Description
Adds the casestatus object to the list of Case Status lookup values.
URL
https://{company}.bluecamroo.com/api/casestatus/add
HTTP Method
POST
Parameters
Casestatus object
Data Return
Returns the casestatus in the requested format (e.g., JSON or XML)
HTTP Return Status Code
201: Created
401: Not authorized (you need to log in)
403: Forbidden (you don't have permission to this resource)
Update
Description
Pass a case status object to replace the specified case status.
URL
https://{company}.bluecamroo.com/api/casestatus/update
HTTP Method
PUT
Parameters
Casestatus object
Data Return
Returns the casestatus in the requested format (e.g., JSON or XML)
HTTP Return Status Code
200: Ok
400: Bad Request (One or more input data items is not valid, for example a mandatory field is blank)
401: Not authorized (you need to log in)
403: Forbidden (you don't have permission to this resource)
Delete
Description
Deletes the specified Case Status. The Case Status to delete is specified by Id value.
URL
https://{company}.bluecamroo.com/api/casestatus/delete/{id}
HTTP Method
DELETE
Parameters
None
Data Return
None
HTTP Return Status Code
200: Ok
400: Bad Request (One or more input data items is not valid, for example a mandatory field is blank)
401: Not authorized (you need to log in)
403: Forbidden (you don't have permission to this resource)
|