Get Emergency Locations
Get Emergency Locations retrieves a list of emergency locations for a specific customer. The request retrieves the list in a CSV file. See also Change Emergency Location.
URI
{{baseUrl}}/api/v3/customer/{customerGuid}/emergencylocationHTTP Method
GET
Request Headers
You can alternatively specify either of the following headers, both of which return identical output.
|
Attribute |
Type |
Description |
|---|---|---|
|
X-Ovoc-Channel-Id |
integer |
The Live Platform channel id. When specified, data is scoped to only customers belonging to the specified channel. See Get List of Channels to extract this value. |
|
X-IAM-Account-Id |
string |
The Live Platform iamAccountId of the channel. When specified, data is scoped to only customers belonging to the specified channel. See Get List of Channels to extract this value. |
Request Parameter
|
Parameter |
Type |
Description |
|---|---|---|
|
customerGuid |
string($uuid) (path) |
Unique customer 'Id' created when service is added. Extract this value from Get Services Brief Details (V3) request. |
HTTP Responses
| ■ | 200 Success |
| ■ | 400 Bad Request |
|
Parameter |
Type |
Description/Examples |
|---|---|---|
|
errors |
string |
Text description of the error. |
|
type |
string |
"https://tools.ietf.org/html/rfc7231#section-6.5.1" |
|
title |
string |
Email title. For example "One or more validation errors occurred." |
|
status |
error code |
HTML error code i.e. 400 |
|
detail |
string |
Additional error details. |
|
traceId |
string |
Error trace Id |
|
instance |
string |
Error instance |
|
errorTicket |
string |
This field may not appear for all return codes. |
|
errorCode |
string |
This field may not appear for all return codes. |
|
additionalProp1 |
string |
Custom Script variable argument. For example "CacProfile": "5 sessions" |
|
additionalProp2 |
string |
Custom Script argument. For example, ProxySet": "SIPTrunk" |
|
additionalProp3 |
string |
Custom Script argument. For example, "OnlinePstnGateway": "sandbox1.audiocodes.be" |
| ■ | 403 Forbidden: This error is raised when the customerGuid specified Request parameter is not associated with the channel specified in the Header request. |
|
Parameter |
Type |
Description/Examples |
|---|---|---|
|
errors |
string |
Text description of the error. |
|
type |
string |
"https://tools.ietf.org/html/rfc7231#section-6.5.1" |
|
title |
string |
Email title. For example "One or more validation errors occurred." |
|
status |
error code |
HTML error code i.e. 400 |
|
detail |
string |
Additional error details. |
|
traceId |
string |
Error trace Id |
|
instance |
string |
Error instance |
|
errorTicket |
string |
This field may not appear for all return codes. |
|
errorCode |
string |
This field may not appear for all return codes. |
|
additionalProp1 |
string |
Custom Script variable argument. For example "CacProfile": "5 sessions" |
|
additionalProp2 |
string |
Custom Script argument. For example, ProxySet": "SIPTrunk" |
|
additionalProp3 |
string |
Custom Script argument. For example, "OnlinePstnGateway": "sandbox1.audiocodes.be" |
| ■ | 404 Not Found |
|
Parameter |
Type |
Description/Examples |
|---|---|---|
|
errors |
string |
Text description of the error. |
|
type |
string |
"https://tools.ietf.org/html/rfc7231#section-6.5.1" |
|
title |
string |
Email title. For example "One or more validation errors occurred." |
|
status |
error code |
HTML error code i.e. 400 |
|
detail |
string |
Additional error details. |
|
traceId |
string |
Error trace Id |
|
instance |
string |
Error instance |
|
errorTicket |
string |
This field may not appear for all return codes. |
|
errorCode |
string |
This field may not appear for all return codes. |
|
additionalProp1 |
string |
Custom Script variable argument. For example "CacProfile": "5 sessions" |
|
additionalProp2 |
string |
Custom Script argument. For example, ProxySet": "SIPTrunk" |
|
additionalProp3 |
string |
Custom Script argument. For example, "OnlinePstnGateway": "sandbox1.audiocodes.be" |
| ■ | 500 Server Error |