GET private-locations
Retrieves a list of private locations for the current customer.
Request example
curl --request GET "https://api-asm1.apica.io/v3/private-locations?auth_ticket=C471ADC4-19B4-4219-BBF4-671A97EC653E"
Response body model example and description
[
{
"access_group": "6510e4cf-be3d-4e0c-ae67-a3d85a46a902",
"private_locations": [
{
"private_location_id": "b0802e30-b6ec-46c5-9a08-19bb0ef26f84",
"enabled": true,
"geoloc": "sample string 3",
"customer_guid": "0ef6a61d-51ea-42a5-9c3b-3f2b6513bc71"
},
{
"private_location_id": "01f2d6bc-f849-4fd6-aeea-97efeda8c480",
"enabled": true,
"geoloc": "sample string 3",
"customer_guid": "ee9283c8-5b2e-47c9-a01b-7460cad7ddd7"
},
{
"private_location_id": "422618ff-2e51-4507-9d1d-f3058285d6a2",
"enabled": true,
"geoloc": "sample string 3",
"customer_guid": "a3e2b6d6-5314-4e9d-8751-6f6da59bc7d8"
}
]
},
{
"access_group": "31fea493-54a1-474c-b930-c59b8038dba3",
"private_locations": [
{
"private_location_id": "b0802e30-b6ec-46c5-9a08-19bb0ef26f84",
"enabled": true,
"geoloc": "sample string 3",
"customer_guid": "0ef6a61d-51ea-42a5-9c3b-3f2b6513bc71"
},
{
"private_location_id": "01f2d6bc-f849-4fd6-aeea-97efeda8c480",
"enabled": true,
"geoloc": "sample string 3",
"customer_guid": "ee9283c8-5b2e-47c9-a01b-7460cad7ddd7"
},
{
"private_location_id": "422618ff-2e51-4507-9d1d-f3058285d6a2",
"enabled": true,
"geoloc": "sample string 3",
"customer_guid": "a3e2b6d6-5314-4e9d-8751-6f6da59bc7d8"
}
]
},
{
"access_group": "137dec86-fb4d-49a4-8ed6-10f70e2a18e7",
"private_locations": [
{
"private_location_id": "b0802e30-b6ec-46c5-9a08-19bb0ef26f84",
"enabled": true,
"geoloc": "sample string 3",
"customer_guid": "0ef6a61d-51ea-42a5-9c3b-3f2b6513bc71"
},
{
"private_location_id": "422618ff-2e51-4507-9d1d-f3058285d6a2",
"enabled": true,
"geoloc": "sample string 3",
"customer_guid": "a3e2b6d6-5314-4e9d-8751-6f6da59bc7d8"
},
{
"private_location_id": "422618ff-2e51-4507-9d1d-f3058285d6a2",
"enabled": true,
"geoloc": "sample string 3",
"customer_guid": "a3e2b6d6-5314-4e9d-8751-6f6da59bc7d8"
}
]
}
]
| Name | Type | Description |
|---|---|---|
| AccessGroup | Guid |
Unique identifier for the access group associated with the private locations. |
| PrivateLocations | Object |
A list of private location details. |
| PrivateLocationId | Guid |
Unique identifier for the private location. |
| Enabled | Boolean |
Indicates whether the private location is enabled. |
| Geoloc | String |
Geographical location of the private location. |
| CustomerGuid | Guid |
Customer identifier associated with the private location. |