FrameAppWS

<back to all web services

CustomUserSession

Requires Authentication

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;

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

export enum MotorBD
{
    POSTGRESQL = 'POSTGRESQL',
    ORACLE = 'ORACLE',
    SQLSERVER = 'SQLSERVER',
}

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

    // @DataMember
    public IDSistema?: number;

    // @DataMember
    public IDEmpresaProd?: string;

    // @DataMember
    public IDEmpresa?: number;

    // @DataMember
    public IDModulo?: string;

    // @DataMember
    public MotorProd?: MotorBD;

    // @DataMember
    public MotorAppAdm?: MotorBD;

    // @DataMember
    public ProdConnectionString?: string;

    // @DataMember
    public AppAdmConnectionString?: string;

    // @DataMember
    public CacheKeyAdm?: string;

    // @DataMember
    public Password?: string;

    // @DataMember
    public SessionDB?: boolean;

    // @DataMember
    public MensajeError?: string;

    // @DataMember
    public DocumentoUsuario?: string;

    // @DataMember
    public app_adm?: string;

    // @DataMember
    public imei?: string;

    // @DataMember
    public BaseURL?: string;

    // @DataMember
    public UsaServAux?: string;

    // @DataMember
    public TipoValidaAuth?: string;

    // @DataMember
    public TokenExt?: string;

    // @DataMember
    public Subsistema?: string;

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

TypeScript CustomUserSession 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 /xml/reply/CustomUserSession HTTP/1.1 
Host: ws.jimsnwa.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<CustomUserSession xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Administrador.ServiceLogs.Auth">
  <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:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.servicestack.net/types">
    <d2p1:string>String</d2p1:string>
  </Roles>
  <Permissions xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.servicestack.net/types">
    <d2p1:string>String</d2p1: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:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.servicestack.net/types">
    <d2p1:anyType i:nil="true" />
  </ProviderOAuthAccess>
  <Meta xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.servicestack.net/types">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value>String</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </Meta>
  <Audiences xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.servicestack.net/types">
    <d2p1:string>String</d2p1:string>
  </Audiences>
  <Scopes xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.servicestack.net/types">
    <d2p1:string>String</d2p1: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>
  <AppAdmConnectionString>String</AppAdmConnectionString>
  <BaseURL>String</BaseURL>
  <CacheKeyAdm>String</CacheKeyAdm>
  <DocumentoUsuario>String</DocumentoUsuario>
  <IDEmpresa>0</IDEmpresa>
  <IDEmpresaProd>String</IDEmpresaProd>
  <IDModulo>String</IDModulo>
  <IDSistema>0</IDSistema>
  <IDUsuario>String</IDUsuario>
  <MensajeError>String</MensajeError>
  <MotorAppAdm>POSTGRESQL</MotorAppAdm>
  <MotorProd>POSTGRESQL</MotorProd>
  <Password>String</Password>
  <ProdConnectionString>String</ProdConnectionString>
  <SessionDB>false</SessionDB>
  <Subsistema>String</Subsistema>
  <TipoValidaAuth>String</TipoValidaAuth>
  <TokenExt>String</TokenExt>
  <UsaServAux>String</UsaServAux>
  <app_adm>String</app_adm>
  <imei>String</imei>
</CustomUserSession>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<CustomUserSession xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Administrador.ServiceLogs.Auth">
  <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:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.servicestack.net/types">
    <d2p1:string>String</d2p1:string>
  </Roles>
  <Permissions xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.servicestack.net/types">
    <d2p1:string>String</d2p1: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:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.servicestack.net/types">
    <d2p1:anyType i:nil="true" />
  </ProviderOAuthAccess>
  <Meta xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.servicestack.net/types">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value>String</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </Meta>
  <Audiences xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.servicestack.net/types">
    <d2p1:string>String</d2p1:string>
  </Audiences>
  <Scopes xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.servicestack.net/types">
    <d2p1:string>String</d2p1: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>
  <AppAdmConnectionString>String</AppAdmConnectionString>
  <BaseURL>String</BaseURL>
  <CacheKeyAdm>String</CacheKeyAdm>
  <DocumentoUsuario>String</DocumentoUsuario>
  <IDEmpresa>0</IDEmpresa>
  <IDEmpresaProd>String</IDEmpresaProd>
  <IDModulo>String</IDModulo>
  <IDSistema>0</IDSistema>
  <IDUsuario>String</IDUsuario>
  <MensajeError>String</MensajeError>
  <MotorAppAdm>POSTGRESQL</MotorAppAdm>
  <MotorProd>POSTGRESQL</MotorProd>
  <Password>String</Password>
  <ProdConnectionString>String</ProdConnectionString>
  <SessionDB>false</SessionDB>
  <Subsistema>String</Subsistema>
  <TipoValidaAuth>String</TipoValidaAuth>
  <TokenExt>String</TokenExt>
  <UsaServAux>String</UsaServAux>
  <app_adm>String</app_adm>
  <imei>String</imei>
</CustomUserSession>