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
namespace digitaluapi.ServiceModel

open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type CustomersAddResponse() = 
        [<DataMember(Order=2)>]
        member val TenantsId:Int32 = new Int32() with get,set

        [<DataMember(Order=3)>]
        member val UserAuthId:Nullable<Int32> = new Nullable<Int32>() with get,set

        [<DataMember(Order=4)>]
        member val SegmentsId:Int64 = new Int64() with get,set

        [<DataMember(Order=5)>]
        member val CompaniesId:Nullable<Int64> = new Nullable<Int64>() with get,set

        [<DataMember(Order=6)>]
        member val CurrenciesId:Nullable<Int32> = new Nullable<Int32>() with get,set

        [<DataMember(Order=7)>]
        member val Address:String = null with get,set

        [<DataMember(Order=8)>]
        member val Age:Nullable<Int32> = new Nullable<Int32>() with get,set

        [<DataMember(Order=9)>]
        member val City:String = null with get,set

        [<DataMember(Order=10)>]
        member val ContactNumber:String = null with get,set

        [<DataMember(Order=11)>]
        member val Email:String = null with get,set

        [<DataMember(Order=12)>]
        member val EthnicGroup:String = null with get,set

        [<DataMember(Order=13)>]
        member val FirstName:String = null with get,set

        [<DataMember(Order=14)>]
        member val Gender:String = null with get,set

        [<DataMember(Order=15)>]
        member val HomeLanguage:String = null with get,set

        [<DataMember(Order=16)>]
        member val IdNumber:String = null with get,set

        [<DataMember(Order=17)>]
        member val LastName:String = null with get,set

        [<DataMember(Order=18)>]
        member val PostalCode:String = null with get,set

        [<DataMember(Order=19)>]
        member val Region:String = null with get,set

        [<DataMember(Order=20)>]
        member val Suburb:String = null with get,set

        [<DataMember(Order=21)>]
        member val UniqueIdentifier:String = null with get,set

        [<DataMember(Order=23)>]
        member val ResponseStatus:ResponseStatus = null with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type CustomersAdd() = 
        [<DataMember(Order=2)>]
        [<Validate(Validator="NotNull")>]
        member val TenantsId:Int32 = new Int32() with get,set

        [<DataMember(Order=3)>]
        member val UserAuthId:Nullable<Int32> = new Nullable<Int32>() with get,set

        [<DataMember(Order=4)>]
        [<Validate(Validator="NotNull")>]
        member val SegmentsId:Int64 = new Int64() with get,set

        [<DataMember(Order=5)>]
        member val CompaniesId:Nullable<Int64> = new Nullable<Int64>() with get,set

        [<DataMember(Order=6)>]
        member val CurrenciesId:Nullable<Int32> = new Nullable<Int32>() with get,set

        [<DataMember(Order=7)>]
        member val Address:String = null with get,set

        [<DataMember(Order=8)>]
        member val Age:Nullable<Int32> = new Nullable<Int32>() with get,set

        [<DataMember(Order=9)>]
        member val City:String = null with get,set

        [<DataMember(Order=10)>]
        member val ContactNumber:String = null with get,set

        [<DataMember(Order=11)>]
        member val Email:String = null with get,set

        [<DataMember(Order=12)>]
        member val EthnicGroup:String = null with get,set

        [<DataMember(Order=13)>]
        member val FirstName:String = null with get,set

        [<DataMember(Order=14)>]
        member val Gender:String = null with get,set

        [<DataMember(Order=15)>]
        member val HomeLanguage:String = null with get,set

        [<DataMember(Order=16)>]
        member val IdNumber:String = null with get,set

        [<DataMember(Order=17)>]
        member val LastName:String = null with get,set

        [<DataMember(Order=18)>]
        member val PostalCode:String = null with get,set

        [<DataMember(Order=19)>]
        member val Region:String = null with get,set

        [<DataMember(Order=20)>]
        member val Suburb:String = null with get,set

        [<DataMember(Order=21)>]
        member val UniqueIdentifier:String = null with get,set

F# 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
		}
	}
}