Status Operational Status

EVIR Mobile API

  • Last edited on

Table of Contents

AUTHENTICATION

EXAMPLES AND URLS

USER API

ASSET API

ENTITY API QUERY STRING SYNTAX

INSPECTIONS / DEFECTS / REPAIRS

COMPONENTS

Authentication

Using the Entity APIs requires the inclusion of an Auth0 JWT access token with an audience of your target environment.

Access tokens need to be provided to the Entity APIs in the form of an Authorization header in your HTTP requests.

To obtain a token, contact your Zonar representative.

Examples and URLs

CORE API Examples User / Asset API

The user and asset api are ZONAR CORE APIS, and they use the following base

URL: https://api.zonarsystems.net/core/v1

Example:

EVIR API Example APIs

The inspection, defect and repair apis are ZONAR EVIR APIS, and they use the following base

URL: https://api.zonarsystems.net/evir/v2

Examples:

Getting Inspections

EVIR_API_Examples_GettingInspections.png

Getting Defects

EVIR_API_Examples_GettingDefects.png

Posting a Repair

EVIR_API_Examples_PostingRepairs.png

User API

Overview

User API: Entity API for managing users.

Paths

List users

GET api.zonarsystems.net/core/v1/users

Description

Retrieve a paginated list of users, filtered by search parameters.

Parameters

Type Name Description Schema Default
Query companyId
optional 		A Company ID. string  
Query credentialType
optional 		A user's credential type. enum (STANDARD, PASSWORDLESS, MANAGED)  
Query default_operator
optional 		Operator used when combining multiple search terms. enum (and, or)  
Query df
optional 		Default field to search. string  
Query email
optional 		Email address. string  
Query exactMatch
optional 		For use with identityProviderId; if True, return only the User object with that exact identityProviderId, instead of all Users associated with that person. boolean "false"
Query firstName
optional 		First name. string  
Query identityProviderId
optional 		Auth0 Id. string  
Querty lastName
optional 		Last name. string  
Query managedSource
optional 		Managed Source. string  
Querty managedSourceID
optional 		Managed Source ID. string  
Query middleName
optional 		Middle name. string  
Query page
optional		 The current page of the result set. string "1"
Query paging_token
optional 		A paging token as returned from a previous response. string  
Query per_page
optional 		The number of items per page of the result set. Valid values: 1-1000. integer 100
Query q
optional 		Search terms. More search feature documentation is in this guide. string  
Query sort
optional 		Sort order for search results. string  
Query status
optional 		User active/inactive status. enum (ACTIVE, INACTIVE, LOCKED, ANY)  

Responses

HTTP Code Description Schema
200 Search results matching criteria. <User> array, see definition below
400 Invalid input. No Content
401 Unauthorized. No Content

Example HTTP request

Request Path

api.zonarsystems.net/core/v1/users

Example HTTP response

Response 200

[ {
  "id" : "81fb9673-f200-46b4-95c4-5e7011637b79",
  "firstName" : "Demo",
  "middleName" : "Example",
  "lastName" : "Example",
  "identityProviderId" : "6f836d0bf699c00d91754bf2",
  "identityProviderIds" : [ "6f836d0bf699c00d91754bf2" ],
  "email" : "demo.example@fakemail.us",
  "credentialType" : "STANDARD",
  "defaultLanguage" : "en-US",
  "status" : "ACTIVE",
  "managedEntity" : "object",
  "created" : "1970-01-01T00:00:00Z",
  "modified" : "1970-01-01T00:00:00Z"
} ]

Definitions

User

Name Description Schema
created
optional 		Timestamp of User creation.
Example: "1970-01-01T00:00:00Z"		 string (date-time)
credentialType
optional 		The credential type, either STANDARD, PASSWORDLESS or MANAGED.
Example: "STANDARD"		 enum (STANDARD, PASSWORDLESS, MANAGED)
defaultLanguage
optional 		Default language for user
Example: "en-US"		 string
email
optional 		Email address.
Example: "demo.example@fakemail.us"		 string (email)
firstName
optional 		First name.
Example: "Demo"		 string
id
optional 		The User ID.
Example: "81fb9673-f200-46b4-95c4-5e7011637b79"		 string (uuid)
identityProviderId
optional 		Auth0 ID.
Example: "6f836d0bf699c00d91754bf2"		 string
identityproviderIds
optional 		All Auth0 IDs Associated with User.
Example: [ "string" ]		 < string > array
lastName
optional 		Last name.
Example: "Example"		 string
managedEntity
optional 		Defines if the user is externally manged or not.
Example: "object"		 object
middleName
optional 		Middle name.
Example: "Example"		 string
modified
optional 		Timestamp of last edit.
Example: "1970-01-01T00:00:00Z"		 string (date-time)
status
optional 		The status of the User, either ACTIVE or INACTIVE.
Example: "ACTIVE"		 enum (ACTIVE, INACTIVE, LOCKED)

