- Welcome to the EasyVista Wiki
- Integrations
- Web Services REST
- REST API - View a list of locations
REST API - View a list of locations
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
- 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.
- By default, if the optional parameter fields is not used, only an extract of the most useful fields selected by
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.
|
sort | string | Sort in ascending or descending order.
|
fields | string | SSelect fields to display.
|
search | string | Search/filter the specified fields. ![]()
A search on a Date field is also possible.
|
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
- label_color ; label_font ; label_size
- property_color ; property_font ; property_size
- date_format_id
- xpos ; ypos ; zpos
- lft ; rgt
- path_to_compute
HTTP status codes for the method
StatusHeader
Code | Error | Description |
---|
Status200
200 | OK (Success) | Request processed successfully. |
Status401
401 | Unauthorized | Authentication process for accessing the resource is incorrect: Login/Password incorrect, Invalid session, Incorrect ![]() |
![]() { "error": "Invalid Login / Password" } |
Example
Result for 3 locations (status code 200)
"record_count": "3",
"total_record_count": "805",
"records": [
{
"HREF": "https://{your_server}/api/v1/{your_account}/locations/63",
"CITY": "",
"LOCATION_CODE": "",
"LOCATION_FR": "France",
"LOCATION_PATH": "Europe/France",
"LOCATION_ID": "63"
},
{
"HREF": "https://{your_server}/api/v1/{your_account}/locations/65",
"CITY": "Nice",
"LOCATION_CODE": "",
"LOCATION_FR": "Nice",
"LOCATION_PATH": "Europe/France/Nice",
"LOCATION_ID": "65"
},
{
"HREF": "https://{your_server}/api/v1/{your_account}/locations/66",
"CITY": "Paris",
"LOCATION_CODE": "",
"LOCATION_FR": "Paris",
"LOCATION_PATH": "Europe/France/Paris",
"LOCATION_ID": "66"
}
]
ConventionsAPI
REST API Conventions
Convention | Meaning |
---|---|
Orange | Parameters used in an HTTP request string (URL) which do not correspond to ![]() |
![]() 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 ![]() |
Green | Parameters used in the body of an HTTP request which represent JSON object names corresponding to ![]() |
Parameters used in the body of an HTTP request which represent JSON object names not corresponding to ![]() |
|