|
Sector
Sector is a property of the Industry object. It represents a Sector lookup value.
Supported API Calls: List | Add | Update | Delete
Object Properties
Sector shares all properties with its base LookupValue object.
List
Description
Returns a list of sector lookup values associated with the parent industry.
URL
https://{company}.bluecamroo.com/api/sector/list?industryId={industryId}
HTTP Method
GET
Parameters
None
Data Return
Returns a list of existing sector objects in the requested format (eg 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 passed sector.
URL
https://{company}.bluecamroo.com/api/sector/add
HTTP Method
POST
Parameters
Sector object
Data Return
Returns the sector in the requested format (eg 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 sector object to replace the specified sector.
URL
https://{company}.bluecamroo.com/api/sector/update
HTTP Method
Put
Parameters
Sector object
Data Return
Returns the sector in the requested format (eg 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 sector. Sector to delete is specified by Id value.
URL
https://{company}.bluecamroo.com/api/sector/delete
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)
|