sfgboxapi

<back to all web services

UsersIntendedAdd

The following routes are available for this service:
POST/users_intended
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 UsersIntendedAdd
            <DataMember(Order:=2)>
            Public Overridable Property FirstName As String

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

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

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

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

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

            <DataMember(Order:=8)>
            Public Overridable Property UsersDetailsId As Nullable(Of Long)
        End Class

        Public Partial Class UsersIntendedAddResponse
            <DataMember(Order:=2)>
            Public Overridable Property FirstName As String

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

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

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

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

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

            <DataMember(Order:=8)>
            Public Overridable Property UsersDetailsId As Nullable(Of Long)

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

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

<UsersIntendedAdd xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/sfgboxapi.ServiceModel">
  <FirstName>String</FirstName>
  <LastName>String</LastName>
  <IdentificationNumber>String</IdentificationNumber>
  <PhoneNumber>String</PhoneNumber>
  <Latitude>0</Latitude>
  <Longitude>0</Longitude>
  <UsersDetailsId>0</UsersDetailsId>
</UsersIntendedAdd>

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

<UsersIntendedAddResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/sfgboxapi.ServiceModel">
  <FirstName>String</FirstName>
  <IdentificationNumber>String</IdentificationNumber>
  <LastName>String</LastName>
  <Latitude>0</Latitude>
  <Longitude>0</Longitude>
  <PhoneNumber>String</PhoneNumber>
  <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>
  <UsersDetailsId>0</UsersDetailsId>
</UsersIntendedAddResponse>