UserSearchCriteria

An object that represents an advanced search in BlueCamroo.

Supported API Calls: Get | Add | Update | Delete

Object Properties

Property	Type	Description
UserId	Integer	ID of the user.
Name	String (100)	Name of the search.
ObjectName	String (100)	Object type to be searched for: account (if searching for an organization), person, lead, customer, supplier, opportunity, project, or case.
CustomSql	String (100)	public
isExternal	Boolean	True if the search is conducted by an external user.
isDefault	Boolean	True if the search is a saved search.
Display	Boolean	public
DisplayFieldList	List	A UserSearchCriteriaDisplayField list
CriteriaGroupList	List	If the search has multiple citeria groups, this list points to the multiple CriteriaGroup objects.

Get

Returns details for the specified search.

URL

https://{company}.bluecamroo.com/api/UserSearchCriteria/get/{id}?UsreID={UsreID}

HTTP Method

GET

Parameters

None

Data Return

Returns the UserSearchCriteria 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)

Add

Description

Adds a search.

URL

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

HTTP Method

POST

Parameters

An UserSearchCriteria object

Data Return

Returns the UserSearchCriteria 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

Updates a UserSearchCriteria object.

URL

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

HTTP Method

PUT

Parameters

An UserSearchCriteria object

Data Return

Returns the UserSearchCriteria 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 search.

URL

https://{company}.bluecamroo.com/api/UserSearchCriteria/delete/{id}?UsreID={UsreID}

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)