|
PhoneType
This lookup value is used for records that require a phone number.
Supported API Calls: List | Add | Update | Delete
Object Properties
Shares all properties with its base LookupValue object. Plus the following unique flags:
|
Property |
Type |
Description |
|
IsAccount |
boolean |
Indicates if the Phone Type is selectable in an organization. |
|
IsContact |
boolean |
Indicates if the Phone Type is selectable in a contact. |
|
IsPerson |
boolean |
Indicates if the Phone Type is selectable in a person record. |
|
IsFax |
boolean |
Indicates if the Phone Type is a fax number. |
List</h1>
Description
Returns a list of Phone Types lookup values.
URL
https://{company}.bluecamroo.com/api/PhoneType/list
HTTP Method
GET
Data Return
Returns a list of existing PhoneType 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 PhoneType object lookup value to the list of Phone Types.
URL
https://{company}.bluecamroo.com/api/PhoneType/add
HTTP Method
POST
Parameters
A PhoneType object
Data Return
Returns the PhoneType 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 PhoneType object to replace the specified Phone Types lookup value.
URL
https://{company}.bluecamroo.com/api/PhoneType/update
HTTP Method
PUT
Parameters
A PhoneType object
Data Return
Returns the PhoneType 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 Phone Types lookup value. The Phone Types lookup value to delete is specified by Id value.
URL
https://{company}.bluecamroo.com/api/PhoneType/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 ProductCategory object lookup value to the list of Product Categories.
URL
https://{company}.bluecamroo.com/api/ProductCategory/add
HTTP Method
POST
Parameters
A ProductCategory object
Data Return
Returns the ProductCategory 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 ProductCategory object to replace the specified Product Categories lookup value.
URL
https://{company}.bluecamroo.com/api/ProductCategory/update
HTTP Method
PUT
Parameters
A ProductCategory object
Data Return
Returns the ProductCategory 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 Product Categories lookup value. The Product Categories lookup value to delete is specified by Id value.
URL
https://{company}.bluecamroo.com/api/ProductCategory/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)
|