Asset API

Overview

Asset API: Entity API for managing assets.

Paths

List Assets

GET api.zonarsystems.net/core/v1/assets
GET api.zonarsystems.net/evir/v2/assets/user-created

By default, core/v1/assets retrieves only the given asset’s directly associated division – the allChildren parameter recursively searches every child in the given division’s hierarchy and returns them all.

Assets that were input into GTC will be in core/v1/assets. Assets that inspectors created to complete an inspection will be in evir/v2/assets/user-created

Parameters

Type Name Description Schema Default
Query allChildren 
optional 		Include recursive list of all child divisions. boolean "false"
Query allType
optional 		Asset Type. string  
Query companyId
optional 		A Company ID. string  
Query default_operator
optional 		Operator used when combining multiple search terms. enum (and, or)  
Query df
optional 		Default field to search. string  
Query divisionId
optional 		A Division ID. Company ID also needed. string  
Query externalId
optional 		An Assets external ID. string  
Query filterFields
optional 		Comma separated list of fields. If set only specified fields will be returned changing the returned object format <string> array(csv)  
Query managedSource
optional 		Managed Source. string  
Query managedSourceId
optional 		Managed Source Id. string  
Query name
optional 		An Asset name. string  
Query page
optional 		The current page of the result set. string "1"
Query paging_token
optional 		A paging token as returned from a previous response. string  
Query per_page
optional 		The number of items per page of the result set. Valid values: 1-1000 integer 100
Query q
optional 		Search terms. More search feature documentation is available in this guide. string  
Query sort
optional 		Sort order for search results. string  
Query status
optional 		Asset status filter - ACTIVE, INACTIVE, or ANY. enum (ACTIVE, INACTIVE, LOCKED, ANY) "ACTIVE"

Responses

HTTP Code Description Schema
200 Asset search results. <Asset> array, see below
401 Unauthorized. No Content

Example HTTP request

Request path

/assets

Example HTTP response

Response 200

[ {
  "id" : "81fb9673-f200-46b4-95c4-5e7011637b79",
  "name" : "053-24A975",
  "ownerName" : "Zonar",
  "companyId" : "81fb9673-f200-46b4-95c4-5e7011637b79",
  "divisions" : [ "81fb9673-f200-46b4-95c4-5e7011637b79" ],
  "homeLocationId" : "81fb9673-f200-46b4-95c4-5e7011637b79",
  "assetType" : "vehicle",
  "typeInfo" : "object",
  "status" : "ACTIVE",
  "make" : "Ford",
  "model" : "Focus",
  "modelYear" : "2004",
  "serialNumber" : "1234ABCD0987",
  "externalId" : "555123",
  "inServiceDate" : "1969-12-31",
  "isHazardous" : false,
  "inspectionInfo" : "object",
  "legacyAttributes" : "object",
  "assetInputId" : "81fb9673-f200-46b4-95c4-5e7011637b79",
  "managedEntity" : "object",
  "created" : "1970-01-01T00:00:00Z",
  "modified" : "1970-01-01T00:00:00Z"
} ]

Definitions: Asset

