Availability

Breeze 4

Description

Provides a list of the accounts a user belongs to.

The user-accounts action is only used when a user belongs to more than one account on the server and uses the same login ID and password for each. In that case, a user’s login is likely to fail with a status message of too-much-data. This action is useful when you want to retrieve a list of a user’s accounts and give the user a choice of which account to log in to.

Request URL

 http://server_name/api/xml 
     ?action=user-accounts 
     &login=string 
     &password=string 
     &session=BreezeSessionCookieValue

Parameters

Name

Type

Required

Description

login

String

Y

The user’s login name, which may be the user’s e-mail address.

password

String

Y

The user’s password.

session

String

N

The value of the BREEZESESSION cookie. Use this parameter if you do not use a client-side cookie management library.

Filters

Results cannot be filtered or sorted. The default sort is by account-name.

Response structure

 <?xml version="1.0" encoding="utf-8" ?>  
 <results> 
     <status code=allowedValue />  
     <users> 
         <user user-id=integer account-id=integer> 
             <name>string</name>  
             <date-expired>datetime</date-expired>  
         </user> 
         ... 
     </users> 
 </results>

Response values

Element

Attribute

Type

Description

results  

Container

All results the action returns.

status  

Empty, with attributes

The status of the response.

  code

Allowed value

A code indicating the response status (see status).

users  

Container

Information about the accounts the user belongs to.

user  

Container

Information about a user and an account.

  user-id

BIGINT

The ID of the user on the server.

  account-id

BIGINT

The ID of the account the user belongs to.

name  

String

The name of the account the user belongs to.

date-expired  

Datetime

The date and time the user’s login expires.

Sample request

 https://sample.com/api/xml?action=user-accounts&login=joy@acme.com 
     &password=bigdog

Sample response

 <?xml version="1.0" encoding="utf-8" ?>  
 <results>  
     <status code="ok" />  
     <users>  
         <user user-id="2006258745" account-id="624520">  
             <name>Test Account</name>  
             <date-expired>2999-12-31T16:00:00.000-08:00</date-expired>  
         </user>  
     </users>  
 </results>

This work is licensed under a Creative Commons Attribution-Noncommercial-Share Alike 3.0 Unported License  Twitter™ and Facebook posts are not covered under the terms of Creative Commons.

Legal Notices   |   Online Privacy Policy