digitaluapi

<back to all web services

ErrorMessagesAdd

Requires Authentication
Requires any of the roles:Client, Admin, Partner
The following routes are available for this service:
POST/error_messages
ErrorMessagesAdd Parameters:
NameParameterData TypeRequiredDescription
FunctionNamebodystringYes
ErrorMessagebodystringYes
DatebodyDateTimeOffsetYes
ErrorMessagesAddResponse Parameters:
NameParameterData TypeRequiredDescription
FunctionNameformstringNo
ErrorMessageformstringNo
DateformDateTimeOffsetNo
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 /error_messages HTTP/1.1 
Host: duengageapi.uat.scadsoftware.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	FunctionName: String,
	ErrorMessage: String,
	Date: 0001-01-01T00:00:00.0000000+00:00
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	FunctionName: String,
	ErrorMessage: String,
	Date: 0001-01-01T00:00:00.0000000+00:00,
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}