Jump to: navigation, search

Assign Place to User

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

Overview

Assigns a place to a user.

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

Parameters

Parameter Value
path The path of the place to assign to the user.
paths The paths of several places to assign to the user.
uri The uri of the place to assign to the user.
uris The uris of several places to assign to the user.
Important
All parameters are independent and can be used separately from each other.

Samples

This example sends a request with the uri parameter:

Request

POST /api/v2/users/11f2929763414ad2932d1a05e5abd5ae/places
{
  'uri': 'http://1.2.3.4:8080/api/v2/places/d6d40340-1e28-4d3b-bf6c-a09c59d3033f'
}

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 example sends a request with the uris parameter:

Request

POST /api/v2/users/11f2929763414ad2932d1a05e5abd5ae/places
{
  'uris': [
    'http://1.2.3.4:8080/api/v2/places/d6d40340-1e28-4d3b-bf6c-a09c59d3033f',
    'http://1.2.3.4:8080/api/v2/places/14f6636cf11447919604ac42f952e2a2'
  ]
}

HTTP Response

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


This example sends a request with the path parameter:

Request

POST /api/v2/users/11f2929763414ad2932d1a05e5abd5ae/places
{
  'path': '/places/0e0bb396-3dc3-42a9-9b20-f1e66e0805cd'
}

HTTP Response

{
    "paths": [
        "/places/0e0bb396-3dc3-42a9-9b20-f1e66e0805cd"
    ],
    "statusCode": 0,
    "uris": [
        "http://1.2.3.4:8080/api/v2/places/0e0bb396-3dc3-42a9-9b20-f1e66e0805cd"
    ]
}


This example sends a request with the paths parameter:

Request

POST /api/v2/users/11f2929763414ad2932d1a05e5abd5ae/places
{
  'paths': [
    '/places/0e0bb396-3dc3-42a9-9b20-f1e66e0805cd', 
    '/places/b24c94d1-d31e-4a97-853f-50aabd5c159f'
  ]
}

HTTP Response

{
    "paths": [
        "/places/0e0bb396-3dc3-42a9-9b20-f1e66e0805cd",
        "/places/b24c94d1-d31e-4a97-853f-50aabd5c159f"
    ],
    "statusCode": 0,
    "uris": [
        "http://1.2.3.4:8080/api/v2/places/0e0bb396-3dc3-42a9-9b20-f1e66e0805cd",
        "http://1.2.3.4:8080/api/v2/places/b24c94d1-d31e-4a97-853f-50aabd5c159f
    ]
}

Feedback

Comment on this article:

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