List Account Information
The ListAccounts function returns an array of all accounts and associated meta data. Only accounts where the user is an editor or administrator will be returned. Using the request as the superuser will return all accounts.
GET/Remote/ListAccounts
REQUEST PARAMETERS
Parameter | Type | Description | Required |
---|---|---|---|
mluser | string | Username - always in email form. | |
mltoken -or- mlpass | string | MapLarge generated auth token -or- the password for the mluser account. |
EXAMPLE REQUEST
https://my.maplarge.com/Remote/ListAccounts?mluser=user@domain.com&mltoken=token
*Either a token or password can be used in any request where authentication is required.
RETURNS
{ "id": "a261bfdfb7764808923651b2aedeeba6", "hash": null, "success": true, "processingComplete": true, "isCached": false, "authorized": true, "errors": [], "timestamp": 1446916655, "data": null, "accounts": [ { "id": 5678, "name": "ExampleAccount", "code": "exampleaccount", "description": "This is an example account." }, { "id": 5679, "name": "TestAccount", "code": "testaccount", "description": "This is test account for examples" } ] }
ACTION SPECIFIC RESPONSE VALUES
Parameter | Type | Description |
---|---|---|
accounts[] | mixed | Array of all accounts. |
id | long | The ID of the account. |
name | string | The name of the account. |
code | string | Code = account. Used to reference the account. Example: account/tablename.
|
description | string | Description of the account. |