digitaluapi

<back to all web services

UserAuthDetailEdit

Requires Authentication
Requires any of the roles:Client, Admin, Partner
The following routes are available for this service:
PUT/user_auth_detail/{Id}
import Foundation
import ServiceStack

// @DataContract
public class UserAuthDetailEdit : Codable
{
    // @DataMember(Order=1)
    // @Validate(Validator="NotNull")
    public var id:Int

    // @DataMember(Order=2)
    // @Validate(Validator="NotNull")
    public var userAuthId:Int

    // @DataMember(Order=3)
    public var provider:String

    // @DataMember(Order=4)
    public var userId:String

    // @DataMember(Order=5)
    public var userName:String

    // @DataMember(Order=6)
    public var fullName:String

    // @DataMember(Order=7)
    public var displayName:String

    // @DataMember(Order=8)
    public var firstName:String

    // @DataMember(Order=9)
    public var lastName:String

    // @DataMember(Order=10)
    public var company:String

    // @DataMember(Order=11)
    public var email:String

    // @DataMember(Order=12)
    public var phoneNumber:String

    // @DataMember(Order=13)
    public var birthDate:Date?

    // @DataMember(Order=14)
    public var birthDateRaw:String

    // @DataMember(Order=15)
    public var address:String

    // @DataMember(Order=16)
    public var address2:String

    // @DataMember(Order=17)
    public var city:String

    // @DataMember(Order=18)
    public var state:String

    // @DataMember(Order=19)
    public var country:String

    // @DataMember(Order=20)
    public var culture:String

    // @DataMember(Order=21)
    public var gender:String

    // @DataMember(Order=22)
    public var language:String

    // @DataMember(Order=23)
    public var mailAddress:String

    // @DataMember(Order=24)
    public var nickName:String

    // @DataMember(Order=25)
    public var postalCode:String

    // @DataMember(Order=26)
    public var timeZone:String

    // @DataMember(Order=27)
    public var refreshToken:String

    // @DataMember(Order=28)
    public var refreshTokenExpiry:Date?

    // @DataMember(Order=29)
    public var requestToken:String

    // @DataMember(Order=30)
    public var requestTokenSecret:String

    // @DataMember(Order=31)
    public var items:String

    // @DataMember(Order=32)
    public var accessToken:String

    // @DataMember(Order=33)
    public var accessTokenSecret:String

    // @DataMember(Order=34)
    // @Validate(Validator="NotNull")
    public var createdDate:Date

    // @DataMember(Order=35)
    // @Validate(Validator="NotNull")
    public var modifiedDate:Date

    // @DataMember(Order=36)
    public var refId:Int?

    // @DataMember(Order=37)
    public var refIdStr:String

    // @DataMember(Order=38)
    public var meta:String

    required public init(){}
}

public class UserAuthDetailEditResponse : Codable
{
    // @DataMember(Order=1)
    public var id:Int

    // @DataMember(Order=2)
    public var userAuthId:Int

    // @DataMember(Order=3)
    public var provider:String

    // @DataMember(Order=4)
    public var userId:String

    // @DataMember(Order=5)
    public var userName:String

    // @DataMember(Order=6)
    public var fullName:String

    // @DataMember(Order=7)
    public var displayName:String

    // @DataMember(Order=8)
    public var firstName:String

    // @DataMember(Order=9)
    public var lastName:String

    // @DataMember(Order=10)
    public var company:String

    // @DataMember(Order=11)
    public var email:String

    // @DataMember(Order=12)
    public var phoneNumber:String

    // @DataMember(Order=13)
    public var birthDate:Date?

    // @DataMember(Order=14)
    public var birthDateRaw:String

    // @DataMember(Order=15)
    public var address:String

    // @DataMember(Order=16)
    public var address2:String

    // @DataMember(Order=17)
    public var city:String

    // @DataMember(Order=18)
    public var state:String

    // @DataMember(Order=19)
    public var country:String

    // @DataMember(Order=20)
    public var culture:String

    // @DataMember(Order=21)
    public var gender:String

    // @DataMember(Order=22)
    public var language:String

    // @DataMember(Order=23)
    public var mailAddress:String

    // @DataMember(Order=24)
    public var nickName:String

    // @DataMember(Order=25)
    public var postalCode:String

    // @DataMember(Order=26)
    public var timeZone:String

    // @DataMember(Order=27)
    public var refreshToken:String

    // @DataMember(Order=28)
    public var refreshTokenExpiry:Date?

    // @DataMember(Order=29)
    public var requestToken:String

    // @DataMember(Order=30)
    public var requestTokenSecret:String

    // @DataMember(Order=31)
    public var items:String

    // @DataMember(Order=32)
    public var accessToken:String

    // @DataMember(Order=33)
    public var accessTokenSecret:String

    // @DataMember(Order=34)
    public var createdDate:Date

    // @DataMember(Order=35)
    public var modifiedDate:Date

    // @DataMember(Order=36)
    public var refId:Int?

    // @DataMember(Order=37)
    public var refIdStr:String

    // @DataMember(Order=38)
    public var meta:String

    // @DataMember(Order=40)
    public var responseStatus:ResponseStatus

    required public init(){}
}

Swift UserAuthDetailEdit 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.

PUT /user_auth_detail/{Id} HTTP/1.1 
Host: duengageapi.uat.scadsoftware.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<UserAuthDetailEdit xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/digitaluapi.ServiceModel">
  <Id>0</Id>
  <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>
</UserAuthDetailEdit>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<UserAuthDetailEditResponse 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>
  <Id>0</Id>
  <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>
</UserAuthDetailEditResponse>