Versions Compared

Old Version 2

changes.mady.by.user Andrew Hill

Saved on

compared with

New Version Current

changes.mady.by.user Jason Andrew

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Status
colourGreen
title3.20.0

The ServiceAreas query API returns a collection of service area objects based on the filter criteria passed in on the GET request. 

Note

The result set is filtered based on the security level of the user executing the query.



Panel
borderColorgrey
bgColorwhitesmoke

Related pages:

 



Resource URL

Panel
borderColorgrey
bgColorwhitesmoke
borderStylesolid

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

Query Parameters

Include Page
_URI Default Query Parameters
_URI Default Query Parameters

Filters

The ${filterOptions} parameter supports the following REST Object Definitions Account Location Related Objects Service Area Query Object fields:

  • Name
  • PriceListID
  • ServiceAreaID
  • TimeZone

Q

The ${queryOptions} supports the following REST Object Definitions Account Location Related Objects Service Area Query Object fields:

  • Name
  • PriceListID
  • ServiceAreaID
  • TimeZone

Sort

The ${sortOptions} supports the following REST Object Definitions Account Location Related Objects Service Area Query Object fields:

  • Name
  • PriceListID
  • ServiceAreaID
  • TimeZone

Include Page
_Default HTTP Headers
_Default HTTP Headers

HTTP Response Body

The response body contains a collection of REST Object Definitions Account Location Related Objects Service Area Query Object objects that match the query parameters. 

Include Page
Query Response Object
Query Response Object