client.get
Get user attributes. You can get only attributes for your account, not for managed accounts. Managed accounts
information is available in the foreignAccounts list in result of this method.
Parameters
| struct |
user { |
|
| string |
session |
Session (as retrieved from client.loginByToken())
|
|
} |
|
|
Response
| struct |
{ |
|
| string |
status |
Status code
|
| string |
statusMessage |
Status code description
|
| string |
session |
Refreshed session
|
| datetime |
sessionStarted |
When this session was started (by calling client.loginByToken())
|
| struct |
user { |
|
| string |
agencyStatus |
Status of this account:
-
normal:
normal account (not an agency account)
-
wallet-agency:
agency account taking credit from wallet
-
bill-agency:
agency account with billing
-
client-agency:
account expenses are paid by an agency account
|
| int |
walletCredit |
User's credit (in halers)
|
| int |
walletCreditWithVat |
User's credit including VAT; in halers
|
| bool |
walletVerified |
User's Wallet is verified
|
| int |
dayBudgetSum |
Sum of day budgets of all campaigns (in cents)
|
| int |
accountLimit |
(can be null) Account monthly limit (in halers) or nil;
|
|
} |
|
|
| array |
foreignAccounts ( |
Accounts to which this user has access
|
| struct |
{ |
|
| int |
userId |
Foreign account user id
|
| string |
username |
Foreign account username
|
| string |
access |
Access type:
-
r:
Read-only
-
rw:
Read-write
|
| string |
relationName |
Name of relation to this foreign account
|
| string |
relationStatus |
Relation status:
-
live:
connection to the account is working
-
offer:
an offer of the access by a foreign account was not yet accepted
-
request:
requested access to this foreign account was not yet accepted
|
| string |
relationType |
Type of the relation to this foreign account:
-
normal:
normal
-
agency:
agency relation; foreign account expenses are paid by this user
|
| int |
walletCredit |
(can be null) Foreign account user's credit (in halers) or nil
|
| int |
walletCreditWithVat |
(can be null) Foreign account user's credit including VAT (in halers)
|
| bool |
walletVerified |
(can be null) User's Wallet is verified; can be nil if not
|
| int |
accountLimit |
(can be null) Account monthly limit (in halers) or nil;
|
| int |
dayBudgetSum |
Sum of day budgets of all campaigns (in cents)
|
|
} |
|
|
|
) |
|
|
| array |
diagnostics ( |
(optional) Various diagnostics(warnings, errors, other information)
|
|
|
) |
|
|
|
} |
|
|
Response status codes:
List of all possible response status codes:
200: OK206: Partially OK301: User is serviced400: Bad arguments401: Invalid session403: Access Denied404: Not found406: Bad values of attributes413: Too many items requested.429: Too many requests. Has to wait.500: Server Error.409: Conflict
Diagnostics:
List of all possible diagnostics:
