GET api/v1/admin/accounts

This method retrieves the account details for the logged in user.

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

Account details for the logged in account id.

TwoSms.CustomerPortalRole.API.Misc.ResponseOfTwoSms.CustomerPortalRole.API.Admin.Accounts.AccountV2
NameDescriptionTypeAdditional information
Error

TwoSms.CustomerPortalRole.API.Misc.Error

None.

ResponseData

TwoSms.CustomerPortalRole.API.Misc.ResponseDataOfTwoSms.CustomerPortalRole.API.Admin.Accounts.AccountV2

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": {
      "CountryCode": "sample string 1",
      "NDD": "sample string 2",
      "IDD": "sample string 3",
      "Timeout": 4,
      "Type": "sample string 5",
      "ID": "26e0f917-1b9a-4b30-b2ea-8f8b1203d28d",
      "AccountID": "67cc788c-0559-408a-bdea-b05fabb5860a",
      "Address": "sample string 7",
      "AnyTimeBalance": 1.1,
      "ContactNumber": "sample string 8",
      "PhoneNumber": "sample string 9",
      "DateCreated": "2024-04-16T16:43:54.664922+00:00",
      "DateModified": "2024-04-16T16:43:54.664922+00:00",
      "Disclaimer": "sample string 11",
      "EmailAddress": "sample string 13",
      "FirstName": "sample string 15",
      "Defaultheader": "sample string 16",
      "LanguageID": "deefacdc-5481-42e3-ad73-847406b4dbe7",
      "LanguageName": "sample string 18",
      "LastName": "sample string 19",
      "Location": "sample string 20",
      "Logo": "sample string 21",
      "LogoName": "sample string 23",
      "Name": "sample string 24",
      "OffPeakBalance": 1.1,
      "Preferences": [
        0,
        0
      ],
      "SCIMEnabled": true,
      "SMSPassword": "sample string 26",
      "SMSUsername": "sample string 27",
      "TimeZone": "sample string 28",
      "TwoFactorEnabled": true,
      "URL": "sample string 29",
      "Website": "sample string 31"
    }
  }
}

application/xml, text/xml

Sample:
<ResponseOfAccountV2 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>26e0f917-1b9a-4b30-b2ea-8f8b1203d28d</ID>
      <AccountID>67cc788c-0559-408a-bdea-b05fabb5860a</AccountID>
      <Address>sample string 7</Address>
      <AnyTimeBalance>1.1</AnyTimeBalance>
      <ContactNumber>sample string 8</ContactNumber>
      <PhoneNumber>sample string 9</PhoneNumber>
      <DateCreated>2024-04-16T16:43:54.664922+00:00</DateCreated>
      <DateModified>2024-04-16T16:43:54.664922+00:00</DateModified>
      <Disclaimer>sample string 11</Disclaimer>
      <DisclaimerRemove>true</DisclaimerRemove>
      <EmailAddress>sample string 13</EmailAddress>
      <Enabled>true</Enabled>
      <FirstName>sample string 15</FirstName>
      <Defaultheader>sample string 16</Defaultheader>
      <LanguageID>deefacdc-5481-42e3-ad73-847406b4dbe7</LanguageID>
      <LanguageName>sample string 18</LanguageName>
      <LastName>sample string 19</LastName>
      <Location>sample string 20</Location>
      <Logo>sample string 21</Logo>
      <LogoRemoved>true</LogoRemoved>
      <LogoName>sample string 23</LogoName>
      <Name>sample string 24</Name>
      <OffPeakBalance>1.1</OffPeakBalance>
      <Preferences>
        <AccountPreferences>ALL</AccountPreferences>
        <AccountPreferences>ALL</AccountPreferences>
      </Preferences>
      <SCIMEnabled>true</SCIMEnabled>
      <SMSPassword>sample string 26</SMSPassword>
      <SMSUsername>sample string 27</SMSUsername>
      <TimeZone>sample string 28</TimeZone>
      <TwoFactorEnabled>true</TwoFactorEnabled>
      <URL>sample string 29</URL>
      <Users>
        <AccountUserInfo>
          <UserID>bd574581-f5c3-4451-8548-c854d2f0776c</UserID>
          <Name>sample string 2</Name>
          <PermissionLevel>STANDARD_USER</PermissionLevel>
        </AccountUserInfo>
        <AccountUserInfo>
          <UserID>bd574581-f5c3-4451-8548-c854d2f0776c</UserID>
          <Name>sample string 2</Name>
          <PermissionLevel>STANDARD_USER</PermissionLevel>
        </AccountUserInfo>
      </Users>
      <Validated>true</Validated>
      <Website>sample string 31</Website>
      <CountryCode>sample string 1</CountryCode>
      <NDD>sample string 2</NDD>
      <IDD>sample string 3</IDD>
      <Timeout>4</Timeout>
      <Type>sample string 5</Type>
    </Detail>
  </ResponseData>
</ResponseOfAccountV2>