Name Description Schema
assetInputId 
optional 		Asset Input ID.
Example: "81fb9673-f200-46b4-95c4-5e7011637b79"		 string (uuid)
assetType 
optional 		The asset category. Must be set to vehicle.
Example: "vehicle"		 string
companyId
optional 		Company this asset belongs to.
Example: "81fb9673-f200-46b4-95c4-5e7011637b79"		 string (uuid)
created
optional 		Timestamp of Asset creation.
Example: "1970-01-01T00:00:00Z"		 string (date-time)
divisions
optional 		Divisions this asset belongs to.
Example: [ "f81d4fae-7dec-11d0-a765-00a0c91e6bf6" ]		 < string (uuid) > array
externalId
optional 		A unique ID for the asset in customer’s external system.
Example: "555123"		 string
homeLocationId
optional 		Location ID mapping to a company location.
Example: "81fb9673-f200-46b4-95c4-5e7011637b79"		 string (uuid)
id
optional 		Unique Asset ID.
Example: "81fb9673-f200-46b4-95c4-5e7011637b79"		 string (uuid)
inServiceDate
optional 		The data this asset went into service for the customer.
Example: "1969-12-31"		 string
inspectionInfo
optional 		Section with inspection related info for the asset.
Example: "object"		 object
isHazardous
optional 		Indicate whether an asset is carrying hazardous mats.
Default: false
Example: false		 boolean
legacyAttributes
optional 		Legacy system (GTC) type and subtype info.
Example: "object"		 object
make
optional 		The manufacturer name.
Example: "Ford"		 string
managedEntity
optional 		Defines if the asset is externally manged or not.
Example: "object"		 object
model
optional 		The manufacturer model.
Example: "Focus"		 string
modelYear
optional 		The year of manufacture.
Example: "2004"		 string
modified
optional 		Timestamp of last edit.
Example: "1970-01-01T00:00:00Z"		 string (date-time)

name

optional

 Name for the asset. Historically also known as fleet name. This may or may not be the same as the Power Unit Number printed on the side of the truck, depending on the carrier.
Example: "053-24A975"		 string
ownerName
optional 		The owner of the asset, which in leasing situations may be different from the company tracking the asset.
Example: "Zonar"		 string
serialNumber
optional 		The serial number of the asset.
Example: "1234ABCD0987"		 string
status
optional 		The status of the Asset, either ACTIVE or INACTIVE. You can filter for either case, or pass ANY to see them all. Default behavior filters out INACTIVE Assets.
Example: "ACTIVE"		 enum (ACTIVE, INACTIVE, LOCKED, ANY)
typeInfo
optional 		assetType-specific schema data.
Example: "object"		 object

Entity API Query String Syntax

The Entity APIs are enabled with a simple query-string based search feature. A search request can be executed purely using a URI by providing request parameters. The following parameters are recognized in the URL:

q: The query itself, always case insensitive

default_operator: Specifies the query selector from AND or OR. Defaults to OR.

df: The default field to use for unqualified search terms.

sort: Sorting to perform. Can either be in the form of fieldName, or fieldName:asc/fieldName:desc.

For example:

GET /api/v1/companies?q=name:zonar

URI Searches can specify multiple fields using the + symbol. For example:

GET /api/v1/companies?q=name:zonar+name:haskel

Could return:

[
  {
    "id": "6ab01746-cef7-45ad-8432-c655d70359f7",
    "name": "Zonar Systems",
    "anonymizedData": true,
    "created": "2018-08-11T19:24:19.238092",
    "modified": "2018-08-11T19:24:19.238102",
    "defaultDivisionId": null,
    "divisions": []
  },
  {
    "id": "6ab01746-cef7-45ad-8432-c655d70359f7",
    "name": "Haskell's Salvage and Seed",
    "anonymizedData": true,
    "created": "2018-08-11T19:24:19.238092",
    "modified": "2018-08-11T19:24:19.238102",
    "defaultDivisionId": null,
    "divisions": []
  }
]

To configure the URI to use the AND selector when using multiple fields set the default_operator parameter:

/api/v1/companies?default_operator=AND&q=name:zon+name:systems

This query would require that both terms are satisfied for the name field, and would return:

[
  {
    "id": "6ab01746-cef7-45ad-8432-c655d70359f7",
    "name": "Zonar Systems",
    "anonymizedData": true,
    "created": "2018-08-11T19:24:19.238092",
    "modified": "2018-08-11T19:24:19.238102",
    "defaultDivisionId": null,
    "divisions": []
  }
]

When no field is included the query operates on the default_field for the entity. To set a custom default_field use the df parameter:

/api/v1/companies?df=name&q=zon+haskel

This query would use the OR selector on the name field and would match both Zonar Systems and Haskell's Salvage and Seed as in the first example.

