GET api/v1/admin/accounts/{id}

This method retrieves the account details for the given account id. The method will return data only if the authenticated user is authorised to access the account, else it will return a HTTP 401 error.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

The Id of the account

globally unique identifier

Required

Body Parameters

None.

Response Information

Resource Description

Account details for the given account id.

ResponseOfAccount
NameDescriptionTypeAdditional information
Error

Error

None.

ResponseData

ResponseDataOfAccount

None.

Response Formats

application/json, text/json

Sample:
{
  "Error": {
    "ErrorCode": "sample string 1",
    "ErrorReason": "sample string 2"
  },
  "ResponseData": {
    "Identification": {
      "UserId": "sample string 1"
    },
    "Result": "sample string 1",
    "Detail": {
      "ID": "8a2378c4-cf98-4642-b6c7-8e03d348a55e",
      "AccountID": "b112658a-6901-4a87-8a63-9874197fd649",
      "Address": "sample string 2",
      "AnyTimeBalance": 1.1,
      "ContactNumber": "sample string 3",
      "DateCreated": "2018-06-18T20:40:12.0930313+00:00",
      "DateModified": "2018-06-18T20:40:12.0930313+00:00",
      "Disclaimer": "sample string 5",
      "EmailAddress": "sample string 6",
      "FirstName": "sample string 8",
      "LanguageID": "d8584e95-8225-4112-83ad-f455834ed68a",
      "LanguageName": "sample string 10",
      "LastName": "sample string 11",
      "Location": "sample string 12",
      "Logo": "sample string 13",
      "LogoName": "sample string 14",
      "Name": "sample string 15",
      "OffPeakBalance": 1.1,
      "SMSPassword": "sample string 16",
      "SMSUsername": "sample string 17",
      "TimeZone": "sample string 18",
      "TwoFactorEnabled": true,
      "URL": "sample string 19",
      "Website": "sample string 21"
    }
  }
}

application/xml, text/xml

Sample:
<ResponseOfAccount xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Error>
    <ErrorCode>sample string 1</ErrorCode>
    <ErrorReason>sample string 2</ErrorReason>
  </Error>
  <ResponseData>
    <Result>sample string 1</Result>
    <Identification>
      <UserId>sample string 1</UserId>
    </Identification>
    <Detail>
      <ID>8a2378c4-cf98-4642-b6c7-8e03d348a55e</ID>
      <AccountID>b112658a-6901-4a87-8a63-9874197fd649</AccountID>
      <Address>sample string 2</Address>
      <AnyTimeBalance>1.1</AnyTimeBalance>
      <ContactNumber>sample string 3</ContactNumber>
      <DateCreated>2018-06-18T20:40:12.0930313+00:00</DateCreated>
      <DateModified>2018-06-18T20:40:12.0930313+00:00</DateModified>
      <Disclaimer>sample string 5</Disclaimer>
      <EmailAddress>sample string 6</EmailAddress>
      <Enabled>true</Enabled>
      <FirstName>sample string 8</FirstName>
      <LanguageID>d8584e95-8225-4112-83ad-f455834ed68a</LanguageID>
      <LanguageName>sample string 10</LanguageName>
      <LastName>sample string 11</LastName>
      <Location>sample string 12</Location>
      <Logo>sample string 13</Logo>
      <LogoName>sample string 14</LogoName>
      <Name>sample string 15</Name>
      <OffPeakBalance>1.1</OffPeakBalance>
      <SMSPassword>sample string 16</SMSPassword>
      <SMSUsername>sample string 17</SMSUsername>
      <TimeZone>sample string 18</TimeZone>
      <TwoFactorEnabled>true</TwoFactorEnabled>
      <URL>sample string 19</URL>
      <Users>
        <AccountUserInfo>
          <UserID>3f6c7048-15e4-4cf8-ae57-f4e16a139028</UserID>
          <Name>sample string 2</Name>
          <PermissionLevel>STANDARD_USER</PermissionLevel>
        </AccountUserInfo>
        <AccountUserInfo>
          <UserID>3f6c7048-15e4-4cf8-ae57-f4e16a139028</UserID>
          <Name>sample string 2</Name>
          <PermissionLevel>STANDARD_USER</PermissionLevel>
        </AccountUserInfo>
      </Users>
      <Validated>true</Validated>
      <Website>sample string 21</Website>
    </Detail>
  </ResponseData>
</ResponseOfAccount>