Viviot.Api

<back to all web services

ProblemReport

Requires Authentication
Requires any of the roles:Admin, TenantAdmin, MarketplaceAdmin, ServiceProblemReporter
The following routes are available for this service:
PUT/service/{ServiceId}/problemReport a problem while using a smartspace within a service.
ProblemReport Parameters:
NameParameterData TypeRequiredDescription
ServiceIdpathstringYesService Id (GUID)
ThingIdbodystringYesThing/smartspace ID (GUID)
ProblembodystringYesProblem report (free text)
BaseRequest Parameters:
NameParameterData TypeRequiredDescription
VersionformintegerNoApi version
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.

PUT /service/{ServiceId}/problem HTTP/1.1 
Host: api.4spaces.io 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	serviceId: 00000000000000000000000000000000,
	thingId: 00000000000000000000000000000000,
	problem: String,
	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
		}
	}
}