[HTTP GET] ~/accounts
Description: Gets account info for a logged-in/authenticated User
Request Information
URI Parameters
None.
Body Parameters
None
Response Information
Description
Successful Response - OK (200):
An AccountDTO detailing User's account info
Response Content : AccountInfo
Name | Description | Type | Additional information |
---|---|---|---|
AccountId |
The Id of the Account |
integer |
None. |
CompanyName |
The Name of the Account |
string |
None. |
DisplayName |
The Name of the User |
string |
None. |
User |
Details of the this User |
UserInfo |
None. |
UserAccounts |
Details of the Accounts that this user has access to |
Collection of UserAccountInfo |
None. |
Apps |
Details of the Apps that this user has access to |
Collection of AppInfo |
None. |
Response Codes:
-
200 - OK
- The Account Information for the Authenticated User was retrieved and returned successfully.
-
401 - Unauthorized
- Request has been denied as it lacks valid Authentication credentials.
-
500 - InternalServerError
- An error occurred while processing this request.
Formats
application/json, text/json
Sample:
{ "AccountId": 1, "CompanyName": "sample string 2", "DisplayName": "sample string 3", "User": { "Id": 1, "UserName": "sample string 2", "FirstName": "sample string 3", "Surname": "sample string 4", "WorkPhone": "sample string 5", "Mobile": "sample string 6", "JobTitle": "sample string 7", "StaffId": "sample string 8", "DocumentGroups": [ 1, 2 ], "AccountId": 9, "Access": 10, "Roles": [ "sample string 1", "sample string 2" ] }, "UserAccounts": [ { "Id": 1, "Name": "sample string 2", "Access": 3, "Roles": [ "sample string 1", "sample string 2" ] }, { "Id": 1, "Name": "sample string 2", "Access": 3, "Roles": [ "sample string 1", "sample string 2" ] } ], "Apps": [ { "Id": 1, "Name": "sample string 2", "AppKey": "sample string 3", "AccountId": 4 }, { "Id": 1, "Name": "sample string 2", "AppKey": "sample string 3", "AccountId": 4 } ] }
application/csp-report
Sample:
{"AccountId":1,"CompanyName":"sample string 2","DisplayName":"sample string 3","User":{"Id":1,"UserName":"sample string 2","FirstName":"sample string 3","Surname":"sample string 4","WorkPhone":"sample string 5","Mobile":"sample string 6","JobTitle":"sample string 7","StaffId":"sample string 8","DocumentGroups":[1,2],"AccountId":9,"Access":10,"Roles":["sample string 1","sample string 2"]},"UserAccounts":[{"Id":1,"Name":"sample string 2","Access":3,"Roles":["sample string 1","sample string 2"]},{"Id":1,"Name":"sample string 2","Access":3,"Roles":["sample string 1","sample string 2"]}],"Apps":[{"Id":1,"Name":"sample string 2","AppKey":"sample string 3","AccountId":4},{"Id":1,"Name":"sample string 2","AppKey":"sample string 3","AccountId":4}]}
application/xml, text/xml
Sample:
<AccountInfo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/W50API.Models.DTO"> <AccountId>1</AccountId> <Apps> <AppInfo> <AccountId>4</AccountId> <AppKey>sample string 3</AppKey> <Id>1</Id> <Name>sample string 2</Name> </AppInfo> <AppInfo> <AccountId>4</AccountId> <AppKey>sample string 3</AppKey> <Id>1</Id> <Name>sample string 2</Name> </AppInfo> </Apps> <CompanyName>sample string 2</CompanyName> <DisplayName>sample string 3</DisplayName> <User> <Access>10</Access> <AccountId>9</AccountId> <DocumentGroups xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:int>1</d3p1:int> <d3p1:int>2</d3p1:int> </DocumentGroups> <FirstName>sample string 3</FirstName> <Id>1</Id> <JobTitle>sample string 7</JobTitle> <Mobile>sample string 6</Mobile> <Roles xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:string>sample string 1</d3p1:string> <d3p1:string>sample string 2</d3p1:string> </Roles> <StaffId>sample string 8</StaffId> <Surname>sample string 4</Surname> <UserName>sample string 2</UserName> <WorkPhone>sample string 5</WorkPhone> </User> <UserAccounts> <UserAccountInfo> <Access>3</Access> <Id>1</Id> <Name>sample string 2</Name> <Roles xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d4p1:string>sample string 1</d4p1:string> <d4p1:string>sample string 2</d4p1:string> </Roles> </UserAccountInfo> <UserAccountInfo> <Access>3</Access> <Id>1</Id> <Name>sample string 2</Name> <Roles xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d4p1:string>sample string 1</d4p1:string> <d4p1:string>sample string 2</d4p1:string> </Roles> </UserAccountInfo> </UserAccounts> </AccountInfo>