Versions Compared
Key
- This line was added.
- This line was removed.
- Formatting was changed.
Retrieves details for an account.
Resource URL:
| Panel |
|---|
http://api.textmarketer.co.uk/services/rest/account |
or:
| Panel |
|---|
http://api.textmarketer.co.uk/services/rest/account/<account ID> |
Example successful response body XML:
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
<?xml version="1.0" encoding="ISO-8859-1"?> <!DOCTYPE response PUBLIC "-//textmarketer.co.uk//DTD Web Services REST 1.6//EN" "http://api.textmarketer.co.uk/services/rest/DTD/groups_get.dtd"> <response processed_date="2012-04-11T11:23:14+02:00"> <account> <account_id>abcdefghijklmnopqrstuvwx</account_id> <api_password>my_api_password</api_password> <api_username>my_api_username</api_username> <company_name>Bill's Bakery</company_name> <create_date>20012-02-12T01:00:00+02:00</create_date> <credits>833</credits> <notification_email>bill@billsbakery.com</notification_email> <notification_mobile>447777777777</notification_mobile> <password>my_UI_password</password> <username>my_UI_username</username> </account> </response> |
Response meanings:
| XML tag/attribute | Meaning |
|---|---|
| account_id | Up to 24 alpha-numeric characters. Your reference for the account, to be used when specifying an account for retrieval that is not the account identifed by the API username/password you are using to access the API, i.e. you can use this to specify other accounts that you have created. You may access any account that was created using the account you are using to access the API. |
| api_password | The API password of the account retrieved |
| api_username | The API username of the account retrieved |
| company_name | The company name of the account retrieved |
| create_date | The exact time/date the account was created (in ISO 8601 format) |
| credits | The number of credits available on the account. If you only wish to retrieve the number of credits, you should use the credits resource. |
| notifcation_email | The main email address of the account, used to receive notifcations and alerts. |
| notifcation_mobile | The main mobile number of the account, used to receive notifcations and alerts. |
| password | The account password, used to access the account UI at https://messagebox.textmarketer.co.uk. |
| username | The account username, used to access the account UI at https://messagebox.textmarketer.co.uk. |
specific Specific errors:
No specific errors.
| Note |
|---|
that a 404 status code is returned if the account ID specified does not exist, and 403 if you do not have permission to access the account you specified. |
DTD:
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
<?xml version="1.0" encoding="UTF-8"?> <!-- PUBLIC ID : -//textmarketer.co.uk//DTD Web Services REST 1.6//EN SYSTEM ID : http://api.textmarketer.co.uk/services/rest/DTD/groups_get.dtd --> <!ELEMENT response (account)> <!ATTLIST response processed_date CDATA #REQUIRED > <!ELEMENT account (account_id, api_password, api_username, company_name?, create_date, credits, notification_email?, notification_mobile?, password, username)> <!ELEMENT account_id (#PCDATA)> <!ELEMENT api_password (#PCDATA)> <!ELEMENT api_username (#PCDATA)> <!ELEMENT company_name (#PCDATA)> <!ELEMENT create_date (#PCDATA)> <!ELEMENT credits (#PCDATA)> <!ELEMENT notification_email (#PCDATA)> <!ELEMENT notification_mobile (#PCDATA)> <!ELEMENT password (#PCDATA)> <!ELEMENT username (#PCDATA)> |
| Panel |
|---|
Next: account POST method |