GET  /locations

• This method allows a list of locations to be obtained.

• To obtain detailed information about a specified location: GET /locations/{location_id}  -   method View a location

Notes

        see  REST API Conventions

• If successful, an HTTP status code 200 is returned.
  • By default, if the optional parameter fields is not used, only an extract of the most useful fields selected by  is displayed for each record provided.
  • A URL link (HREF) to each resource is provided so that the complete list of fields for a record can be obtained if required.

List of parameters / objects

Mandatory parameters

None

Optional parameters

You can use the parameters detailed below in the HTTP request string.

Objet	Type	Description / Example
max_rows	integer	Maximum number of records to display. Default value: 100 /locations?max_rows=5
sort	string	Sort in ascending or descending order. Syntax: field1[+asc|+desc],field2[+asc|+desc],fieldn[+asc|+desc] /locations?sort=location_fr+desc
fields	string	SSelect fields to display. /locations?fields=location_en,g_map_lat,g_map_lng
search	string	Search/filter the specified fields.   See Description of the options. /locations?search=level:"3" A search on a Date field is also possible. /locations?search=last_integration:this_month
~ (equivalent to like)	string	Include the results which begin with or contain a given character string. Syntax: ~ following by the string to include enclosed in quotation marks. You should use the wildcard character *. < string >* = include what begins with < string >. *< string >* = include what contains < string >. /locations?search=location_en~"Bos*" ==> all locations in which the location_en field begins with Bos /locations?search=location_en~"*Bos*" ==> all locations in which the location_en field contains Bos
!~ (equivalent to not like)	string	Exclude the results which begin with or contain a given character string. Syntax: !~ following by the string to exclude enclosed in quotation marks. You should use the wildcard character *. < string >* = exclude what begins with < string >. *< string >* = exclude what contains < string >. /locations?search=location_en!~"Bos*" ==> all locations by excluding those in which the location_en field begins with Bos /locations?search=location_en!~"*Bos*" ==> all locations by excluding those in which the location_en field contains Bos
! (equivalent to not)	string	Exclude all results equal to a given character string. Syntax: ! following by the string to exclude enclosed in quotation marks. /locations?search=location_en!"Boston" ==> all locations by excluding those in which the location_en field is equal to Boston
formatDate	string	Specification of the date.   See Description of the options /locations?formatDate=l/M/Y ==> Friday/Nov/2018 /locations?formatDate=l jS \of F Y h:i:s A ==> Friday 16th of November 2018 12:00:00 AM

Fields that could be used in optional parameters

You can use all the JSON fields from the AM_LOCATION table except those mentioned below.

NotAuthorized_OptionalParametersFields_Location

HTTP status codes for the method

StatusHeader

Status200

Status401

401	Unauthorized	Authentication process for accessing the resource is incorrect: Login/Password incorrect, Invalid session, Incorrect account.
	{  "error": "Invalid Login / Password" }

Example

Result for 3 locations (status code 200)

ConventionsAPI

REST API Conventions

Convention	Meaning
Orange	Parameters used in an HTTP request string (URL) which do not correspond to database fields.
	Method View a list of assets https://{your_server}/api/v1/{your_account}/assets?max_rows=3&fields=asset_tag
Black and Bold	Parameters used in the URL of an HTTP request which correspond to database fields.
	Method View an asset https://{your_server}/api/v1/{your_account}/assets/{asset_id}
Green	Parameters used in the body of an HTTP request which represent JSON object names corresponding to database fields; they allow the value of a database field to be assigned or modified.
	Method Close an incident/request {  "closed": {  "end_date": "11/20/2016 12:12:12",  }  }
	Parameters used in the body of an HTTP request which represent JSON object names not corresponding to database fields.
	Method Reopen an incident/request {  "restarted": {  "comment": "string (required)"  }  }