LocationResource
The following resources are applicable:
/locations
Mount Point: /../../../api/v1/locations
GET
Returns a location list according to search parameters.
STATUS CODES :
200 - OK
Parameters
| name | description | type | default |
|---|---|---|---|
| modifiedSince | timestamp in millisecond after which a modification occurred | query | |
| count | the maximum number of locations to be returned | query | |
| startIndex | the start index of the list | query | |
| name | location name criteria | query | |
| latitude | nearby search latitude in decimal format (must also provide longitude and distance) | query | |
| longitude | nearby search longitude in decimal format (must also provide latitude and distance) | query | |
| distance | nearby search distance in km | query |
Response Body
| element: | locationListResponse |
| media types: | application/xml application/json |
a location list according to search parameters
POST
Create a location
STATUS CODES :
200 - The location was created
400 - There was errors processing the request, the body will contain a message
Request Body
| element: | location |
| media types: | application/xml application/json |
location data
Response Body
| element: | locationResponse |
| media types: | application/xml application/json |
the created location or a message if the status is not 200
/locations/{locationId}
Mount Point: /../../../api/v1/locations/{locationId}
GET
Gets detailed location by sowprog id
STATUS CODES :
200 - The location is returned
404 - The id does not exist
Parameters
| name | description | type | default |
|---|---|---|---|
| locationId | sowprog location id | path |
Response Body
| element: | locationResponse |
| media types: | application/xml application/json |
the detailed location
PUT
Update a location.
Only fields that are provided are updated. If a field with an empty value is provided, checks are enforced.
Example : if name is not provided, it will not be updated. If it is provided as an empty value, you will get an error message saying it is mandatory.
STATUS CODES :
200 - The location was updated
404 - The id does not exist
400 - There was errors processing the request, the body will contain a message
Parameters
| name | description | type | default |
|---|---|---|---|
| locationId | sowprog location id | path |
Request Body
| element: | location |
| media types: | application/xml application/json |
location data
Response Body
| element: | locationResponse |
| media types: | application/xml application/json |
the created location or a message if the status is not 200
/locations/{locationId}/banner
Mount Point: /../../../api/v1/locations/{locationId}/banner
PUT
Defines location associated banner.
The form must be encoded as a multipart/form-data and the data parameter key must be "file"
STATUS CODES :
200 - The location is returned
404 - The id does not exist
400 - error processing the file, the body will contain a message
Parameters
| name | description | type | default |
|---|---|---|---|
| locationId | sowprog location id | path | |
| fileInputStream | (no documentation provided) | formdata | |
| contentDispositionHeader | (no documentation provided) | formdata |
Response Body
| element: | locationResponse |
| media types: | application/xml application/json |
the updated location
/locations/{locationId}/picture
Mount Point: /../../../api/v1/locations/{locationId}/picture
PUT
Defines location associated image.
The form must be encoded as a multipart/form-data and the data parameter key must be "file"
STATUS CODES :
200 - The location is returned
404 - The id does not exist
400 - error processing the file, the body will contain a message
Parameters
| name | description | type | default |
|---|---|---|---|
| locationId | sowprog location id | path | |
| fileInputStream | (no documentation provided) | formdata | |
| contentDispositionHeader | (no documentation provided) | formdata |
Response Body
| element: | locationResponse |
| media types: | application/xml application/json |
the updated location