GET api/v1/account
Gets the details of the account (the one the current user belongs to).
Request Information
URI Parameters
None.
Body Parameters
None.
Response Information
Resource Description
AccountDtoName | Description | Type | Additional information |
---|---|---|---|
Id |
Account Id. |
globally unique identifier |
None. |
SubDomain |
Subdomain to access the data. Key field for account. |
string |
None. |
Name |
Account name as chosen by the user. Friendly account name. |
string |
None. |
DisplayName |
Account name as displayed on the UI. Not part of the AccountName or Subdomain |
string |
None. |
Plan |
Tinanmous plan for the account. |
AccountPlan |
None. |
RegistrationCriteria |
User registration criteria. |
RegistrationCriteria |
None. |
IsPublic |
If this account is publically visible |
boolean |
None. |
IsDeleted |
If the account has been deleted. |
boolean |
None. |
Links | Collection of LinkDto |
None. |
|
EmailOptions |
Defines the email options for the account. |
EmailOptionsDto |
None. |
WelcomeMessage |
Welcome text to show the user above the login prompt |
string |
None. |
Response Formats
application/json, text/json, application/senml+json
Sample:
{ "Id": "53c61b1b-990c-465b-a533-b35d02c20f27", "SubDomain": "sample string 2", "Name": "sample string 3", "DisplayName": "sample string 4", "Plan": "Starter", "RegistrationCriteria": "RequireInvite", "IsPublic": true, "IsDeleted": true, "Links": [ { "Href": "sample string 1", "Rel": "sample string 2", "Action": "sample string 3" }, { "Href": "sample string 1", "Rel": "sample string 2", "Action": "sample string 3" } ], "EmailOptions": { "AllowUnknownSenderEmail": true, "WhiteList": [ "sample string 1", "sample string 2" ], "BlackList": [ "sample string 1", "sample string 2" ] }, "WelcomeMessage": "sample string 7" }
application/xml, text/xml
Sample:
<AccountDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AnalysisUK.Tinamous.www.ApiControllers.Models.Account"> <DisplayName>sample string 4</DisplayName> <EmailOptions> <AllowUnknownSenderEmail>true</AllowUnknownSenderEmail> <BlackList xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:string>sample string 1</d3p1:string> <d3p1:string>sample string 2</d3p1:string> </BlackList> <WhiteList xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:string>sample string 1</d3p1:string> <d3p1:string>sample string 2</d3p1:string> </WhiteList> </EmailOptions> <Id>53c61b1b-990c-465b-a533-b35d02c20f27</Id> <IsDeleted>true</IsDeleted> <IsPublic>true</IsPublic> <Links xmlns:d2p1="http://schemas.datacontract.org/2004/07/AnalysisUK.Tinamous.www.ApiControllers.Models.Shared"> <d2p1:LinkViewModel> <d2p1:Action>sample string 3</d2p1:Action> <d2p1:Href>sample string 1</d2p1:Href> <d2p1:Rel>sample string 2</d2p1:Rel> </d2p1:LinkViewModel> <d2p1:LinkViewModel> <d2p1:Action>sample string 3</d2p1:Action> <d2p1:Href>sample string 1</d2p1:Href> <d2p1:Rel>sample string 2</d2p1:Rel> </d2p1:LinkViewModel> </Links> <Name>sample string 3</Name> <Plan>Starter</Plan> <RegistrationCriteria>RequireInvite</RegistrationCriteria> <SubDomain>sample string 2</SubDomain> <WelcomeMessage>sample string 7</WelcomeMessage> </AccountDto>