digitaluapi

<back to all web services

CustomersAdd

Requires Authentication
Requires any of the roles:Client, Admin, Partner
The following routes are available for this service:
POST/customers
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 CustomersAdd
            <DataMember(Order:=2)>
            <Validate(Validator:="NotNull")>
            Public Overridable Property TenantsId As Integer

            <DataMember(Order:=3)>
            Public Overridable Property UserAuthId As Integer?

            <DataMember(Order:=4)>
            <Validate(Validator:="NotNull")>
            Public Overridable Property SegmentsId As Long

            <DataMember(Order:=5)>
            Public Overridable Property CompaniesId As Long?

            <DataMember(Order:=6)>
            Public Overridable Property CurrenciesId As Integer?

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

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

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

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

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

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

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

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

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

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

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

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

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

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

            <DataMember(Order:=21)>
            Public Overridable Property UniqueIdentifier As String
        End Class

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

            <DataMember(Order:=3)>
            Public Overridable Property UserAuthId As Integer?

            <DataMember(Order:=4)>
            Public Overridable Property SegmentsId As Long

            <DataMember(Order:=5)>
            Public Overridable Property CompaniesId As Long?

            <DataMember(Order:=6)>
            Public Overridable Property CurrenciesId As Integer?

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

VB.NET CustomersAdd DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /customers HTTP/1.1 
Host: duengageapi.uat.scadsoftware.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	TenantsId: 0,
	UserAuthId: 0,
	SegmentsId: 0,
	CompaniesId: 0,
	CurrenciesId: 0,
	Address: String,
	Age: 0,
	City: String,
	ContactNumber: String,
	Email: String,
	EthnicGroup: String,
	FirstName: String,
	Gender: String,
	HomeLanguage: String,
	IdNumber: String,
	LastName: String,
	PostalCode: String,
	Region: String,
	Suburb: String,
	UniqueIdentifier: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	TenantsId: 0,
	UserAuthId: 0,
	SegmentsId: 0,
	CompaniesId: 0,
	CurrenciesId: 0,
	Address: String,
	Age: 0,
	City: String,
	ContactNumber: String,
	Email: String,
	EthnicGroup: String,
	FirstName: String,
	Gender: String,
	HomeLanguage: String,
	IdNumber: String,
	LastName: String,
	PostalCode: String,
	Region: String,
	Suburb: String,
	UniqueIdentifier: String,
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}