v1

latestOpenAPI 3.0.02026-07-263403911.5 MB
ServiceTypes

Search service types

Search for one or more service types.

get/v1/ServiceTypes

Query parameters

search.service_type_idinteger[]

Query by service type identifier.

search.service_codestring[]

Query by service type code

search.descriptionstring[]

Query by all or part of description.

search.activeboolean

Return when Null: All; when True: Only Active; when False: Only Inactive.

search.page_sizeinteger

Format - int32. Defines how many items to return at a time.

search.pageinteger

Format - int32. Specifies which page to display (i.e. 3rd page of 50 items out of 1000 items)

search.sortstring

Specifies the model member you wish to sort by. Defaults to Ascending order, add a "-" sign to the beginning to indicate Descending order.

Response

OK

okboolean
has_moreboolean

Helper for pagination. Indicates there are more records returned.

record_countinteger

Total number of records found by the search.