Trendsic Platform Service

<back to all web services

GetInspectionReport

Requires Authentication
The following routes are available for this service:
GET,OPTIONS/v1/InspectionReport/{AgentUID}/{ContactUID}/
GetInspectionReport Parameters:
NameParameterData TypeRequiredDescription
AgentUIDpathGuidNo
ContactUIDpathGuidNo
InspectionReportUIDqueryGuidNo
GetInspectionReportResponse Parameters:
NameParameterData TypeRequiredDescription
ResultformList<InspectionReport>No
ResponseStatusformResponseStatusNo
InspectionReport Parameters:
NameParameterData TypeRequiredDescription
AgentUIDformGuidNo
ContactUIDformGuidNo
InspectionReportUIDformGuidNo
TradeNameformstringNo
BusinessPhoneformstringNo
StreetAddressformstringNo
ZipCodeformstringNo
OwnersNameformstringNo
ComplianceStatusformbyteNo
IsBusinessClassABeerformboolNo
IsBusinessClassBBeerformboolNo
IsBusinessClassALiquorformboolNo
IsBusinessClassBLiquorformboolNo
IsBusinessClassDformboolNo
IsBusinessClassMformboolNo
IsBusinessClassPformboolNo
IsBusinessClassRformboolNo
IsBusinessClassRAHformboolNo
ClassBeerAccountNumformstringNo
ClassBeerStateNumformstringNo
ClassLiquorAccountNumformstringNo
ClassLiquorStateNumformstringNo
LicensedEmployeesformList<Employee>No
AgentNameformstringNo
ManagerSignatureformObjectNo
ManagerNameformstringNo
ManagerPhoneformstringNo
InspectionDateformDateTimeNo
Employee Parameters:
NameParameterData TypeRequiredDescription
FirstNameformstringNo
MiddleNameformstringNo
LastNameformstringNo

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.

GET /v1/InspectionReport/{AgentUID}/{ContactUID}/ HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Result: 
	[
		{
			AgentUID: 00000000000000000000000000000000,
			ContactUID: 00000000000000000000000000000000,
			InspectionReportUID: 00000000000000000000000000000000,
			TradeName: String,
			BusinessPhone: String,
			StreetAddress: String,
			ZipCode: String,
			OwnersName: String,
			ComplianceStatus: 0,
			IsBusinessClassABeer: False,
			IsBusinessClassBBeer: False,
			IsBusinessClassALiquor: False,
			IsBusinessClassBLiquor: False,
			IsBusinessClassD: False,
			IsBusinessClassM: False,
			IsBusinessClassP: False,
			IsBusinessClassR: False,
			IsBusinessClassRAH: False,
			ClassBeerAccountNum: String,
			ClassBeerStateNum: String,
			ClassLiquorAccountNum: String,
			ClassLiquorStateNum: String,
			LicensedEmployees: 
			[
				{
					FirstName: String,
					MiddleName: String,
					LastName: String
				}
			],
			AgentName: String,
			ManagerSignature: {},
			ManagerName: String,
			ManagerPhone: String,
			InspectionDate: 0001-01-01
		}
	],
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}