JSON REST API

Inspection object

NAME DESCRIPTION ADDITIONAL INFORMATION
inspectionId long Uniquely identifies this inspection.
userId long Id of user that created the inspection
createDate Date/time When the inspection was created on the server
modifiedDate Date/time When the inspection was modified on the server
checklistId long Id of checklist used for this inspection
nameChecklist String, max length 500 Name of the checklist used for this inspection
locationId long Id of the location for which this inspection was conducted
nameLocation String, max length 100 Name of the location where this inspection was conducted
nameInspection String, max length 100 The name of the inspection that an inspector  enters at the beginning of an inspection
inspectionDate Date/time When the inspection was started in the app or server
conclusion String, max length 5000 Conclusion of inspection
score Double, range 0 tot 10 Score of entire inspection
lockedByUserId long UserId of locking user or 0 when lock is available
lockClient Enumeration:
APP
SITE
AVAILABLE
Whether the inspection is locked in the app on the site or is available for editing
lockDate Date/time Date when current lockstate was set
section Array of Section objects See section object

 

Section Object

NAME DESCRIPTION ADDITIONAL INFORMATION
sectionId long Uniquely identifies this section.
userId long Id of user that created the inspection
createDate Date/time When the inspection was created on the server
modifiedDate Date/time When the inspection was modified on the server
inspectionId long Id of inspection that this section belongs to
title String, max length 500 Id of the location for which this inspection was conducted
item Array of item objects See item object

 

Item object

NAME DESCRIPTION ADDITIONAL INFORMATION
itemId long Uniquely identifies this item.
long
userId long Id of user that created the inspection
createDate Date/time When the inspection was created on the server
modifiedDate Date/time When the inspection was modified on the server
sectionId long Id of the section that this item belongs to
description String, max length 500 Id of the location for which this inspection was conducted
itemType String enumeration:

YES_NO

OPEN_TEXT

FORMULA

HACCP_MEASUREMENT

The type of validation that this item uses. Note: OPEN_TEXT items are never validated
validation String enumeration:

VALID

INVALID

IGNORED

BLANK

The validation result. Note: when an inspector leaves an item blank, it validates as blank. Only explicitly ignored items are validated as IGNORED
points integer The amount of points awarded to this item. Points are only awarded when an item is VALID. Note: Points from items in HACCP_MEASUREMENT are not included in the score
Remark String, max length 500 The remark text for this item
isFavorite boolean Whether this item is marked as favorite (with the star icon)
severity String enumeration:

REMARK

BLOCKING

OBSERVED

MINOR

MAJOR

CRITICAL

Only applicable for INVALID items. Note: OBSERVED,

MINOR,

MAJOR and

CRITICAL are only shown for ISO style sections

openText String, max length 5000 Only applicable when itemType is OPEN_TEXT
unit String, max length 75 Only applicable for itemType  FORMULA.
Unit of measure used in formula.
measuredValue Only applicable for itemType  FORMULA.
Contains the value the inspector has measured for this item. A formula is validated as true when the measuredValue (5) meets the operator (<)   operand (10) condition. 5 < 10 = VALID
operator String enumeration:

EQ
GT
LT
EL
EG

Only applicable for itemType  FORMULA.
EQ is “equal to operand”
GT is “greater than operand”
LT  is “lesser than operand”
EG is “equal or greater than operand”EL is “equal or lesser than operand”
operand double Only applicable for itemType  FORMULA.
Acts as the operand of the formula