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.AccountV2Name | Description | Type | Additional 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": "04f9fe13-c8d5-4440-a607-a2448c6f8bbb", "AccountID": "607c6b00-e76e-47f2-b48c-caf2af754297", "Address": "sample string 7", "AnyTimeBalance": 1.1, "ContactNumber": "sample string 8", "PhoneNumber": "sample string 9", "DateCreated": "2024-11-21T08:29:51.758918+00:00", "DateModified": "2024-11-21T08:29:51.758918+00:00", "Disclaimer": "sample string 11", "EmailAddress": "sample string 13", "FirstName": "sample string 15", "Defaultheader": "sample string 16", "LanguageID": "fae84072-540e-417b-81b1-52cce9c4cb25", "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>04f9fe13-c8d5-4440-a607-a2448c6f8bbb</ID> <AccountID>607c6b00-e76e-47f2-b48c-caf2af754297</AccountID> <Address>sample string 7</Address> <AnyTimeBalance>1.1</AnyTimeBalance> <ContactNumber>sample string 8</ContactNumber> <PhoneNumber>sample string 9</PhoneNumber> <DateCreated>2024-11-21T08:29:51.758918+00:00</DateCreated> <DateModified>2024-11-21T08:29:51.758918+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>fae84072-540e-417b-81b1-52cce9c4cb25</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>1ea82ffe-cfee-4c7a-b957-c75a5ecb4b70</UserID> <Name>sample string 2</Name> <PermissionLevel>STANDARD_USER</PermissionLevel> </AccountUserInfo> <AccountUserInfo> <UserID>1ea82ffe-cfee-4c7a-b957-c75a5ecb4b70</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>