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": "0a5925be-3977-450c-a684-0b77ee3c6087",
    "private_locations": [
      {
        "private_location_id": "e6f3a65d-5d14-4db8-a6b0-8b65fcf83ea9",
        "enabled": true,
        "geoloc": "sample string 3",
        "customer_guid": "1d397f19-ea6b-4db7-a39f-90e2a2c561ba"
      },
      {
        "private_location_id": "2e7e2336-5be5-4297-85f8-62688582f4c1",
        "enabled": true,
        "geoloc": "sample string 3",
        "customer_guid": "e7fda08f-d02b-4c9e-8c1a-35d271129ced"
      },
      {
        "private_location_id": "8605417b-862d-409f-bc00-0e368ddf504c",
        "enabled": true,
        "geoloc": "sample string 3",
        "customer_guid": "ab648cc6-fc7f-4a45-9977-e4708fc1615a"
      }
    ]
  },
  {
    "access_group": "ca59bfe4-31fd-4e21-afad-73727005f779",
    "private_locations": [
      {
        "private_location_id": "8605417b-862d-409f-bc00-0e368ddf504c",
        "enabled": true,
        "geoloc": "sample string 3",
        "customer_guid": "ab648cc6-fc7f-4a45-9977-e4708fc1615a"
      },
      {
        "private_location_id": "8605417b-862d-409f-bc00-0e368ddf504c",
        "enabled": true,
        "geoloc": "sample string 3",
        "customer_guid": "ab648cc6-fc7f-4a45-9977-e4708fc1615a"
      },
      {
        "private_location_id": "e6f3a65d-5d14-4db8-a6b0-8b65fcf83ea9",
        "enabled": true,
        "geoloc": "sample string 3",
        "customer_guid": "1d397f19-ea6b-4db7-a39f-90e2a2c561ba"
      }
    ]
  },
  {
    "access_group": "4a431ab8-eda8-4f7c-80e3-214aa92a11cc",
    "private_locations": [
      {
        "private_location_id": "e6f3a65d-5d14-4db8-a6b0-8b65fcf83ea9",
        "enabled": true,
        "geoloc": "sample string 3",
        "customer_guid": "1d397f19-ea6b-4db7-a39f-90e2a2c561ba"
      },
      {
        "private_location_id": "2e7e2336-5be5-4297-85f8-62688582f4c1",
        "enabled": true,
        "geoloc": "sample string 3",
        "customer_guid": "e7fda08f-d02b-4c9e-8c1a-35d271129ced"
      },
      {
        "private_location_id": "8605417b-862d-409f-bc00-0e368ddf504c",
        "enabled": true,
        "geoloc": "sample string 3",
        "customer_guid": "ab648cc6-fc7f-4a45-9977-e4708fc1615a"
      }
    ]
  }
]
NameType 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.