List

Description

Returns a list of title (mr., mrs., etc.) lookup values.

URL

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

HTTP Method

GET

Data Return

Returns a list of existing salutation 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 salutation object to the list of salutation lookup values.

URL

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

HTTP Method

POST

Parameters

Salutation object

Data Return

Returns the salutation 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 salutation object to replace the specified salutation.

URL

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

HTTP Method

PUT

Parameters

Salutation object

Data Return

Returns the salutation 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 salutation. Salutation to delete is specified by Id value.

URL

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