[
  {
    "id": "6ab01746-cef7-45ad-8432-c655d70359f7",
    "name": "Zonar Systems",
    "anonymizedData": true,
    "created": "2018-08-11T19:24:19.238092",
    "modified": "2018-08-11T19:24:19.238102",
    "defaultDivisionId": null,
    "divisions": []
  },
  {
    "id": "6ab01746-cef7-45ad-8432-c655d70359f7",
    "name": "Haskell's Salvage and Seed",
    "anonymizedData": true,
    "created": "2018-08-11T19:24:19.238092",
    "modified": "2018-08-11T19:24:19.238102",
    "defaultDivisionId": null,
    "divisions": []
  }
]

Control Characters

As demonstrated above, the : and + characters are used as control characters within the q query string. To search for those literal characters, escape them with a backslash ( \ ) as in the example:

/api/v1/companies?df=name&q=JP\:Trucking
[
  {
    "id": "6ab01746-cef7-45ad-8432-c655d70359f7",
    "name": "JP:Trucking",
    "anonymizedData": true,
    "created": "2018-10-16T21:33:12.799962",
    "modified": "2018-10-16T21:33:12.799970",
    "defaultDivisionId": null
  }
]

Note that escaping the control character is still necessary even though a df parameter is present, as the search parser will still attempt to convert the q string into additional searchable fields. Omitting the escaping may result in an unexpected response, e.g.:

{
  "message": "Invalid search term: JP"
}

<*>

Inspections / Defects / Repairs

POST evir/v2/defects GET paginated defects

GET defects with filters (uses POST http method to handle multiple filters)

Query Parameters

Type Name Description Schema
header ZonarOwner-ID
required 		Zonar owner id string
query perPage
optional 		Rows per page integer
query page
optional 		Page offset integer
query sort
optional 		Sort item Sorts
query sortDir
optional 		Sort direction SortDirection

Request Body

See Report Filters

Responses

Code Description  
200

Success

Headers

  
Name Description Schema
xpagecount Total number of pages that would be returned integer
xtotal-count Total number of rows that would be returned integer
link Pagination links object
Content application/json  
400 Invalid parameters  
Code      
401      
403      

GET/defects/{defectId} GET single defect

GET a single defect by uuid

Parameters

Type Name Description Schema
query companyId
required 		Company uuid Id
header ZonarOwner-ID
optional 		Zonar owner id string
path defectID
required 		Defect uuid Id

Responses

Code Description
200 Success

Content
application/json
204 Defect not found
400 Invalid parameters
401 Unauthorized
403 Forbidden

GET /defects/{defectId}/repairs

GET repairs on a defect

Parameters

Type Name Description Schema
query companyId
required 		Company uuid Id
header ZonarOwner-ID
required 		Zonar owner id string
path defectId
required 		Defect uuid Id

Responses

Code Description
200

Success

Content
application/json
204 Defect not found
400 Invalid parameters
401 Unauthorized
403 Forbidden

POST/defects/{defectId}/repairs

Returns the repair

Parameters

Type Name Description Schema
path defectId
required 		Defect uuid Id
header ZonarOwner-ID
required 		Zonar owner id string

Responses

Code Description
201 Success
400 Invalid parameters
401 Unauthorized
403 Forbidden
404 Defect not found

POST evir/v2/inspections

Get paginated list of inspections (POST to handle multiple filters)

Parameters

Type Name Description Schema
header ZonarOwner-ID
required 		Zonar owner id string
query perPage
optional 		Rows per page integer
query page
optional 		Page offset integer
query sort
optional 		Sort item Sorts
query sortDir
optional 		Sort direction SortDirection

Request Body - Required

See ReportFilters

Responses

Code Description  
200

Success

Headers

  
Name Description Schema
xpagecount Total number of pages that would be returned integer
xtotal-count Total number of rows that would be returned integer
link Pagination links object
Content application/json  
400 Invalid parameters  
401 Unauthorized  
403 Forbidden  

 GET/inspections/{inspectionId}

GET inspection

Parameter

Type Name Description Schema
path inspectionId
required 		Inspection uuid Id
query companyId
required 		Company uuid Id
header ZonarOwnerId
required 		Zonar owner id string

Responses

Code Description
200

Success

Content
application/json
400 Invalid parameters
401 Unauthorized
403 Forbidden
404 Inspection not found

GET/inspections/{inspectionId}/reviews

GET inspection reviews

