Billiecart API

<back to all web services

StoreAuditRequest

Requires Authentication
Required role:service
The following routes are available for this service:
POST/audits/store
StoreAuditRequest Parameters:
NameParameterData TypeRequiredDescription
MessagebodystringNo
StoreAuditResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
IsStoredformboolNo
StoreAuditResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
IsStoredformboolNo

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 /audits/store HTTP/1.1 
Host: staging-api.billiecart.com.au 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	message: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	},
	isStored: False
}