Retrieves details for an account.
Resource URL:
http://api.textm= arketer.co.uk/services/rest/account
=20
or:
http://api.textmarketer.co.uk/ser= vices/rest/account/<account ID>
=20
Example successful response body XML:
<?xml version=3D"1.0" encoding=3D"ISO-8859-1"?&= gt; <!DOCTYPE response PUBLIC "-//textmarketer.co.uk//DTD Web Services REST 1.6//EN" "http://api.textmarketer.co.uk/services/rest/DTD/groups_get.dtd"&= gt; <response processed_date=3D"2012-04-11T11:23:14+02:00"> =09<account> =09=09<account_id>abcdefghijklmnopqrstuvwx</account_id> =09=09<api_password>my_api_password</api_password> =09=09<api_username>my_api_username</api_username> =09=09<company_name>Bill's Bakery</company_name> =09=09<create_date>20012-02-12T01:00:00+02:00</create_date> =09=09<credits>833</credits> =09=09<notification_email>bill@billsbakery.com</notification_email= > =09=09<notification_mobile>447777777777</notification_mobile> =09=09<password>my_UI_password</password> =09=09<username>my_UI_username</username> =09</account> </response>=20
Response meanings:
| XML tag/attribute | Meaning |
|---|---|
| account_id | Up to 24 alpha-numeric characters. Your refer= ence for the account, to be used when specifying an account for retrieval t= hat 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 yo= u have created. You may access any account that was created using the accou= nt 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 accoun= t. 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 t= o receive notifcations and alerts. |
| notifcation_mobile | The main mobile number of the account, used t= o receive notifcations and alerts. |
| password | The account password, used to access the acco= unt UI at https://messagebox.textmarketer.co.uk= . |
| username | The account username, used to access the acco= unt UI at https://messagebox.textmarketer.co.uk= . |
Specific errors:
No specific errors.
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 spec= ified.
DTD:
<?xml version=3D"1.0" encoding=3D"UTF-8"?> <!-- =09PUBLIC ID : -//textmarketer.co.uk//DTD Web Services REST 1.6//EN =09SYSTEM ID : http://api.textmarketer.co.uk/services/rest/DTD/groups_get.= dtd --> <!ELEMENT response (account)> <!ATTLIST response =09processed_date CDATA #REQUIRED > <!ELEMENT account (account_id, api_password, api_username, company_name?= ,=20 create_date, credits, notification_email?, notification_mobile?, password,= =20 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)>=20
Next: account POST metho= d
Home: All Documentation
=20