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
Imports System
Imports System.IO
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports digitaluapi.ServiceModel

Namespace Global

    Namespace digitaluapi.ServiceModel

        <DataContract>
        Public Partial Class UserAuthDetailAdd
            <DataMember(Order:=2)>
            <Validate(Validator:="NotNull")>
            Public Overridable Property UserAuthId As Integer

            <DataMember(Order:=3)>
            Public Overridable Property Provider As String

            <DataMember(Order:=4)>
            Public Overridable Property UserId As String

            <DataMember(Order:=5)>
            Public Overridable Property UserName As String

            <DataMember(Order:=6)>
            Public Overridable Property FullName As String

            <DataMember(Order:=7)>
            Public Overridable Property DisplayName As String

            <DataMember(Order:=8)>
            Public Overridable Property FirstName As String

            <DataMember(Order:=9)>
            Public Overridable Property LastName As String

            <DataMember(Order:=10)>
            Public Overridable Property Company As String

            <DataMember(Order:=11)>
            Public Overridable Property Email As String

            <DataMember(Order:=12)>
            Public Overridable Property PhoneNumber As String

            <DataMember(Order:=13)>
            Public Overridable Property BirthDate As DateTimeOffset?

            <DataMember(Order:=14)>
            Public Overridable Property BirthDateRaw As String

            <DataMember(Order:=15)>
            Public Overridable Property Address As String

            <DataMember(Order:=16)>
            Public Overridable Property Address2 As String

            <DataMember(Order:=17)>
            Public Overridable Property City As String

            <DataMember(Order:=18)>
            Public Overridable Property State As String

            <DataMember(Order:=19)>
            Public Overridable Property Country As String

            <DataMember(Order:=20)>
            Public Overridable Property Culture As String

            <DataMember(Order:=21)>
            Public Overridable Property Gender As String

            <DataMember(Order:=22)>
            Public Overridable Property Language As String

            <DataMember(Order:=23)>
            Public Overridable Property MailAddress As String

            <DataMember(Order:=24)>
            Public Overridable Property NickName As String

            <DataMember(Order:=25)>
            Public Overridable Property PostalCode As String

            <DataMember(Order:=26)>
            Public Overridable Property TimeZone As String

            <DataMember(Order:=27)>
            Public Overridable Property RefreshToken As String

            <DataMember(Order:=28)>
            Public Overridable Property RefreshTokenExpiry As DateTimeOffset?

            <DataMember(Order:=29)>
            Public Overridable Property RequestToken As String

            <DataMember(Order:=30)>
            Public Overridable Property RequestTokenSecret As String

            <DataMember(Order:=31)>
            Public Overridable Property Items As String

            <DataMember(Order:=32)>
            Public Overridable Property AccessToken As String

            <DataMember(Order:=33)>
            Public Overridable Property AccessTokenSecret As String

            <DataMember(Order:=34)>
            <Validate(Validator:="NotNull")>
            Public Overridable Property CreatedDate As DateTimeOffset

            <DataMember(Order:=35)>
            <Validate(Validator:="NotNull")>
            Public Overridable Property ModifiedDate As DateTimeOffset

            <DataMember(Order:=36)>
            Public Overridable Property RefId As Integer?

            <DataMember(Order:=37)>
            Public Overridable Property RefIdStr As String

            <DataMember(Order:=38)>
            Public Overridable Property Meta As String
        End Class

        Public Partial Class UserAuthDetailAddResponse
            <DataMember(Order:=2)>
            Public Overridable Property UserAuthId As Integer

            <DataMember(Order:=3)>
            Public Overridable Property Provider As String

            <DataMember(Order:=4)>
            Public Overridable Property UserId As String

            <DataMember(Order:=5)>
            Public Overridable Property UserName As String

            <DataMember(Order:=6)>
            Public Overridable Property FullName As String

            <DataMember(Order:=7)>
            Public Overridable Property DisplayName As String

            <DataMember(Order:=8)>
            Public Overridable Property FirstName As String

            <DataMember(Order:=9)>
            Public Overridable Property LastName As String

            <DataMember(Order:=10)>
            Public Overridable Property Company As String

            <DataMember(Order:=11)>
            Public Overridable Property Email As String

            <DataMember(Order:=12)>
            Public Overridable Property PhoneNumber As String

            <DataMember(Order:=13)>
            Public Overridable Property BirthDate As DateTimeOffset?

            <DataMember(Order:=14)>
            Public Overridable Property BirthDateRaw As String

            <DataMember(Order:=15)>
            Public Overridable Property Address As String

            <DataMember(Order:=16)>
            Public Overridable Property Address2 As String

            <DataMember(Order:=17)>
            Public Overridable Property City As String

            <DataMember(Order:=18)>
            Public Overridable Property State As String

            <DataMember(Order:=19)>
            Public Overridable Property Country As String

            <DataMember(Order:=20)>
            Public Overridable Property Culture As String

            <DataMember(Order:=21)>
            Public Overridable Property Gender As String

            <DataMember(Order:=22)>
            Public Overridable Property Language As String

            <DataMember(Order:=23)>
            Public Overridable Property MailAddress As String

            <DataMember(Order:=24)>
            Public Overridable Property NickName As String

            <DataMember(Order:=25)>
            Public Overridable Property PostalCode As String

            <DataMember(Order:=26)>
            Public Overridable Property TimeZone As String

            <DataMember(Order:=27)>
            Public Overridable Property RefreshToken As String

            <DataMember(Order:=28)>
            Public Overridable Property RefreshTokenExpiry As DateTimeOffset?

            <DataMember(Order:=29)>
            Public Overridable Property RequestToken As String

            <DataMember(Order:=30)>
            Public Overridable Property RequestTokenSecret As String

            <DataMember(Order:=31)>
            Public Overridable Property Items As String

            <DataMember(Order:=32)>
            Public Overridable Property AccessToken As String

            <DataMember(Order:=33)>
            Public Overridable Property AccessTokenSecret As String

            <DataMember(Order:=34)>
            Public Overridable Property CreatedDate As DateTimeOffset

            <DataMember(Order:=35)>
            Public Overridable Property ModifiedDate As DateTimeOffset

            <DataMember(Order:=36)>
            Public Overridable Property RefId As Integer?

            <DataMember(Order:=37)>
            Public Overridable Property RefIdStr As String

            <DataMember(Order:=38)>
            Public Overridable Property Meta As String

            <DataMember(Order:=40)>
            Public Overridable Property ResponseStatus As ResponseStatus
        End Class
    End Namespace
End Namespace

VB.NET 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>