Type Name Description Schema
path inspectionId
required 		Inspection uuid Id
query companyId
required 		Company uuid Id
header ZonarOwnerID
required 		Zonar owner id string

Responses

Code Description
200

Success

Content
application/json
204 Inspection reviews not found
400 Invalid parameters
401 Unauthorized
403 Forbidden

GETevir/v2/media

GET a defect image signed URL for uploading and viewing an image from Google Cloud storage bucket.

Return a signed url for media get or post

Parameters

Type Name Description Schema
query companyId
required 		Company uuid string
header ZonarOwnerId
required 		Owner Header string
query verb
optional 		HTTP Verb string
query mediaType
optional 		Media type string
query mediaId
required 		  string

Responses

Code Description
200

Success

Content
application/json
400 Invalid parameters
401 Unauthorized
403 Forbidden
404 Object not found

Components

EVIR Asset

Properties

Name Description Schema
assetCategory 
required 		  assetCategoryEnum
assetDivisions
optional 		Minimum Items: 1 <DivisionInfo>array
assetId
required 		  Id
assetName
required 		Maximum Length: 32 
Minimum Length: 1 		string
assetType
required 		  AssetType
assetLicense
optional 		Maximum Length: 8 
Minimum Length: 1 		string
assetJurisdiction
optional 		Maximum Length: 32 
Minimum Length: 2 		string
assetPowerUnitNumber
optional 		Maximum Length: 10 
Minimum Length: 1 		string
assetVersion
optional 		Maximum Length: 100 
Minimum Length: 1 		string
assetMake
optional 		Maximum Length: 100 
Minimum Length: 1 		string
assetModel
optional 		Maximum Length: 100 
Minimum Length: 1 		string
assetModelYear
optional 		Maximum Length: 100 
Minimum Length: 1 		string
assetSerialNumber
optional 		Maximum Length: 100 
Minimum Length: 1 		string
assetVin
optional 		Maximum Length: 17 
Minimum Length: 1 		string
assetCarrierDot
optional 		Maximum Length: 9 
Minimum Length: 1 		string
assetEngineSerialNumber
optional 		Maximum Length: 100
Minimum Length: 1 		string
assetOemPin
optional 		Maximum Length: 100 
Minimum Length: 1 		string
assetHomeLocation 
optional 		  id
assetRentalDot
optional 		Maximum Length: 9 
Minimum Length: 1 		string
assetIsRental
optional 		  boolean

InspectionList InspectionGet InspectionMultiGet InspectionReviewGet InspectionReviewPost

Name Description Schema
id
required 		  Id
companyId
required 		  Id
inspectionId
required 		  Id
inspectorId
required 		  Id
InspectorFirst
required 		Maximum Length: 32
Minimum Length: 1		 string
inspectorLastName
required 		Maximum Length: 32
Minimum Length: 1		 string
comment
required 		Maximum Length: 512
Minimum Length: 1 		string
telemetry
required 		  Telemetry

InspectionPost

Inspection posted by the mobile app

Properties

Name Description Schema
id
required 		  Id
companyId
required 		  Id
companyName
required 		Maximum Length: 256 
Minimum Length: 1 		string
configId
required 		  Id
inspectorDivisions
required 		Minimum Items: 1 <DivisionInfo>array
inspectorId
required 		  Id
inspectorFirstName
optional 		At least one (first or last) name is required
Maximum Length: 32
Minimum Length: 1 		string
inspectorLastName
optional 		At least one (first or last) name is required
Maximum Length: 32
Minimum Length: 1 		string
languageId
required 		  VersionId
settingsId
required 		  Id
languageChoice
required 		  languageChoiceEnum
requiresReview
required 		  boolean
inspectionReviewEventIds
optional 		  <Id>array
userAgent
optional 		Maximum Length: 512 
Minimum Length: 1 		string
isLegacy
optional 		  boolean
inspectionInfo
required 		  <InspectionInfo>array
inspectionDetail
required 		  InspectionDetail
inspectionAssets
required 		Maximum Items: 10 
Minimum Items: 1 		<InspectionAsset>array

InspectionAsset

Properties

Name Description Schema
zoneLayoutId
required 		  VersionId
zoneLayoutName
required 		  TranslatableString
asset
required 		  Asset
inspectionZones
required 		Minimum Items: 1 <InspectionZone>array
assetViewId
required 		  Ld
assetViewGrid
required 		  GridValue

