The Locations API allows the user to retrieve all information about locations setup within the Ascentis HR company.
Resource URL| Example Request | |
| GET | https://serverurl/api/v1.1/location/5 |
| Return Value |
| Http header "Accept" value -- "text/xml" or "application/xml" will return XML, otherwise JSON will be returned. |
| XML | <companyLocations xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" |
| JSON |
{ "locations": [ { "id": 3, "name": "Dallas", "locationNumber": "01", "address1": "8524 Marginal Way", "address2": "", "city": "Dallas", "state": "TX", "zip": "75277-8745", "country": "USA", "fax": "(214) 524-7855", "notes": "", "phone": "(214) 524-7850", "active": "Active" }, { "id": 4, "name": "Seattle", "locationNumber": "02", "address1": "1100 Broadway Ave, Suite 200", "address2": "", "city": "Seattle", "state": "WA", "zip": "98104-4833", "country": "USA", "fax": "(206) 825-2111", "notes": "", "phone": "(206) 825-2100", "active": "Active" } ] } |
| |
| Resource Information | |
| Requires Authentication? | Yes |
| Response Formats | json xml |
| HTTP Methods | GET |
| Request Content | N/A |
| Return Code | 200: Response Completed 403: Incorrect Authorization 400: Bad Data 404: Location does not exist |
| API Version | v1.1 only |