digitaluapi

CustomersAdd

**Requires Authentication**
Requires any of the roles:	Client, Admin, Partner

The following routes are available for this service:
POST	/customers

"use strict";
export class CustomersAddResponse {
    /** @param {{TenantsId?:number,UserAuthId?:number,SegmentsId?:number,CompaniesId?:number,CurrenciesId?:number,Address?:string,Age?:number,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?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    TenantsId;
    /** @type {?number} */
    UserAuthId;
    /** @type {number} */
    SegmentsId;
    /** @type {?number} */
    CompaniesId;
    /** @type {?number} */
    CurrenciesId;
    /** @type {string} */
    Address;
    /** @type {?number} */
    Age;
    /** @type {string} */
    City;
    /** @type {string} */
    ContactNumber;
    /** @type {string} */
    Email;
    /** @type {string} */
    EthnicGroup;
    /** @type {string} */
    FirstName;
    /** @type {string} */
    Gender;
    /** @type {string} */
    HomeLanguage;
    /** @type {string} */
    IdNumber;
    /** @type {string} */
    LastName;
    /** @type {string} */
    PostalCode;
    /** @type {string} */
    Region;
    /** @type {string} */
    Suburb;
    /** @type {string} */
    UniqueIdentifier;
    /** @type {ResponseStatus} */
    ResponseStatus;
}
export class CustomersAdd {
    /** @param {{TenantsId?:number,UserAuthId?:number,SegmentsId?:number,CompaniesId?:number,CurrenciesId?:number,Address?:string,Age?:number,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}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    TenantsId;
    /** @type {?number} */
    UserAuthId;
    /** @type {number} */
    SegmentsId;
    /** @type {?number} */
    CompaniesId;
    /** @type {?number} */
    CurrenciesId;
    /** @type {string} */
    Address;
    /** @type {?number} */
    Age;
    /** @type {string} */
    City;
    /** @type {string} */
    ContactNumber;
    /** @type {string} */
    Email;
    /** @type {string} */
    EthnicGroup;
    /** @type {string} */
    FirstName;
    /** @type {string} */
    Gender;
    /** @type {string} */
    HomeLanguage;
    /** @type {string} */
    IdNumber;
    /** @type {string} */
    LastName;
    /** @type {string} */
    PostalCode;
    /** @type {string} */
    Region;
    /** @type {string} */
    Suburb;
    /** @type {string} */
    UniqueIdentifier;
}

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