Tuyu Developers

Description

Lists users who are have access to particular location.

URL

All responses are in JSON format by default, to specify an XML response add “.xml” to the end of the method name (in this case “users_location_access”)

https://<your subdomain>.<your domain>/api/users_location_access

Restrictions

The calling user must have:

• Access to the specified location.

Parameters

Bold indicates required. Please note parameters must be appended to the URL in alphabetical order, except for “signature”, which is always at the end.

Sample Response

In a successful response “uType” is 1 for users, 0 for user groups.

Successful response In JSON:

{"usersLocationAccess":[
    {"id":123,
    "username":"jsmith",
    "email":"jsmith@company.com",
    "firstName":"John",
    "lastName":"Smith",
    "organization":null,
    "subAdmin":null,
    "admin":1,
    "uType":1,
    "autoRecip":0},
    "id":124,
    "username":"bsmith",
    "email":"bsmith@company.com",
    "firstName":"Bob",
    "lastName":"Smith",
    "organization":"Acme Inc.",
    "subAdmin":1,
    "admin":0,
    "uType":1,
    "autoRecip":0}
]}

Successful response in XML:

<usersLocationAccess>
    <user>
        <id>123</id>
        <username>jsmith</username>
        <email>jsmith@company.com</email>
        <firstName>John</firstName>
        <lastName>Smith</lastName>
        <organization/>
        <subAdmin/>
        <admin>1</admin>
        <uType>1</uType>
        <autoRecip>0</autoRecip>
    </user>
    <user>
        <id>124</id>
        <username>bsmith</username>
        <email>bsmith@company.com</email>
        <firstName>Bob</firstName>
        <lastName>Smith</lastName>
        <organization>Acme Inc.</organization>
        <subAdmin>1</subAdmin>
        <admin>0</admin>
        <uType>1</uType>
        <autoRecip>0</autoRecip>
    </user>
<usersLocationAccess>

Error response In JSON:

{"error":{
    "title":"You do not have access privileges for this location",
    "message":"Please try a different location or speak to an administrator"}
}

Error response In XML:

<error>
    <title>You do not have access privileges for this location</title>
    <message>Please try a different location or speak to an administrator</message>
</error>