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
CustomersAdd Parameters:
NameParameterData TypeRequiredDescription
TenantsIdbodyintYes
UserAuthIdbodyint?No
SegmentsIdbodylongYes
CompaniesIdbodylong?No
CurrenciesIdbodyint?No
AddressbodystringNo
Agebodyint?No
CitybodystringNo
ContactNumberbodystringNo
EmailbodystringNo
EthnicGroupbodystringNo
FirstNamebodystringNo
GenderbodystringNo
HomeLanguagebodystringNo
IdNumberbodystringNo
LastNamebodystringNo
PostalCodebodystringNo
RegionbodystringNo
SuburbbodystringNo
UniqueIdentifierbodystringNo
CustomersAddResponse Parameters:
NameParameterData TypeRequiredDescription
TenantsIdformintNo
UserAuthIdformint?No
SegmentsIdformlongNo
CompaniesIdformlong?No
CurrenciesIdformint?No
AddressformstringNo
Ageformint?No
CityformstringNo
ContactNumberformstringNo
EmailformstringNo
EthnicGroupformstringNo
FirstNameformstringNo
GenderformstringNo
HomeLanguageformstringNo
IdNumberformstringNo
LastNameformstringNo
PostalCodeformstringNo
RegionformstringNo
SuburbformstringNo
UniqueIdentifierformstringNo
ResponseStatusformResponseStatusNo

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