Jump to: navigation, search

List Places Assigned to Business Unit

This operation is part of the Place Management API section of the Web Services API.

Overview

Retrieves places assigned to the specified business unit ID.

Request URL /api/v2/groups/{id}/places
HTTP Method GET
Required Features api-provisioning-read


Samples

Request

GET /api/v2/groups/2-6c439a40-55aa-4ecf-a52e-a6a7cd03cd28/places

HTTP Response

{
    "paths": [
        "/places/d6d40340-1e28-4d3b-bf6c-a09c59d3033f"
    ],
    "statusCode": 0,
    "uris": [
        "http://1.2.3.4:8080/api/v2/places/d6d40340-1e28-4d3b-bf6c-a09c59d3033f"
    ]
}


This request uses the fields request parameter:

Request

GET /api/v2/groups/2-6c439a40-55aa-4ecf-a52e-a6a7cd03cd28/places?fields=*

HTTP Response

{
    "places": [
        {
            "id": "3e3eb354-fff4-44ac-a89f-a0f3b4172434",
            "name": "3001",
            "path": "/places/3e3eb354-fff4-44ac-a89f-a0f3b4172434",
            "uri": "http://1.2.3.4:8080/api/v2/places/3e3eb354-fff4-44ac-a89f-a0f3b4172434"
        }
    ],
    "statusCode": 0
}


This request uses the subresources request parameter:

Request

GET /api/v2/groups/2-6c439a40-55aa-4ecf-a52e-a6a7cd03cd28/places?subresources=*

HTTP Response

{
    "places": [
        {
            "id": "3e3eb354-fff4-44ac-a89f-a0f3b4172434",
            "name": "3001",
            "path": "/places/3e3eb354-fff4-44ac-a89f-a0f3b4172434",
            "uri": "http://1.2.3.4:8080/api/v2/places/3e3eb354-fff4-44ac-a89f-a0f3b4172434"
        }
    ],
    "statusCode": 0
}
This page was last edited on January 22, 2016, at 19:56.
Comments or questions about this documentation? Contact us for support!