User Location Access (GET)

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 user_location_access")

https://<yoursubdomain>.filetransfers.net/api/user_location_access

Restrictions

The calling user must have:

Access to the specified location.

Parameters

Bold indicates required.

Parameter	Description
path	The location used to retrieve users.
type	Default is "all". Use "nonAdminsOnly" to get users with no admin or sub-admin privileges.
api_key	Your API Key.
timestamp	The current time in Unix timestamp format.
signature	Please see "User Authentication" for more information.

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":"This email address is being protected from spambots. You need JavaScript enabled to view it.",
   "firstName":"John",
   "lastName":"Smith",
   "organization":null,
   "subAdmin":null,
   "admin":1,
   "uType":1,
   "autoRecip":0},
   "id":124,
   "username":"bsmith",
   "email":"This email address is being protected from spambots. You need JavaScript enabled to view it.",
   "firstName":"Bob",
   "lastName":"Smith",
   "organization":"Acme Inc.",
   "subAdmin":1,
   "admin":0,
   "uType":1,
   "autoRecip":0}
]}

Successful response in XML:

	
  	123
    jsmith
    This email address is being protected from spambots. You need JavaScript enabled to view it.
    John
    Smith
    
    
    1
    1
    0
  
	
  	124
    bsmith
    This email address is being protected from spambots. You need JavaScript enabled to view it.
    Bob
    Smith
    Acme Inc.
    1
    0
    1
    0

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>