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
import Foundation
import ServiceStack

// @DataContract
public class CustomersAdd : Codable
{
    // @DataMember(Order=2)
    // @Validate(Validator="NotNull")
    public var tenantsId:Int

    // @DataMember(Order=3)
    public var userAuthId:Int?

    // @DataMember(Order=4)
    // @Validate(Validator="NotNull")
    public var segmentsId:Int

    // @DataMember(Order=5)
    public var companiesId:Int?

    // @DataMember(Order=6)
    public var currenciesId:Int?

    // @DataMember(Order=7)
    public var address:String

    // @DataMember(Order=8)
    public var age:Int?

    // @DataMember(Order=9)
    public var city:String

    // @DataMember(Order=10)
    public var contactNumber:String

    // @DataMember(Order=11)
    public var email:String

    // @DataMember(Order=12)
    public var ethnicGroup:String

    // @DataMember(Order=13)
    public var firstName:String

    // @DataMember(Order=14)
    public var gender:String

    // @DataMember(Order=15)
    public var homeLanguage:String

    // @DataMember(Order=16)
    public var idNumber:String

    // @DataMember(Order=17)
    public var lastName:String

    // @DataMember(Order=18)
    public var postalCode:String

    // @DataMember(Order=19)
    public var region:String

    // @DataMember(Order=20)
    public var suburb:String

    // @DataMember(Order=21)
    public var uniqueIdentifier:String

    required public init(){}
}

public class CustomersAddResponse : Codable
{
    // @DataMember(Order=2)
    public var tenantsId:Int

    // @DataMember(Order=3)
    public var userAuthId:Int?

    // @DataMember(Order=4)
    public var segmentsId:Int

    // @DataMember(Order=5)
    public var companiesId:Int?

    // @DataMember(Order=6)
    public var currenciesId:Int?

    // @DataMember(Order=7)
    public var address:String

    // @DataMember(Order=8)
    public var age:Int?

    // @DataMember(Order=9)
    public var city:String

    // @DataMember(Order=10)
    public var contactNumber:String

    // @DataMember(Order=11)
    public var email:String

    // @DataMember(Order=12)
    public var ethnicGroup:String

    // @DataMember(Order=13)
    public var firstName:String

    // @DataMember(Order=14)
    public var gender:String

    // @DataMember(Order=15)
    public var homeLanguage:String

    // @DataMember(Order=16)
    public var idNumber:String

    // @DataMember(Order=17)
    public var lastName:String

    // @DataMember(Order=18)
    public var postalCode:String

    // @DataMember(Order=19)
    public var region:String

    // @DataMember(Order=20)
    public var suburb:String

    // @DataMember(Order=21)
    public var uniqueIdentifier:String

    // @DataMember(Order=23)
    public var responseStatus:ResponseStatus

    required public init(){}
}


Swift 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
		}
	}
}