|
RelationshipType
This lookup value is used for relationship types.
Supported API Calls: List | Add | Update | Delete
Object Properties
Annual shares all properties with its base LookupValue object. Plus the following unique flags:
|
Property |
Type |
Description |
|
ReciprocalRelation |
integer |
ID of the relationship lookup value that should be reciprocally set. |
|
IsPersonal |
boolean |
Flag to indicate the relationship is a personal relationship. |
List
Description
Returns a list of Relationship types lookup values.
URL
https://{company}.bluecamroo.com/api/RelationshipType/list
HTTP Method
GET
Data Return
Returns a list of existing RelationshipType 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 RelationshipType object lookup value to the list of Relationship types.
URL
https://{company}.bluecamroo.com/api/RelationshipType/add
HTTP Method
POST
Parameters
A RelationshipType object
Data Return
Returns the RelationshipType 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
Pass a RelationshipType object to replace the specified Relationship types lookup value.
URL
https://{company}.bluecamroo.com/api/RelationshipType/update
HTTP Method
PUT
Parameters
A RelationshipType object
Data Return
Returns the RelationshipType 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 Relationship types lookup value. The Relationship types lookup value to delete is specified by Id value.
URL
https://{company}.bluecamroo.com/api/RelationshipType/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)
Add
Description
Adds the SupplierStatus object lookup value to the list of Supplier Statuses.
URL
https://{company}.bluecamroo.com/api/SupplierStatus/add
HTTP Method
POST
Parameters
A SupplierStatus object
Data Return
Returns the SupplierStatus 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
Pass a SupplierStatus object to replace the specified Supplier Statuses lookup value.
URL
https://{company}.bluecamroo.com/api/SupplierStatus/update
HTTP Method
PUT
Parameters
A SupplierStatus object
Data Return
Returns the SupplierStatus 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 Supplier Statuses lookup value. The Supplier Statuses lookup value to delete is specified by Id value.
URL
https://{company}.bluecamroo.com/api/SupplierStatus/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)
|