CustomerType

This lookup value is used for Customer Types.

Supported API Calls: List | Add | Update | Delete

Object Properties

Annual shares all properties with its base LookupValue object.

List

Description

Returns a list of Customer Types lookup values.

URL

https://{company}.bluecamroo.com/api/CustomerType/list

HTTP Method

GET

Data Return

Returns a list of existing CustomerType 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 CustomerType object lookup value to the list of Customer Types.

URL

https://{company}.bluecamroo.com/api/CustomerType/add

HTTP Method

POST

Parameters

A CustomerType object

Data Return

Returns the CustomerType 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 CustomerType object to replace the specified Customer Types lookup value.

URL

https://{company}.bluecamroo.com/api/CustomerType/update

HTTP Method

PUT

Parameters

A CustomerType object

Data Return

Returns the CustomerType 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 Customer Types lookup value. The Customer Types lookup value to delete is specified by Id value.

URL

https://{company}.bluecamroo.com/api/CustomerType/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)