TrustOn Autoscan API (0.0.0)

Download OpenAPI specification:Download

Orders_listOrders

List all orders

Responses

Response samples

200

Content type

application/json

[{"id": "OR_01HZX0Z8",
"tenantId": "TN_01HZX0Z1",
"requesterPartnerId": "PT_01HZX0Z2",
"servicePartnerId": "PT_01HZX0Z2",
"stationId": "ST_01HZX0Z3",
"serviceStationId": "ST_01HZX0Z3",
"customerId": "CU_01HZX0Z6",
"status": "Created",
"assetId": "AT_01HZX0Z7",
"templateVersion": "tmpl-car-basic-v2@2.4.1",
"templateHash": "sha256:deadbeef"
},
{"id": "OR_01HZX0Z9",
"tenantId": "TN_01HZX0Z1",
"requesterPartnerId": "PT_01HZX0Z2",
"servicePartnerId": "PT_01HZX0Z2",
"stationId": "ST_01HZX0Z4",
"serviceStationId": "ST_01HZX0Z4",
"customerId": "CU_01HZX0Z7",
"status": "Draft",
"assetId": "AT_01HZX0Z8",
"templateVersion": "tmpl-car-basic-v2@2.4.1",
"templateHash": "sha256:feedface"
}
]

Orders_createOrder

Request Body schema: application/json

tenantId required	string (TenantId) Prefix TN_
requesterPartnerId required	string (PartnerId) Prefix PT_
servicePartnerId required	string (PartnerId) Prefix PT_
serviceStationId	string (StationId) Prefix ST_
customerId required	string (CustomerId) Prefix CU_
assetId required	string (AssetId) Prefix AT_
templateVersion required	string
templateHash required	string

Responses

Request samples

Payload

Content type

application/json

{"id": "OR_01HZX0Z8",
"tenantId": "TN_01HZX0Z1",
"requesterPartnerId": "PT_01HZX0Z2",
"servicePartnerId": "PT_01HZX0Z2",
"serviceStationId": "ST_01HZX0Z3",
"customerId": "CU_01HZX0Z6",
"status": "Created",
"assetId": "AT_01HZX0Z7",
"templateVersion": "tmpl-car-basic-v2@2.4.1",
"templateHash": "sha256:deadbeef"
}

Response samples

200

Content type

application/json

{"order": {"id": "OR_01HZX0Z8",
"tenantId": "TN_01HZX0Z1",
"requesterPartnerId": "PT_01HZX0Z2",
"servicePartnerId": "PT_01HZX0Z2",
"stationId": "ST_01HZX0Z3",
"serviceStationId": "ST_01HZX0Z3",
"customerId": "CU_01HZX0Z6",
"status": "Created",
"assetId": "AT_01HZX0Z7",
"templateVersion": "tmpl-car-basic-v2@2.4.1",
"templateHash": "sha256:deadbeef"
}
}

Reports_getReport

path Parameters

orderId

required

string (OrderId)

Prefix OR_

Responses

Response samples

200

Content type

application/json

{"report": {"id": "string",
"orderId": "string",
"templateVersion": "string",
"status": "Draft",
"coverage": {"completedRequired": 0,
"totalRequired": 0
},
"assessments": [{"id": "string",
"description": "string",
"severity": "Minor",
"assuranceLevel": "L0"
}
],
"pricingAdjustments": [{"assessmentId": "string",
"reason": "string",
"amount": {"currency": "string",
"amount": 0
},
"mappingVersion": "string"
}
],
"basePrice": {"currency": "string",
"amount": 0
},
"finalPrice": {"currency": "string",
"amount": 0
},
"publishedAt": "2019-08-24T14:15:22Z",
"expiresAt": "2019-08-24T14:15:22Z"
}
}

Reports_finalizeReport

path Parameters

orderId

required

string (OrderId)

Prefix OR_

Responses

Response samples

200

Content type

application/json

{"report": {"id": "string",
"orderId": "string",
"templateVersion": "string",
"status": "Draft",
"coverage": {"completedRequired": 0,
"totalRequired": 0
},
"assessments": [{"id": "string",
"description": "string",
"severity": "Minor",
"assuranceLevel": "L0"
}
],
"pricingAdjustments": [{"assessmentId": "string",
"reason": "string",
"amount": {"currency": "string",
"amount": 0
},
"mappingVersion": "string"
}
],
"basePrice": {"currency": "string",
"amount": 0
},
"finalPrice": {"currency": "string",
"amount": 0
},
"publishedAt": "2019-08-24T14:15:22Z",
"expiresAt": "2019-08-24T14:15:22Z"
}
}

Reports_publishReport

path Parameters

orderId

required

string (OrderId)

Prefix OR_

Responses

Response samples

200
409

Content type

application/json

{"report": {"id": "string",
"orderId": "string",
"templateVersion": "string",
"status": "Draft",
"coverage": {"completedRequired": 0,
"totalRequired": 0
},
"assessments": [{"id": "string",
"description": "string",
"severity": "Minor",
"assuranceLevel": "L0"
}
],
"pricingAdjustments": [{"assessmentId": "string",
"reason": "string",
"amount": {"currency": "string",
"amount": 0
},
"mappingVersion": "string"
}
],
"basePrice": {"currency": "string",
"amount": 0
},
"finalPrice": {"currency": "string",
"amount": 0
},
"publishedAt": "2019-08-24T14:15:22Z",
"expiresAt": "2019-08-24T14:15:22Z"
}
}

Partners_createPartner

Request Body schema: application/json

name required	string
type required	string (PartnerType) Enum: "FleetOwner" "DiagnosticNetwork" "Reseller"
legalName required	string
displayName required	string