InspectionDetail

Inspection type and optional additional input data

Properties

Name Description Schema
inspectionDetailId
required 		  VersionId
inspectionDetailName
required 		  TranslatableString
inspectionDetailData
optional 		  <InspectionDetailData>array

InspectionDetailData

Properties

Name Description Schema
inspectionDetailDataName
required 		  TranslatableString
inspectionDetailDataType
required 		  inspectionDetailDataTypeEnum
telemetry
optional 		  Telemetry
inspectionDetailContent
optional 		  object
inspectionDetailIndex
optional 		Minimum: 0 integer
inspectionDetailCategory
optional 		  inspectionDetailCategoryEnum
inspectiondetailSelectedUnit
optional 		  inspectionDetailSelectedUnitEnum
inspectionDetailContentKey
optional 		Minimum Length: 1 string
inspectionDetailAuxTagContent
optional 		Minimum Length: 1 string

InspectionDefect

Properties

Name Description Schema
defectId
required 		  Id
defectMedia
optional 		  <DefectMedia>array
componentIndex
required 		Maximum: 255 
Minimum: 0 		integer
componentName
required 		  TranslatableString
conditionName
required 		  TranslatableString
severity
required 		Maximum: 255 
Minimum: 0 		integer
otherComponent
optional 		Maximum Length: 512 
Minimum Length: 1 		string
otherCondition
optional 		Maximum Length: 512 
Minimum Length: 1 		string

inspectionDetailSelectedUnitEnum

Inspection detail selected unit

inspectionDetailDataTypeEnum

The allowable types of the inspection detail data 

inspectionDetailCategoryEnum

Inspection detail categories

InspectionInfo

Time and telemetry events

Properties

Name Description Schema
action
required 		  inspectionInfoActionEnum
telemetry
required 		  Telemetry

inspectionInfoActionEnum

Action type in inspection info

InspectionZone

Properties

Name Description Schema
zoneName
required 		  TranslatableString
verificationType
required 		  verificationTypeEnum
sequence
required 		Minimum: 0 integer
verificationData
optional 		Minimum Length: 1 string
telemetry
optional 		  Telemetry
inspectionDefects
optional 		  <inspectionDefect>array
assetViewLocation
optional 		  GridValue

Defect

Properties

Name Description Schema
companyId
required 		  Id
defectId
required 		  Id
first
required 		  DefectEvent
last
required 		   
reconciledAssetCategory
required 		  assetCategoryEnum
reconciledAssetId
required 		  Id
reconciledAssetName
required 		Maximum Length: 32 Minimum Length: 1 string
status
required 		  defectStatusEnum

DefectEvent

Properties

Name Description Schema
assetCategory
required 		  assetCategoryEnum
assetDivisions
optional 		Minimum Items: 1 <DivisionInfo>array
assetId
required 		  Id
configId
required 		  Id
componentIndex
required 		  integer
componentName
required 		  TranslatableString
conditionName
required 		  TranslatableString
defectMedia
optional 		unique items
Minimum Items: 1 		<DefectMedia>array
inspectionId
required 		  Id
inspectionTypeId
required 		  VersionId
inspectorFirstName
optional 		Maximum Length: 32 
Minimum Length: 1 		string
inspectorId
required 		  Id
inspectorLastName
optional 		Maximum Length: 32 
Minimum Length: 1 		string
languageChoice
required 		  languageChoiceEnum
otherComponent
optional 		Maximum Length: 512 
Minimum Length: 1 		string
otherCondition
required 		Maximum Length: 512 
Minimum Length: 1 		string
severity
required 		  inspectionDetailAllowedSeverityEnum
startTime
required 		  string (datamine)
zoneLayoutId
required 		  VersionId
zoneName
required 		  TranslatableString

DefectList DefectMedia

Properties

