Viviot.Api

<back to all web services

ReportTaskListIssue

Requires Authentication
The following routes are available for this service:
POST/mobileb/tasklist/issueReports an issue in relation to a tasklist.
ReportTaskListIssue Parameters:
NameParameterData TypeRequiredDescription
IssueDescriptionbodystringYesA description of the issue.
IssueTypebodyIssueTypeYesThe type of the issue.

Allowable Values

  • DamagedItem
  • SpilledLiquid
  • MissingItem
CommonBaseTaskList Parameters:
NameParameterData TypeRequiredDescription
TaskListIdformstringYesTaskList ID
BaseRequest Parameters:
NameParameterData TypeRequiredDescription
VersionformintegerNoApi version
IssueType Enum:
NameValue
DamagedItem10
SpilledLiquid20
MissingItem30
BaseResponse Parameters:
NameParameterData TypeRequiredDescription
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 /mobileb/tasklist/issue HTTP/1.1 
Host: api.4spaces.io 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	issueDescription: String,
	issueType: 10,
	taskListId: 00000000000000000000000000000000,
	version: 0
}
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
		}
	}
}