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
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class UserAuthDetailAddResponse:
    user_auth_id: int = 0
    provider: Optional[str] = None
    user_id: Optional[str] = None
    user_name: Optional[str] = None
    full_name: Optional[str] = None
    display_name: Optional[str] = None
    first_name: Optional[str] = None
    last_name: Optional[str] = None
    company: Optional[str] = None
    email: Optional[str] = None
    phone_number: Optional[str] = None
    birth_date: Optional[datetime.datetime] = None
    birth_date_raw: Optional[str] = None
    address: Optional[str] = None
    address2: Optional[str] = None
    city: Optional[str] = None
    state: Optional[str] = None
    country: Optional[str] = None
    culture: Optional[str] = None
    gender: Optional[str] = None
    language: Optional[str] = None
    mail_address: Optional[str] = None
    nick_name: Optional[str] = None
    postal_code: Optional[str] = None
    time_zone: Optional[str] = None
    refresh_token: Optional[str] = None
    refresh_token_expiry: Optional[datetime.datetime] = None
    request_token: Optional[str] = None
    request_token_secret: Optional[str] = None
    items: Optional[str] = None
    access_token: Optional[str] = None
    access_token_secret: Optional[str] = None
    created_date: datetime.datetime = datetime.datetime(1, 1, 1)
    modified_date: datetime.datetime = datetime.datetime(1, 1, 1)
    ref_id: Optional[int] = None
    ref_id_str: Optional[str] = None
    meta: Optional[str] = None
    response_status: Optional[ResponseStatus] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class UserAuthDetailAdd:
    # @Validate(Validator="NotNull")
    user_auth_id: int = 0

    provider: Optional[str] = None
    user_id: Optional[str] = None
    user_name: Optional[str] = None
    full_name: Optional[str] = None
    display_name: Optional[str] = None
    first_name: Optional[str] = None
    last_name: Optional[str] = None
    company: Optional[str] = None
    email: Optional[str] = None
    phone_number: Optional[str] = None
    birth_date: Optional[datetime.datetime] = None
    birth_date_raw: Optional[str] = None
    address: Optional[str] = None
    address2: Optional[str] = None
    city: Optional[str] = None
    state: Optional[str] = None
    country: Optional[str] = None
    culture: Optional[str] = None
    gender: Optional[str] = None
    language: Optional[str] = None
    mail_address: Optional[str] = None
    nick_name: Optional[str] = None
    postal_code: Optional[str] = None
    time_zone: Optional[str] = None
    refresh_token: Optional[str] = None
    refresh_token_expiry: Optional[datetime.datetime] = None
    request_token: Optional[str] = None
    request_token_secret: Optional[str] = None
    items: Optional[str] = None
    access_token: Optional[str] = None
    access_token_secret: Optional[str] = None
    # @Validate(Validator="NotNull")
    created_date: datetime.datetime = datetime.datetime(1, 1, 1)

    # @Validate(Validator="NotNull")
    modified_date: datetime.datetime = datetime.datetime(1, 1, 1)

    ref_id: Optional[int] = None
    ref_id_str: Optional[str] = None
    meta: Optional[str] = None

Python 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>