ServiceAreas Query API

Resource URL

GET /seiapi/v3/query/ServiceAreas?filters=${filterOptions}&q={queryOtions}&sort=${sortOptions}&limit=${limit}

Query Parameters

Parameter Description

filters

Filter expression consists of multiple comparison operations related to each other by logical operators - Logical AND (; or and) and Logical OR (, or or). Each comparison operation has three parts:
comparison = selector, comparison-op, arguments;

selector = Identified the field name of the object to filter against
comparison-op = Currently supported comparison operators are listed in "Operators" table below
arguments = Identifies the value(s) to be matched against the field. Multiple values are represented in parenthesis separated by comma

The filter parameter is used to quickly reduce the result set based on the field values provided. Although the filter is case-insensitive it does preform an exact match.

Example:

filter=WorkCenter==EastCoast

This will return all objects where the WorkCenter field has a value of EastCoast

Supported operators are shown below in a table.

Operators	Description
"=="	Equals
"=ne=" or "!="	Not equals
"=gt=“ or “>"	greater than
"=ge=" or “>="	greater than or equals to
"=lt=“ or “<"	less than
"=le=" or “<="	less than or equals to
“=in="	In
“=out="	Not in
";” or “and"	Logical AND
",” or “or"	Logical OR

limit

Identifies the maximum number of objects to be returned.

q

The q parameter syntax is:

q=<search term>::in:field-1,field-2

The q (query) parameter supports partial term matches across multiple fields. For example, a search_term of Joh will match John, John's, Johansson, Johansen.

The query parameter currently supports one search term, although it can be combined with the filter parameter.

sort

Identifies the field name that should be used for sorting.

The sort syntax is:

sort=[-]field-1,[-]field-2

field-1 = The field name to sort against
[ - ] = Optional value that identifies the field is to be sorted in descending order

start Identifies the number of objects to be skipped. This is used for pagination and allows skipping previously returned objects.

Filters

The ${filterOptions} parameter supports the following Service Area Query Object fields:

Name
PriceListID
ServiceAreaID
TimeZone

Q

The ${queryOptions} supports the following Service Area Query Object fields:

Name
PriceListID
ServiceAreaID
TimeZone

Sort

The ${sortOptions} supports the following Service Area Query Object fields:

Name
PriceListID
ServiceAreaID
TimeZone

HTTP Headers
This API uses the default ServiceMobility HTTP Headers.

HTTP Response Body

The response body contains a collection of Service Area Query Object objects that match the query parameters.

JSON Format

 {
    "TotalRecords" : 0,
    "Items" : [
		{
			// object definition 
		}
    ]
}