Responses

Request samples

Payload

Content type

application/json

{"id": "PT_01HZX0Z2",
"tenantId": "TN_01HZX0Z1",
"type": "FleetOwner",
"legalName": "AutoFleet Group LLC",
"displayName": "AutoFleet"
}

Response samples

200

Content type

application/json

{"tenant": {"id": "string",
"name": "string",
"type": "FleetOwner",
"status": "active"
},
"partner": {"id": "string",
"tenantId": "string",
"type": "FleetOwner",
"legalName": "string",
"displayName": "string"
}
}

Partners_getPartner

path Parameters

partnerId

required

string (PartnerId)

Prefix PT_

Responses

Response samples

200

Content type

application/json

{"id": "PT_01HZX0Z2",
"tenantId": "TN_01HZX0Z1",
"type": "FleetOwner",
"legalName": "AutoFleet Group LLC",
"displayName": "AutoFleet"
}

Partners_assignRole

path Parameters

partnerId

required

string (PartnerId)

Prefix PT_

Request Body schema: application/json

userId required	string (UserId) Prefix US_
role required	string (RoleType) Enum: "PartnerAdmin" "StationAdmin" "Inspector" "FleetManager"
stationId	string (StationId) Prefix ST_

Responses

Request samples

Payload

Content type

application/json

{"userId": "string",
"role": "PartnerAdmin",
"stationId": "string"
}

Response samples

200

Content type

application/json

{"assignment": {"roleId": "string",
"role": "PartnerAdmin",
"partnerId": "string",
"stationId": "string"
}
}

Partners_createStation

path Parameters

partnerId

required

string (PartnerId)

Prefix PT_

Request Body schema: application/json

name required	string
address required	string

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"address": "string"
}

Response samples

200

Content type

application/json

{"station": {"id": "string",
"partnerId": "string",
"name": "string",
"address": "string",
"status": "active"
}
}

Partners_listStations

path Parameters

partnerId

required

string (PartnerId)

Prefix PT_

Responses

Response samples

200

Content type

application/json

[{"id": "string",
"partnerId": "string",
"name": "string",
"address": "string",
"status": "active"
}
]

Partners_createUser

path Parameters

partnerId

required

string (PartnerId)

Prefix PT_

Request Body schema: application/json

email required	string
fullName required	string

Responses

Request samples

Payload

Content type

application/json

{"email": "string",
"fullName": "string"
}

Response samples

200

Content type

application/json

{"user": {"id": "string",
"tenantId": "string",
"email": "string",
"fullName": "string",
"status": "active"
}
}

InspectionOperations_submitCheckExecution

path Parameters

orderId required	string (OrderId) Prefix OR_
checkItemId required	string (CheckItemId) Prefix CI_

Request Body schema: application/json

performedBy required	string (InspectorId) Prefix US_
performedAt required	string <date-time> (DateTimeUtc)
status required	string (CheckExecutionStatus) Enum: "submitted" "in_review" "accepted" "rejected" "superseded"
resultPayload required	any
required	object (CheckExecutionCoverage)
evidenceIds required	Array of strings (EvidenceId)
rawArtifactIds required	Array of strings (RawArtifactId)
qualityFlags required	Array of strings

Responses

Request samples

Payload

Content type

application/json

{"performedBy": "string",
"performedAt": "2019-08-24T14:15:22Z",
"status": "submitted",
"resultPayload": null,
"coverage": {"panel": "string",
"zones": ["string"
],
"points": ["string"
]
},
"evidenceIds": ["string"
],
"rawArtifactIds": ["string"
],
"qualityFlags": ["string"
]
}

Response samples

200

Content type

application/json

{"execution": {"id": "string",
"orderId": "string",
"checkItemId": "string",
"performedBy": "string",
"performedAt": "2019-08-24T14:15:22Z",
"status": "submitted",
"resultPayload": null,
"coverage": {"panel": "string",
"zones": ["string"
],
"points": ["string"
]
},
"evidenceIds": ["string"
],
"rawArtifactIds": ["string"
],
"qualityFlags": ["string"
]
}
}

InspectionOperations_createEvidence

path Parameters

orderId

required

string (OrderId)

Prefix OR_

Request Body schema: application/json

checkItemId required	string (CheckItemId) Prefix CI_
rawArtifactIds required	Array of strings (RawArtifactId)
description required	string
unit required	string
methodRef required	string (MethodRef)
validUntil	string <date-time> (DateTimeUtc)
quality required	string (EvidenceQuality) Enum: "ok" "warn" "bad"
required	object (EvidenceProvenance)

Responses

Request samples

Payload

Content type

application/json

{"checkItemId": "string",
"rawArtifactIds": ["string"
],
"description": "string",
"unit": "string",
"methodRef": "string",
"validUntil": "2019-08-24T14:15:22Z",
"quality": "ok",
"provenance": {"collectedBy": "string",
"conditions": "string"
}
}

Response samples

200

Content type

application/json

{"evidence": {"id": "string",
"orderId": "string",
"checkItemId": "string",
"rawArtifactIds": ["string"
],
"description": "string",
"unit": "string",
"methodRef": "string",
"validUntil": "2019-08-24T14:15:22Z",
"quality": "ok",
"revoked": true,
"revokedReason": "string",
"revokedAt": "2019-08-24T14:15:22Z",
"provenance": {"collectedBy": "string",
"conditions": "string"
}
}
}

Stations_getStation

path Parameters

stationId

required

string (StationId)

Prefix ST_

Responses

Response samples

200

Content type

application/json

{"id": "string",
"partnerId": "string",
"name": "string",
"address": "string",
"status": "active"
}