Jump to: navigation, search

List Places Assigned to User

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

Overview

Retrieves places assigned to the specified user ID.

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

Samples

Request

GET /api/v2/users/2fe900a79ca644bb8e7a11595e1ac842/places

HTTP Response

{
    "paths": [
        "/places/036c9f75-5234-4e9d-9ec3-ab8ea808f5c2"
    ],
    "statusCode": 0,
    "uris": [
        "http://esx37-ip21-204.gws.genesys.com:8090/api/v2/places/036c9f75-5234-4e9d-9ec3-ab8ea808f5c2"
    ]
}


This request uses the fields request parameter:

Request

GET /api/v2/users/2fe900a79ca644bb8e7a11595e1ac842/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/users/2fe900a79ca644bb8e7a11595e1ac842/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
}

Feedback

Comment on this article:

blog comments powered by Disqus
This page was last modified on January 22, 2016, at 11:56.