digitaluapi

<back to all web services

ConfigurationsAdd

Requires Authentication
Requires any of the roles:Client, Admin, Partner
The following routes are available for this service:
POST/configurations
ConfigurationsAdd Parameters:
NameParameterData TypeRequiredDescription
IdbodylongYes
TenantsIdbodyintYes
NamebodystringYes
DescriptionbodystringYes
AvatarsIdbodylongYes
MessageTonesIdbodyintYes
StatusCodesIdbodylongYes
ConfigurationsAddResponse Parameters:
NameParameterData TypeRequiredDescription
IdformlongNo
TenantsIdformintNo
NameformstringNo
DescriptionformstringNo
AvatarsIdformlongNo
MessageTonesIdformintNo
StatusCodesIdformlongNo
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 /configurations HTTP/1.1 
Host: duengageapi.uat.scadsoftware.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	Id: 0,
	TenantsId: 0,
	Name: String,
	Description: String,
	AvatarsId: 0,
	MessageTonesId: 0,
	StatusCodesId: 0
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Id: 0,
	TenantsId: 0,
	Name: String,
	Description: String,
	AvatarsId: 0,
	MessageTonesId: 0,
	StatusCodesId: 0,
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}