sfgboxapi

<back to all web services

UsersDetailsAdd

Requires Authentication
The following routes are available for this service:
POST/users_details
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports sfgboxapi.ServiceModel

Namespace Global

    Namespace sfgboxapi.ServiceModel

        <DataContract>
        Public Partial Class UsersDetailsAdd
            <DataMember(Order:=2)>
            <Validate(Validator:="NotNull")>
            Public Overridable Property AppUserId As Long

            <DataMember(Order:=3)>
            <Validate(Validator:="NotNull")>
            Public Overridable Property Approved As Boolean

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

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

            <DataMember(Order:=6)>
            <Validate(Validator:="NotNull")>
            Public Overridable Property Address As String

            <DataMember(Order:=7)>
            <Validate(Validator:="NotNull")>
            Public Overridable Property Latitude As Double

            <DataMember(Order:=8)>
            <Validate(Validator:="NotNull")>
            Public Overridable Property Longitude As Double

            <DataMember(Order:=9)>
            <Validate(Validator:="NotNull")>
            Public Overridable Property Age As Integer

            <DataMember(Order:=10)>
            <Validate(Validator:="NotNull")>
            Public Overridable Property EthnicGroup As String

            <DataMember(Order:=11)>
            <Validate(Validator:="NotNull")>
            Public Overridable Property Gender As String

            <DataMember(Order:=12)>
            <Validate(Validator:="NotNull")>
            Public Overridable Property IsDisabled As Boolean

            <DataMember(Order:=13)>
            Public Overridable Property DocumentUrl As String

            <DataMember(Order:=14)>
            Public Overridable Property ApplicationDate As Date

            <DataMember(Order:=15)>
            Public Overridable Property ApprovalDate As Date
        End Class

        Public Partial Class UsersDetailsAddResponse
            <DataMember(Order:=2)>
            Public Overridable Property AppUserId As Long

            <DataMember(Order:=3)>
            Public Overridable Property Approved As Boolean

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

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

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

            <DataMember(Order:=7)>
            Public Overridable Property Latitude As Double

            <DataMember(Order:=8)>
            Public Overridable Property Longitude As Double

            <DataMember(Order:=9)>
            Public Overridable Property Age As Integer

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

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

            <DataMember(Order:=12)>
            Public Overridable Property IsDisabled As Boolean

            <DataMember(Order:=13)>
            Public Overridable Property DocumentUrl As String

            <DataMember(Order:=14)>
            Public Overridable Property ApplicationDate As Date

            <DataMember(Order:=15)>
            Public Overridable Property ApprovalDate As Date

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

VB.NET UsersDetailsAdd 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 /users_details HTTP/1.1 
Host: sfgboxapi.dev.scadsoftware.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<UsersDetailsAdd xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/sfgboxapi.ServiceModel">
  <AppUserId>0</AppUserId>
  <Approved>false</Approved>
  <IdentificationNumber>String</IdentificationNumber>
  <PassportNumber>String</PassportNumber>
  <Address>String</Address>
  <Latitude>0</Latitude>
  <Longitude>0</Longitude>
  <Age>0</Age>
  <EthnicGroup>String</EthnicGroup>
  <Gender>String</Gender>
  <IsDisabled>false</IsDisabled>
  <DocumentUrl>String</DocumentUrl>
  <ApplicationDate>0001-01-01T00:00:00</ApplicationDate>
  <ApprovalDate>0001-01-01T00:00:00</ApprovalDate>
</UsersDetailsAdd>

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

<UsersDetailsAddResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/sfgboxapi.ServiceModel">
  <Address>String</Address>
  <Age>0</Age>
  <AppUserId>0</AppUserId>
  <ApplicationDate>0001-01-01T00:00:00</ApplicationDate>
  <ApprovalDate>0001-01-01T00:00:00</ApprovalDate>
  <Approved>false</Approved>
  <DocumentUrl>String</DocumentUrl>
  <EthnicGroup>String</EthnicGroup>
  <Gender>String</Gender>
  <IdentificationNumber>String</IdentificationNumber>
  <IsDisabled>false</IsDisabled>
  <Latitude>0</Latitude>
  <Longitude>0</Longitude>
  <PassportNumber>String</PassportNumber>
  <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>
</UsersDetailsAddResponse>