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;

    // @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 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;

    // @DataMember
    public TwoFactor: string;

    // @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<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 .other suffix or ?format=other

HTTP + OTHER

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

POST /jsonl/reply/CustomUserSession HTTP/1.1 
Host: soluser-recaudo.sgsas.co 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"IDUsuario":"String","IDSistema":0,"IDEmpresaProd":"String","IDEmpresa":0,"IDModulo":"String","MotorProd":"POSTGRESQL","MotorAppAdm":"POSTGRESQL","ProdConnectionString":"String","AppAdmConnectionString":"String","CacheKeyAdm":"String","Password":"String","SessionDB":false,"MensajeError":"String","DocumentoUsuario":"String","app_adm":"String","imei":"String","BaseURL":"String","UsaServAux":"String","TipoValidaAuth":"String","TokenExt":"String","Subsistema":"String","TwoFactor":"String","ReferrerUrl":"String","Id":"String","UserAuthId":"String","UserAuthName":"String","UserName":"String","TwitterUserId":"String","TwitterScreenName":"String","FacebookUserId":"String","FacebookUserName":"String","FirstName":"String","LastName":"String","DisplayName":"String","Company":"String","Email":"String","PrimaryEmail":"String","PhoneNumber":"String","BirthDate":"0001-01-01T00:00:00.0000000","BirthDateRaw":"String","Address":"String","Address2":"String","City":"String","State":"String","Country":"String","Culture":"String","FullName":"String","Gender":"String","Language":"String","MailAddress":"String","Nickname":"String","PostalCode":"String","TimeZone":"String","RequestTokenSecret":"String","Roles":["String"],"Permissions":["String"],"IsAuthenticated":false,"FromToken":false,"ProfileUrl":"String","Sequence":"String","Tag":0,"AuthProvider":"String","ProviderOAuthAccess":[{}],"Meta":{"String":"String"},"Audiences":["String"],"Scopes":["String"],"Dns":"String","Rsa":"String","Sid":"String","Hash":"String","HomePhone":"String","MobilePhone":"String","Webpage":"String","EmailConfirmed":false,"PhoneNumberConfirmed":false,"TwoFactorEnabled":false,"SecurityStamp":"String","Type":"String","RecoveryToken":"String","RefId":0,"RefIdStr":"String"}
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"IDUsuario":"String","IDSistema":0,"IDEmpresaProd":"String","IDEmpresa":0,"IDModulo":"String","MotorProd":"POSTGRESQL","MotorAppAdm":"POSTGRESQL","ProdConnectionString":"String","AppAdmConnectionString":"String","CacheKeyAdm":"String","Password":"String","SessionDB":false,"MensajeError":"String","DocumentoUsuario":"String","app_adm":"String","imei":"String","BaseURL":"String","UsaServAux":"String","TipoValidaAuth":"String","TokenExt":"String","Subsistema":"String","TwoFactor":"String","ReferrerUrl":"String","Id":"String","UserAuthId":"String","UserAuthName":"String","UserName":"String","TwitterUserId":"String","TwitterScreenName":"String","FacebookUserId":"String","FacebookUserName":"String","FirstName":"String","LastName":"String","DisplayName":"String","Company":"String","Email":"String","PrimaryEmail":"String","PhoneNumber":"String","BirthDate":"0001-01-01T00:00:00.0000000","BirthDateRaw":"String","Address":"String","Address2":"String","City":"String","State":"String","Country":"String","Culture":"String","FullName":"String","Gender":"String","Language":"String","MailAddress":"String","Nickname":"String","PostalCode":"String","TimeZone":"String","RequestTokenSecret":"String","Roles":["String"],"Permissions":["String"],"IsAuthenticated":false,"FromToken":false,"ProfileUrl":"String","Sequence":"String","Tag":0,"AuthProvider":"String","ProviderOAuthAccess":[{}],"Meta":{"String":"String"},"Audiences":["String"],"Scopes":["String"],"Dns":"String","Rsa":"String","Sid":"String","Hash":"String","HomePhone":"String","MobilePhone":"String","Webpage":"String","EmailConfirmed":false,"PhoneNumberConfirmed":false,"TwoFactorEnabled":false,"SecurityStamp":"String","Type":"String","RecoveryToken":"String","RefId":0,"RefIdStr":"String"}