Name Description Schema
mediaId
required 		  ld
mediaTu[e
required 		  mediaTypeEnum
thumbnail
optional 		Minimum Length: 1 string

DivisionInfo

Properties

Name Description Schema
divisionId
required 		  Id
parentDivision
optional 		  Id
divisionName
required 		Maximum Length: 256 
Minimum Length: 1 		string
divisionType
optional 		Maximum Length: 256 
Minimum Length: 1 		string

Language Key

Maximum Length: 32 
Minimum Length: 1

mediaTypeEnum

Type of defect media Default: jpeg

repairStatusEnum

Allowed repair statuses

resolutionTypeEnum

Types of resolution available

RepairResponse RepairRequest

Properties

Name Description Schema
assetId 
required 		   
comment
optional 		Maximum Length: 512 
Minimum Length: 1 		 
companyId
required 		   
languageChoice
optional 		   
mechanicFirstName
optional 		Maximum Length: 32 
Minimum Length: 1 		 
mechanicId 
optional 		   
mechanicLastName
optional 		Maximum Length: 32 
Minimum Length: 1 		 
repairStatus
required 		   
resolution
optional 		Maximum Length: 512 
Minimum Length: 1 		 
resolutionType
optional 		   
userFirstName
optional 		Maximum Length: 32 
Minimum Length: 1 		 
userId
required 		   
userLastName
optional 		Maximum Length: 32 
Minimum Length: 1 		 
workOrder
optional 		Maximum Length: 128
Minimum Length: 1 		 

PostRepairs

Properties

Name Description Schema
assetId
required 		  string (uuid)
comment
optional 		  string
companyId
required 		  string (uuid)
languageChoice
optional 		  string
mechanicFirstName
optional 		  string
mechanicId
optional 		  string (uuid)
mechanicLastName
optional 		  string
repairStatus
optional 		  string
resolution
optional 		  string
resolutionType
optional 		  string
userId
required 		  string (uuid)
workOrder
optional 		  string

RepairResponseList SettingsGet SettingsPost

Name Description Schema
companyId
required 		  Id
allowUserAssets
optional 		  boolean
userToCoreAssociationLevel
optional 		  coreAssociationLevelEnum
userToCoreAssociationKey
optional 		Maximum Items: 2 
Minimum Items: 1 		<string>array
imageRetention
optional 		Minimum: 365
Default: 365 		integer
inspectionRetention
optional 		Minimum: 365
Default: 365 		integer
maxDefectImageCount
optional 		Maximum: 21
Minimum: 0
Default: 5 		integer
maxTotalImageCount
optional 		Maximum: 21
Minimum: 0
Default: 21 		integer
requireCriticalDefectImage
optional 		Default: false boolean
defaultZoneLayout
optional 		  Id
allowCustomDefectDescription
optional 		Default: false boolean
requireUniverifiedZoneReason
optional 		Default: false boolean
allowTimeCardInspection
optional 		Default: false boolean
propagateDefects
optional 		Default: false boolean

ReportFilters

Type Name Description Schema
body companyId
required 		unique identifer of the company id
body dates
required 		List of dates on which to filter Dates
body allChildren
optional 		Whether to include all children divisions boolean
body assetIds
optional 		List of asset IDs to filter on ids
body divisionIds
optional 		List of division IDs to filter on ids
body inspectionNameIds
optional 		List of inspection name IDs to filter on ids
body inspectionTypeIds
optional 		List of inspection types IDs to filter on ids
body inspectorIds
optional 		List of inspector IDs to filter on ids
body zoneLayoutIds
optional 		List of zone layout IDs (asset types) to filter on ids
body severities
optional 		List of defect severities to filter on severities
body statuses
optional 		List of defect statuses to filter on Defect status
body userIds
optional 		List of user IDs to filter on ids
body verification
optional 		List of verification IDs to filter on (incomplete or unverified or both) Verification type

Sorts

Value Description
assetName Sort on the name of the asset
component Sort on the component of the defect
condition Sort on the condition of the defect
inspectionName Sort on the name of the inspection
inspectionType Sort on the type of inspection
inspectorName Sort on the name of the inspector
lastInspected Sort on the defect's last reported date
repairDate Sort on the defect's repair date
severity Sort on the inspection higest defect severity
startTime Sort on the inspection start time
status Sort on the defect's status
zone Sort on the zone of the defect
zoneLayoutName Sort on the name of the zone layout (asset type) of the asset in the inspection

SortDirection

Value Description
asc Sort in an ascending order e.g. A->Z, 1->10, January->December
desc Sort in a descending order e.g. Z-A, 10->1, December->January

evirMedia

Properties

Name Description Schema
signedUrl
optional 		  string

 

Related articles