Test

<back to all web services

GetSession

The following routes are available for this service:
All Verbs/session
// @ts-nocheck

export interface IAuthTokens
{
    provider?: string;
    userId?: string;
    accessToken?: string;
    accessTokenSecret?: string;
    refreshToken?: string;
    refreshTokenExpiry?: string;
    requestToken?: string;
    requestTokenSecret?: string;
    items?: { [index:string]: string; };
}

// @DataContract
export class AuthUserSession implements IMeta
{
    // @DataMember(Order=1)
    public referrerUrl?: string;

    // @DataMember(Order=2)
    public id?: string;

    // @DataMember(Order=3)
    public userAuthId?: string;

    // @DataMember(Order=4)
    public userAuthName?: string;

    // @DataMember(Order=5)
    public userName?: string;

    // @DataMember(Order=6)
    public twitterUserId?: string;

    // @DataMember(Order=7)
    public twitterScreenName?: string;

    // @DataMember(Order=8)
    public facebookUserId?: string;

    // @DataMember(Order=9)
    public facebookUserName?: string;

    // @DataMember(Order=10)
    public firstName?: string;

    // @DataMember(Order=11)
    public lastName?: string;

    // @DataMember(Order=12)
    public displayName?: string;

    // @DataMember(Order=13)
    public company?: string;

    // @DataMember(Order=14)
    public email?: string;

    // @DataMember(Order=15)
    public primaryEmail?: string;

    // @DataMember(Order=16)
    public phoneNumber?: string;

    // @DataMember(Order=17)
    public birthDate?: string;

    // @DataMember(Order=18)
    public birthDateRaw?: string;

    // @DataMember(Order=19)
    public address?: string;

    // @DataMember(Order=20)
    public address2?: string;

    // @DataMember(Order=21)
    public city?: string;

    // @DataMember(Order=22)
    public state?: string;

    // @DataMember(Order=23)
    public country?: string;

    // @DataMember(Order=24)
    public culture?: string;

    // @DataMember(Order=25)
    public fullName?: string;

    // @DataMember(Order=26)
    public gender?: string;

    // @DataMember(Order=27)
    public language?: string;

    // @DataMember(Order=28)
    public mailAddress?: string;

    // @DataMember(Order=29)
    public nickname?: string;

    // @DataMember(Order=30)
    public postalCode?: string;

    // @DataMember(Order=31)
    public timeZone?: string;

    // @DataMember(Order=32)
    public requestTokenSecret?: string;

    // @DataMember(Order=33)
    public createdAt: string;

    // @DataMember(Order=34)
    public lastModified: string;

    // @DataMember(Order=35)
    public roles?: string[];

    // @DataMember(Order=36)
    public permissions?: string[];

    // @DataMember(Order=37)
    public isAuthenticated: boolean;

    // @DataMember(Order=38)
    public fromToken: boolean;

    // @DataMember(Order=39)
    public profileUrl?: string;

    // @DataMember(Order=40)
    public sequence?: string;

    // @DataMember(Order=41)
    public tag: number;

    // @DataMember(Order=42)
    public authProvider?: string;

    // @DataMember(Order=43)
    public providerOAuthAccess?: IAuthTokens[];

    // @DataMember(Order=44)
    public meta?: { [index:string]: string; };

    // @DataMember(Order=45)
    public audiences?: string[];

    // @DataMember(Order=46)
    public scopes?: string[];

    // @DataMember(Order=47)
    public dns?: string;

    // @DataMember(Order=48)
    public rsa?: string;

    // @DataMember(Order=49)
    public sid?: string;

    // @DataMember(Order=50)
    public hash?: string;

    // @DataMember(Order=51)
    public homePhone?: string;

    // @DataMember(Order=52)
    public mobilePhone?: string;

    // @DataMember(Order=53)
    public webpage?: string;

    // @DataMember(Order=54)
    public emailConfirmed?: boolean;

    // @DataMember(Order=55)
    public phoneNumberConfirmed?: boolean;

    // @DataMember(Order=56)
    public twoFactorEnabled?: boolean;

    // @DataMember(Order=57)
    public securityStamp?: string;

    // @DataMember(Order=58)
    public type?: string;

    // @DataMember(Order=59)
    public recoveryToken?: string;

    // @DataMember(Order=60)
    public refId?: number;

    // @DataMember(Order=61)
    public refIdStr?: string;

    public constructor(init?: Partial<AuthUserSession>) { (Object as any).assign(this, init); }
}

export class CustomUserSession extends AuthUserSession
{
    // @DataMember
    public customName?: string;

    // @DataMember
    public customInfo?: string;

    public constructor(init?: Partial<CustomUserSession>) { super(init); (Object as any).assign(this, init); }
}

export class UnAuthInfo
{
    public customInfo?: string;

    public constructor(init?: Partial<UnAuthInfo>) { (Object as any).assign(this, init); }
}

export class GetSessionResponse
{
    public result?: CustomUserSession;
    public unAuthInfo?: UnAuthInfo;
    public responseStatus?: ResponseStatus;

    public constructor(init?: Partial<GetSessionResponse>) { (Object as any).assign(this, init); }
}

export class GetSession
{

    public constructor(init?: Partial<GetSession>) { (Object as any).assign(this, init); }
}

