GET /carriers/search

Searches the database for carriers matching the given request parameters.

Roles that can access this endpoint are Users.

Parameters

name description type default type

request

name	description	type	default	type
request	read for query parameters to be used as search criteria; use any combination of fields from tables: `carrier` - use `carrier` , `payee` or no prefix `drs_payee` - use `drsPayee`, `drs_payee` prefix For example, `/carriers/search?carrier.state=AL&drsPayee.type_of=R` would find carrier payees in the state of Alabama. Sorting: To sort the result set, you can provide the following reserved query parameter: `orderBy` If the orderBy parameter is not provided a default sort of `payee.id+DESC` will be applied. For example, `/carriers/search?drsPayee.type_of=C&orderBy=payee.id+DESC` would return all carrier payee records sorted descending by the payee id. Multiple sort columns can be provided in a comma delimited format. `orderBy=prefix.field+direction,prefix.field+direction` Pagination: To page the result set, you can provide the following reserved query parameters: `recordLength and recordOffset` For example, `/carrier/search?drsPayee.type_of=C&recordLength=100&recordOffset=50` would return 100 records starting at the 51st record in the return record set. If no recordLength parameter is provided the search result maximum value in the mobile service control file will be applied. Changed After Date: To return only records that have been changed or added since a specific date and time, you can provide the `changedAfterDate` parameter. Dates are limited to the audit setting and days to keep value in the table properties configuration. For example, `/payees/search?drsPayee.type_of=R&changedAfterDate=t-1` would return carrier payees that have been added or updated since the beginning of the previous day. Change Types: To further define the types of changes you want to filter, use the `changedAfterType` parameter. This parameter is to be used in conjunction with `changedAfterDate` to give the ability to specify if you want added or updated records. Allowed values: [Add, Update]. Any other value will result in an exception. If the `ChangedAfterType` parameter is not provided, both added and updated records will be returned. If you do not provide a corresponding `ChangedAfterDate` the `ChangedAfterType` parameter will be ignored. For example, `/payees/search?drsPayee.type_of=R&changedAfterDate=t-1&changedAfterType=Add` would return carrier payees that have been added since the beginning of the previous day.	context		HttpServletRequest
includeQualifications	if the carrier is qualified at a generic level	query	false	Boolean

read for query parameters to be used as search criteria; use any combination of fields from tables:

carrier - use carrier , payee or no prefix
drs_payee - use drsPayee, drs_payee prefix

For example, /carriers/search?carrier.state=AL&drsPayee.type_of=R would find carrier payees in the state of Alabama.

Sorting: To sort the result set, you can provide the following reserved query parameter: orderBy If the orderBy parameter is not provided a default sort of payee.id+DESC will be applied.

For example, /carriers/search?drsPayee.type_of=C&orderBy=payee.id+DESC would return all carrier payee records sorted descending by the payee id. Multiple sort columns can be provided in a comma delimited format. orderBy=prefix.field+direction,prefix.field+direction

Pagination: To page the result set, you can provide the following reserved query parameters: recordLength and recordOffset

For example, /carrier/search?drsPayee.type_of=C&recordLength=100&recordOffset=50 would return 100 records starting at the 51st record in the return record set. If no recordLength parameter is provided the search result maximum value in the mobile service control file will be applied.

Changed After Date: To return only records that have been changed or added since a specific date and time, you can provide the changedAfterDate parameter. Dates are limited to the audit setting and days to keep value in the table properties configuration.

For example, /payees/search?drsPayee.type_of=R&changedAfterDate=t-1 would return carrier payees that have been added or updated since the beginning of the previous day.

Change Types: To further define the types of changes you want to filter, use the changedAfterType parameter. This parameter is to be used in conjunction with changedAfterDate to give the ability to specify if you want added or updated records.

Allowed values: [Add, Update]. Any other value will result in an exception. If the ChangedAfterType parameter is not provided, both added and updated records will be returned. If you do not provide a corresponding ChangedAfterDate the ChangedAfterType parameter will be ignored.

For example, /payees/search?drsPayee.type_of=R&changedAfterDate=t-1&changedAfterType=Add would return carrier payees that have been added since the beginning of the previous day.

context

HttpServletRequest

includeQualifications if the carrier is qualified at a generic level query false Boolean

Result

List < RowPayee > of type: application/xml application/json

a list of RowPayee objects

Additional attributes:

__statusDescr This value represents the description of the payee status, found in the payee.status field.
__safetyRatingDescr This value represents the description of the safety rating, found in the drs_payee.safety_rating field.
__brokerAuthStatusDescr This value represents the description of the broker authority status, found in the drs_payee.broker_auth_status field.
__commonAuthStatusDescr This value represents the description of the common authority status, found in the drs_payee.common_auth_status field.
__contractAuthStatusDescr This value represents the description of the contract authority status, found in the drs_payee.contract_auth_status field.

Child Elements:

RowDrsPayee This element represent the drs payee associated with the carrier. The element contains a __name attribute with the value drsPayee.

GET /carriers/search

Parameters

Result

Try It Out

Request

Response