|
Resource
An object representing setup's event resources.
Supported API Calls: Get | Add | Update | Delete
Object Properties
|
Property |
Type |
Description |
|
Id |
integer |
The resource's ID. When adding a new item the value must be 0. |
|
Name |
string (100) |
Name of the resource. |
|
|
string (100) |
Email for notifications. |
|
Description |
string (100) |
Description field. |
|
SortOrder |
integer |
Sorting order of the resources. This can be null. |
Get
Description
Returns the details of a specified Resource.
URL
https://{company}.bluecamroo.com/api/Resource/get/{id}
HTTP Method
GET
Parameters
None
Data Return
Returns an Resource object 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 an Resource object.
URL
https://{company}.bluecamroo.com/api/Resource/add
HTTP Method
POST
Parameters
An Resource object
Data Return
Returns the Resource object 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
Updates the specified Resource.
URL
https://{company}.bluecamroo.com/api/Resource/update
HTTP Method
PUT
Parameters
An Resource object
Data Return
Returns the Resource object 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 Resource.
URL
https://{company}.bluecamroo.com/api/Resource/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)
|