TypeScript GetSession DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /session HTTP/1.1 
Host: test.servicestack.net 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<GetSession xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Test.ServiceInterface" />
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GetSessionResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Test.ServiceInterface">
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <Result>
    <ReferrerUrl xmlns="http://schemas.servicestack.net/types">String</ReferrerUrl>
    <Id xmlns="http://schemas.servicestack.net/types">String</Id>
    <UserAuthId xmlns="http://schemas.servicestack.net/types">String</UserAuthId>
    <UserAuthName xmlns="http://schemas.servicestack.net/types">String</UserAuthName>
    <UserName xmlns="http://schemas.servicestack.net/types">String</UserName>
    <TwitterUserId xmlns="http://schemas.servicestack.net/types">String</TwitterUserId>
    <TwitterScreenName xmlns="http://schemas.servicestack.net/types">String</TwitterScreenName>
    <FacebookUserId xmlns="http://schemas.servicestack.net/types">String</FacebookUserId>
    <FacebookUserName xmlns="http://schemas.servicestack.net/types">String</FacebookUserName>
    <FirstName xmlns="http://schemas.servicestack.net/types">String</FirstName>
    <LastName xmlns="http://schemas.servicestack.net/types">String</LastName>
    <DisplayName xmlns="http://schemas.servicestack.net/types">String</DisplayName>
    <Company xmlns="http://schemas.servicestack.net/types">String</Company>
    <Email xmlns="http://schemas.servicestack.net/types">String</Email>
    <PrimaryEmail xmlns="http://schemas.servicestack.net/types">String</PrimaryEmail>
    <PhoneNumber xmlns="http://schemas.servicestack.net/types">String</PhoneNumber>
    <BirthDate xmlns="http://schemas.servicestack.net/types">0001-01-01T00:00:00</BirthDate>
    <BirthDateRaw xmlns="http://schemas.servicestack.net/types">String</BirthDateRaw>
    <Address xmlns="http://schemas.servicestack.net/types">String</Address>
    <Address2 xmlns="http://schemas.servicestack.net/types">String</Address2>
    <City xmlns="http://schemas.servicestack.net/types">String</City>
    <State xmlns="http://schemas.servicestack.net/types">String</State>
    <Country xmlns="http://schemas.servicestack.net/types">String</Country>
    <Culture xmlns="http://schemas.servicestack.net/types">String</Culture>
    <FullName xmlns="http://schemas.servicestack.net/types">String</FullName>
    <Gender xmlns="http://schemas.servicestack.net/types">String</Gender>
    <Language xmlns="http://schemas.servicestack.net/types">String</Language>
    <MailAddress xmlns="http://schemas.servicestack.net/types">String</MailAddress>
    <Nickname xmlns="http://schemas.servicestack.net/types">String</Nickname>
    <PostalCode xmlns="http://schemas.servicestack.net/types">String</PostalCode>
    <TimeZone xmlns="http://schemas.servicestack.net/types">String</TimeZone>
    <RequestTokenSecret xmlns="http://schemas.servicestack.net/types">String</RequestTokenSecret>
    <CreatedAt xmlns="http://schemas.servicestack.net/types">0001-01-01T00:00:00</CreatedAt>
    <LastModified xmlns="http://schemas.servicestack.net/types">0001-01-01T00:00:00</LastModified>
    <Roles xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.servicestack.net/types">
      <d3p1:string>String</d3p1:string>
    </Roles>
    <Permissions xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.servicestack.net/types">
      <d3p1:string>String</d3p1:string>
    </Permissions>
    <IsAuthenticated xmlns="http://schemas.servicestack.net/types">false</IsAuthenticated>
    <FromToken xmlns="http://schemas.servicestack.net/types">false</FromToken>
    <ProfileUrl xmlns="http://schemas.servicestack.net/types">String</ProfileUrl>
    <Sequence xmlns="http://schemas.servicestack.net/types">String</Sequence>
    <Tag xmlns="http://schemas.servicestack.net/types">0</Tag>
    <AuthProvider xmlns="http://schemas.servicestack.net/types">String</AuthProvider>
    <ProviderOAuthAccess xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.servicestack.net/types">
      <d3p1:anyType i:nil="true" />
    </ProviderOAuthAccess>
    <Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.servicestack.net/types">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </Meta>
    <Audiences xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.servicestack.net/types">
      <d3p1:string>String</d3p1:string>
    </Audiences>
    <Scopes xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.servicestack.net/types">
      <d3p1:string>String</d3p1:string>
    </Scopes>
    <Dns xmlns="http://schemas.servicestack.net/types">String</Dns>
    <Rsa xmlns="http://schemas.servicestack.net/types">String</Rsa>
    <Sid xmlns="http://schemas.servicestack.net/types">String</Sid>
    <Hash xmlns="http://schemas.servicestack.net/types">String</Hash>
    <HomePhone xmlns="http://schemas.servicestack.net/types">String</HomePhone>
    <MobilePhone xmlns="http://schemas.servicestack.net/types">String</MobilePhone>
    <Webpage xmlns="http://schemas.servicestack.net/types">String</Webpage>
    <EmailConfirmed xmlns="http://schemas.servicestack.net/types">false</EmailConfirmed>
    <PhoneNumberConfirmed xmlns="http://schemas.servicestack.net/types">false</PhoneNumberConfirmed>
    <TwoFactorEnabled xmlns="http://schemas.servicestack.net/types">false</TwoFactorEnabled>
    <SecurityStamp xmlns="http://schemas.servicestack.net/types">String</SecurityStamp>
    <Type xmlns="http://schemas.servicestack.net/types">String</Type>
    <RecoveryToken xmlns="http://schemas.servicestack.net/types">String</RecoveryToken>
    <RefId xmlns="http://schemas.servicestack.net/types">0</RefId>
    <RefIdStr xmlns="http://schemas.servicestack.net/types">String</RefIdStr>
    <CustomInfo>String</CustomInfo>
    <CustomName>String</CustomName>
  </Result>
  <UnAuthInfo>
    <CustomInfo>String</CustomInfo>
  </UnAuthInfo>
</GetSessionResponse>