Place API
Errors
The Place API returns the following error codes and messages.
| Error code | HTTP status code | API endpoint / resource | HTTP status message | Desription |
|---|---|---|---|---|
| 401-86 | 401 | /places /places/{id} /places/{id}/siteinformation | Unauthorized | Indicates that authentication credentials haven't been provided in the request header or the credentials provided are incorrect. Check if the correct authentication credentials are in the header and try again. |
| 429-89 | 429 | /places /places/{id} /places/{id}/siteinformation | Too many requests | Occurs when a request is blocked due to rate limit restrictions. Try reducing the number of requests you're making. Learn more about API rate limits |
| FCL-400-6 | 400 | /places | Bad request | Indicates an invalid street number has been supplied in a search. Valid street number formats are a number range, full numeric street number, or full alphanumeric street number. For example, 24-28, 29A, 1/25, or 1/A 23-27. |
| FCL-400-8 | 400 | /places | Bad request | Occurs when a search parameter has not been supplied for an address search. If searching for an address, provide at least a street name or one of the following: PLSAM ID, TUI ID, Product ID, or ONT Serial Number. |
| FCL-400-13 | 400 | /places | Bad request | Occurs when mixed search criteria is supplied for the street address. Try again using a street name and either a number range, full numeric street number, or full alphanumeric street number. For example, 24-28, 29A, 1/25, 1A/25, or 1/A 23-27. |
| FCL-400-22 | 400 | /places | Bad request | Occurs when a search query has too many conflicting query parameters. Use either address based parameter streetName or one of the following key-based parameters: PLSAM ID, TUI ID, Product ID or ONT Serial Number. |
| FCL-401-84 | 401 | /places /places/{id} /places/{id}/siteinformation | Unauthorized | Occurs when an organisation name can't be found for authentication purposes. Check your organisation credentials are correct and try again. If the problem persists, contact your Chorus representative. |
| FCL-400-85 | 400 | /places /places/{id} /places/{id}/siteinformation | Bad request | Occurs when there is an issue with the syntax, message or header of a request. Check the syntax and formatting of the request and ensure all required parameters are included. |
| FCL-400-90 | 400 | /places | Bad request | Occurs when there is no street address or key-based query parameter supplied for a search. Provide either a streetName, tuiId, samId, productId or ontSerialNumber and try again. |
| FCL-404-0 | 404 | /places /places/{id} /places/{id}/siteinformation | Not found | Occurs when a resource cannot be found. Check if you have supplied the correct resource and try again. |
| FCL-404-1 | 404 | /places /places/{id} /places/{id}/siteinformation | Not found | Occurs when the Place ID supplied in a search could not be found. Check if you have the correct place ID and try entering again. |
| FCL-405-0 | 405 | /places /places/{id} /places/{id}/siteinformation | Method not allowed | Indicates that the requested method is not supported for the resource. Choose another method and try again. |
| FCL-406-0 | 406 | /places /places/{id} /places/{id}/siteinformation | Not acceptable | Occurs when a request doesn’t list acceptable response content types that can be returned. Check you have listed acceptable content types and try again. |
| FCL-415-0 | 415 | /places /places/{id} /places/{id}/siteinformation | Unsupported | Indicates that a request doesn’t contain a content type that is recognised. Try again using a recognisable content type. |
| FCL-500-0 | 500 | /places /places/{id} /places/{id}/siteinformation | Internal server error | Occurs when a Chorus internal server error has occurred. Try again and if the problem persists, contact your Chorus representative. |
| FCL-501-0 | 501 | /places /places/{id} /places/{id}/siteinformation | Not implemented | Indicates that the requested resource hasn't been implemented yet. For more information, contact your Chorus representative. |