digitaluapi

<back to all web services

UserAuthDetailAdd

Requires Authentication
Requires any of the roles:Client, Admin, Partner
The following routes are available for this service:
POST/user_auth_detail

export class UserAuthDetailAddResponse
{
    // @DataMember(Order=2)
    public UserAuthId: number;

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    // @DataMember(Order=35)
    public ModifiedDate: string;

    // @DataMember(Order=36)
    public RefId?: number;

    // @DataMember(Order=37)
    public RefIdStr: string;

    // @DataMember(Order=38)
    public Meta: string;

    // @DataMember(Order=40)
    public ResponseStatus: ResponseStatus;

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

// @DataContract
export class UserAuthDetailAdd
{
    // @DataMember(Order=2)
    // @Validate(Validator="NotNull")
    public UserAuthId: number;

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    // @DataMember(Order=34)
    // @Validate(Validator="NotNull")
    public CreatedDate: string;

    // @DataMember(Order=35)
    // @Validate(Validator="NotNull")
    public ModifiedDate: string;

    // @DataMember(Order=36)
    public RefId?: number;

    // @DataMember(Order=37)
    public RefIdStr: string;

    // @DataMember(Order=38)
    public Meta: string;

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

TypeScript UserAuthDetailAdd 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 /user_auth_detail HTTP/1.1 
Host: duengageapi.uat.scadsoftware.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<UserAuthDetailAdd xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/digitaluapi.ServiceModel">
  <UserAuthId>0</UserAuthId>
  <Provider>String</Provider>
  <UserId>String</UserId>
  <UserName>String</UserName>
  <FullName>String</FullName>
  <DisplayName>String</DisplayName>
  <FirstName>String</FirstName>
  <LastName>String</LastName>
  <Company>String</Company>
  <Email>String</Email>
  <PhoneNumber>String</PhoneNumber>
  <BirthDate xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:DateTime>0001-01-01T00:00:00Z</d2p1:DateTime>
    <d2p1:OffsetMinutes>0</d2p1:OffsetMinutes>
  </BirthDate>
  <BirthDateRaw>String</BirthDateRaw>
  <Address>String</Address>
  <Address2>String</Address2>
  <City>String</City>
  <State>String</State>
  <Country>String</Country>
  <Culture>String</Culture>
  <Gender>String</Gender>
  <Language>String</Language>
  <MailAddress>String</MailAddress>
  <NickName>String</NickName>
  <PostalCode>String</PostalCode>
  <TimeZone>String</TimeZone>
  <RefreshToken>String</RefreshToken>
  <RefreshTokenExpiry xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:DateTime>0001-01-01T00:00:00Z</d2p1:DateTime>
    <d2p1:OffsetMinutes>0</d2p1:OffsetMinutes>
  </RefreshTokenExpiry>
  <RequestToken>String</RequestToken>
  <RequestTokenSecret>String</RequestTokenSecret>
  <Items>String</Items>
  <AccessToken>String</AccessToken>
  <AccessTokenSecret>String</AccessTokenSecret>
  <CreatedDate xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:DateTime>0001-01-01T00:00:00Z</d2p1:DateTime>
    <d2p1:OffsetMinutes>0</d2p1:OffsetMinutes>
  </CreatedDate>
  <ModifiedDate xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:DateTime>0001-01-01T00:00:00Z</d2p1:DateTime>
    <d2p1:OffsetMinutes>0</d2p1:OffsetMinutes>
  </ModifiedDate>
  <RefId>0</RefId>
  <RefIdStr>String</RefIdStr>
  <Meta>String</Meta>
</UserAuthDetailAdd>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<UserAuthDetailAddResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/digitaluapi.ServiceModel">
  <AccessToken>String</AccessToken>
  <AccessTokenSecret>String</AccessTokenSecret>
  <Address>String</Address>
  <Address2>String</Address2>
  <BirthDate xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:DateTime>0001-01-01T00:00:00Z</d2p1:DateTime>
    <d2p1:OffsetMinutes>0</d2p1:OffsetMinutes>
  </BirthDate>
  <BirthDateRaw>String</BirthDateRaw>
  <City>String</City>
  <Company>String</Company>
  <Country>String</Country>
  <CreatedDate xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:DateTime>0001-01-01T00:00:00Z</d2p1:DateTime>
    <d2p1:OffsetMinutes>0</d2p1:OffsetMinutes>
  </CreatedDate>
  <Culture>String</Culture>
  <DisplayName>String</DisplayName>
  <Email>String</Email>
  <FirstName>String</FirstName>
  <FullName>String</FullName>
  <Gender>String</Gender>
  <Items>String</Items>
  <Language>String</Language>
  <LastName>String</LastName>
  <MailAddress>String</MailAddress>
  <Meta>String</Meta>
  <ModifiedDate xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:DateTime>0001-01-01T00:00:00Z</d2p1:DateTime>
    <d2p1:OffsetMinutes>0</d2p1:OffsetMinutes>
  </ModifiedDate>
  <NickName>String</NickName>
  <PhoneNumber>String</PhoneNumber>
  <PostalCode>String</PostalCode>
  <Provider>String</Provider>
  <RefId>0</RefId>
  <RefIdStr>String</RefIdStr>
  <RefreshToken>String</RefreshToken>
  <RefreshTokenExpiry xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:DateTime>0001-01-01T00:00:00Z</d2p1:DateTime>
    <d2p1:OffsetMinutes>0</d2p1:OffsetMinutes>
  </RefreshTokenExpiry>
  <RequestToken>String</RequestToken>
  <RequestTokenSecret>String</RequestTokenSecret>
  <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>
  <State>String</State>
  <TimeZone>String</TimeZone>
  <UserAuthId>0</UserAuthId>
  <UserId>String</UserId>
  <UserName>String</UserName>
</UserAuthDetailAddResponse>