openapi: 3.0.1 info: title: Audatex.APIGateway termsOfService: https://www.solera.com/legal/ contact: name: Solera Development Team url: https://docs.microsoft.com/en-us/aspnet/core/tutorials/getting-started-with-swashbuckle?view=aspnetcore-2.2&tabs=visual-studio email: development@solera.com license: name: License url: https://www.solera.com/legal/ version: V1 servers: - url: /APIGateway paths: /api/v2/AiTriage: post: tags: - AiTriage summary: POST AI Triage v2 request description: This endpoint will allow you to request a AI Triage parameters: - name: X-Data-Region in: header description: Enter the region for the image capture to be stored. Example format 'solera-uk' required: true schema: type: string requestBody: description: '' content: application/json-patch+json: schema: $ref: '#/components/schemas/AiTriageReqV2VM' application/json: schema: $ref: '#/components/schemas/AiTriageReqV2VM' text/json: schema: $ref: '#/components/schemas/AiTriageReqV2VM' application/*+json: schema: $ref: '#/components/schemas/AiTriageReqV2VM' responses: '202': description: Returns an accepted response. The CalculationId returned, can be used in subsequent GET requests for aiTriage. content: text/plain: schema: $ref: '#/components/schemas/CalculationSelfViewModel' application/json: schema: $ref: '#/components/schemas/CalculationSelfViewModel' text/json: schema: $ref: '#/components/schemas/CalculationSelfViewModel' '400': description: Returns an error if the request fails validation or if the imageCapture cannot be found or if the imageCapture status is not yet complete content: text/plain: schema: $ref: '#/components/schemas/ProblemDetails' application/json: schema: $ref: '#/components/schemas/ProblemDetails' text/json: schema: $ref: '#/components/schemas/ProblemDetails' '401': description: Returns an error if the user is not authorised content: text/plain: schema: $ref: '#/components/schemas/ProblemDetails' application/json: schema: $ref: '#/components/schemas/ProblemDetails' text/json: schema: $ref: '#/components/schemas/ProblemDetails' '404': description: Returns an error if the image request id is not found content: text/plain: schema: $ref: '#/components/schemas/ProblemDetails' application/json: schema: $ref: '#/components/schemas/ProblemDetails' text/json: schema: $ref: '#/components/schemas/ProblemDetails' '500': description: Sorry, an unexpected error has occurred /api/v2/AiTriage/{imageCaptureId}/{calculationId}: get: tags: - AiTriage summary: GET an AI Triage v2 Request description: This endpoint will allow you to get the details of a AI Triage parameters: - name: imageCaptureId in: path description: '' required: true schema: type: string format: uuid - name: calculationId in: path description: '' required: true schema: type: string format: uuid - name: X-Data-Region in: header description: Enter the region for the image capture to be stored. Example format 'solera-uk' required: true schema: type: string responses: '200': description: Returns a response with the details of an AI Triage content: text/plain: schema: $ref: '#/components/schemas/AiTriageRespVM' application/json: schema: $ref: '#/components/schemas/AiTriageRespVM' text/json: schema: $ref: '#/components/schemas/AiTriageRespVM' '500': description: Sorry, an unexpected error has occurred '400': description: Returns an error if the request fails validation '401': description: Returns an error if the user is not authorised /api/v1/Assessment/Post: post: tags: - Assessment summary: Create an assessment description: This endpoint will allow you to create an assessment requestBody: description: '' content: application/json-patch+json: schema: $ref: '#/components/schemas/AssessmentReqViewModel' application/json: schema: $ref: '#/components/schemas/AssessmentReqViewModel' text/json: schema: $ref: '#/components/schemas/AssessmentReqViewModel' application/*+json: schema: $ref: '#/components/schemas/AssessmentReqViewModel' required: true responses: '201': description: Returns a created response content: text/plain: schema: $ref: '#/components/schemas/SelfWithErrorModel' application/json: schema: $ref: '#/components/schemas/SelfWithErrorModel' text/json: schema: $ref: '#/components/schemas/SelfWithErrorModel' '400': description: Returns an error if the request fails validation or if the assessment failed to create content: text/plain: schema: type: object additionalProperties: type: string application/json: schema: type: object additionalProperties: type: string text/json: schema: type: object additionalProperties: type: string '500': description: Sorry, an unexpected error has occurred '401': description: Returns an error if the user is not authorised '409': description: Returns a conflict response if a assessment is already created with the given assessment number and originator deprecated: true /api/v1/Audio: post: tags: - Audio summary: Upload a File description: This endpoint will allow a file to be uploaded responses: '201': description: Returns a created response content: text/plain: schema: $ref: '#/components/schemas/SelfViewModel' application/json: schema: $ref: '#/components/schemas/SelfViewModel' text/json: schema: $ref: '#/components/schemas/SelfViewModel' '400': description: Returns an error if the request fails validation content: text/plain: schema: type: object additionalProperties: type: string application/json: schema: type: object additionalProperties: type: string text/json: schema: type: object additionalProperties: type: string '401': description: Returns an error if the user is not authorised content: text/plain: schema: type: string application/json: schema: type: string text/json: schema: type: string '500': description: Sorry, an unexpected error has occurred get: tags: - Audio summary: Get content of a file by fileId description: This API will allow you to get a file stream parameters: - name: fileId in: query description: The id of the file required: true schema: type: string format: uuid responses: '200': description: Returns the file stream content: text/plain: schema: $ref: '#/components/schemas/Stream' application/json: schema: $ref: '#/components/schemas/Stream' text/json: schema: $ref: '#/components/schemas/Stream' '400': description: Returns an error if the request fails validation content: text/plain: schema: type: object additionalProperties: type: string application/json: schema: type: object additionalProperties: type: string text/json: schema: type: object additionalProperties: type: string '401': description: Returns an error if the user is not authorised content: text/plain: schema: type: string application/json: schema: type: string text/json: schema: type: string '404': description: Returns an error if the file is not found content: text/plain: schema: type: string application/json: schema: type: string text/json: schema: type: string delete: tags: - Audio summary: delete content of a file by fileId description: This API will allow you to delete a file stream parameters: - name: fileId in: query description: The id of the file required: true schema: type: string format: uuid responses: '200': description: Returns the file stream content: text/plain: schema: $ref: '#/components/schemas/Stream' application/json: schema: $ref: '#/components/schemas/Stream' text/json: schema: $ref: '#/components/schemas/Stream' '400': description: Returns an error if the request fails validation content: text/plain: schema: type: object additionalProperties: type: string application/json: schema: type: object additionalProperties: type: string text/json: schema: type: object additionalProperties: type: string '401': description: Returns an error if the user is not authorised content: text/plain: schema: type: string application/json: schema: type: string text/json: schema: type: string /api/v1/Audio/Info: post: tags: - Audio summary: Create a file space in the service to be used to upload a file stream description: This endpoint will create the file data necessary in DB to upload a file requestBody: description: '' content: application/json-patch+json: schema: $ref: '#/components/schemas/FileModel' application/json: schema: $ref: '#/components/schemas/FileModel' text/json: schema: $ref: '#/components/schemas/FileModel' application/*+json: schema: $ref: '#/components/schemas/FileModel' responses: '201': description: Returns a created response with the fileId content: text/plain: schema: $ref: '#/components/schemas/SelfViewModel' application/json: schema: $ref: '#/components/schemas/SelfViewModel' text/json: schema: $ref: '#/components/schemas/SelfViewModel' '400': description: Returns an error if the request fails validation content: text/plain: schema: type: object additionalProperties: type: string application/json: schema: type: object additionalProperties: type: string text/json: schema: type: object additionalProperties: type: string '401': description: Returns an error if the user is not authorised content: text/plain: schema: type: string application/json: schema: type: string text/json: schema: type: string '500': description: Sorry, an unexpected error has occurred /api/v1/Claim/Get: get: tags: - Claim summary: Get details of a claim by claimId description: The details return about the claim are controlled via the OAuth2 scopes. parameters: - name: claimId in: query description: The id of the claim schema: type: string format: uuid responses: '200': description: Returns the claim details content: text/plain: schema: $ref: '#/components/schemas/ClaimRespViewModel' application/json: schema: $ref: '#/components/schemas/ClaimRespViewModel' text/json: schema: $ref: '#/components/schemas/ClaimRespViewModel' '400': description: Returns an error if the request fails validation content: text/plain: schema: type: object additionalProperties: type: string application/json: schema: type: object additionalProperties: type: string text/json: schema: type: object additionalProperties: type: string '401': description: Returns an error if the user is not authorised deprecated: true /api/v1/Claim/GetByClaimnumber: get: tags: - Claim summary: Get details of a claim by claimnumber description: The details return about the claim are controlled via the OAuth2 scopes. parameters: - name: claimnumber in: query description: The claimnumber of the claim schema: type: string responses: '200': description: Returns the claim details content: text/plain: schema: $ref: '#/components/schemas/ClaimRespViewModel' application/json: schema: $ref: '#/components/schemas/ClaimRespViewModel' text/json: schema: $ref: '#/components/schemas/ClaimRespViewModel' '400': description: Returns an error if the request fails validation content: text/plain: schema: type: object additionalProperties: type: string application/json: schema: type: object additionalProperties: type: string text/json: schema: type: object additionalProperties: type: string '401': description: Returns an error if the user is not authorised deprecated: true /api/v1/Claim/Post: post: tags: - Claim summary: Add an assessment to a claim description: This endpoint will allow you to add an assessmet with the AEG AssessmentId, Assessment Number and Originator to a claim. requestBody: description: '' content: application/json-patch+json: schema: $ref: '#/components/schemas/ClaimReqViewModel' application/json: schema: $ref: '#/components/schemas/ClaimReqViewModel' text/json: schema: $ref: '#/components/schemas/ClaimReqViewModel' application/*+json: schema: $ref: '#/components/schemas/ClaimReqViewModel' required: true responses: '201': description: Returns a created response '400': description: Returns an error if the request fails validation or if the claimnumber does not exist or if the assessment failed to create content: text/plain: schema: type: object additionalProperties: type: string application/json: schema: type: object additionalProperties: type: string text/json: schema: type: object additionalProperties: type: string '500': description: Sorry, an unexpected error has occurred '401': description: Returns an error if the user is not authorised deprecated: true /api/v1/ClaimRepairers: post: tags: - ClaimRepairers summary: Creates a claim then returns list of Repairers that can service the claim. description: This endpoints creates a claim and returns a list of Repairers that can service the claim. requestBody: description: '' content: application/json-patch+json: schema: $ref: '#/components/schemas/ClaimRepairersReqViewModel' application/json: schema: $ref: '#/components/schemas/ClaimRepairersReqViewModel' text/json: schema: $ref: '#/components/schemas/ClaimRepairersReqViewModel' application/*+json: schema: $ref: '#/components/schemas/ClaimRepairersReqViewModel' responses: '200': description: Success content: text/plain: schema: type: array items: $ref: '#/components/schemas/ClaimRepairerRespViewModel' application/json: schema: type: array items: $ref: '#/components/schemas/ClaimRepairerRespViewModel' text/json: schema: type: array items: $ref: '#/components/schemas/ClaimRepairerRespViewModel' '400': description: Returns an error if the request fails validation content: text/plain: schema: $ref: '#/components/schemas/ProblemDetails' application/json: schema: $ref: '#/components/schemas/ProblemDetails' text/json: schema: $ref: '#/components/schemas/ProblemDetails' '500': description: Sorry, an unexpected error has occurred '201': description: Returns a created response '401': description: Returns an error if the user is not authorised /api/v1/ClientConfiguration: post: tags: - ClientConfiguration summary: Add a Client Configuration associated to the EntityId description: '' requestBody: description: '' content: application/json-patch+json: schema: $ref: '#/components/schemas/ClientConfigurationReqViewModel' application/json: schema: $ref: '#/components/schemas/ClientConfigurationReqViewModel' text/json: schema: $ref: '#/components/schemas/ClientConfigurationReqViewModel' application/*+json: schema: $ref: '#/components/schemas/ClientConfigurationReqViewModel' responses: '201': description: Returns a created response '400': description: Returns an error if the request fails validation content: text/plain: schema: type: object additionalProperties: type: string application/json: schema: type: object additionalProperties: type: string text/json: schema: type: object additionalProperties: type: string '401': description: Returns an error if the user is not authorised content: text/plain: schema: type: string application/json: schema: type: string text/json: schema: type: string '403': description: Returns an error if the user has not the permissions needed content: text/plain: schema: type: string application/json: schema: type: string text/json: schema: type: string '500': description: Sorry, an unexpected error has occurred content: text/plain: schema: type: string application/json: schema: type: string text/json: schema: type: string get: tags: - ClientConfiguration summary: Get the Client Configuration associated to the EntityId description: This endpoint will allow you to get the Client Configuration associated to the EntityId responses: '200': description: Returns the Client Configuration content: text/plain: schema: $ref: '#/components/schemas/ClientConfigurationResViewModel' application/json: schema: $ref: '#/components/schemas/ClientConfigurationResViewModel' text/json: schema: $ref: '#/components/schemas/ClientConfigurationResViewModel' '400': description: Returns an error if the request fails validation content: text/plain: schema: type: object additionalProperties: type: string application/json: schema: type: object additionalProperties: type: string text/json: schema: type: object additionalProperties: type: string '401': description: Returns an error if the user is not authorised content: text/plain: schema: type: string application/json: schema: type: string text/json: schema: type: string '403': description: Returns an error if the user has not the permissions needed content: text/plain: schema: type: string application/json: schema: type: string text/json: schema: type: string '409': description: Returns an error if there is conflicting information content: text/plain: schema: type: string application/json: schema: type: string text/json: schema: type: string '500': description: Sorry, an unexpected error has occurred content: text/plain: schema: type: string application/json: schema: type: string text/json: schema: type: string /api/v1/FraudCheck/{imageCaptureId}: get: tags: - FraudCheck summary: Gets metadata about an image capture description: This API will allow you to get metadata of an image capture parameters: - name: imageCaptureId in: path description: The id of the image capture required: true schema: type: string format: uuid - name: X-Data-Region in: header description: Enter the region for the image capture to be stored. Example format 'solera-uk' required: true schema: type: string responses: '400': description: Returns an error if the request fails validation content: text/plain: schema: type: object additionalProperties: type: string application/json: schema: type: object additionalProperties: type: string text/json: schema: type: object additionalProperties: type: string '200': description: Returns details content: text/plain: schema: $ref: '#/components/schemas/ImageMetadataRespModel' application/json: schema: $ref: '#/components/schemas/ImageMetadataRespModel' text/json: schema: $ref: '#/components/schemas/ImageMetadataRespModel' '401': description: Returns an error if the user is not authorised '500': description: Sorry, an unexpected error has occurred post: tags: - FraudCheck summary: Add/Update metadata used in fraud check for an image capture description: This API will allow you to add/update some metadata of an image capture parameters: - name: imageCaptureId in: path description: The id of the image capture required: true schema: type: string format: uuid - name: X-Data-Region in: header description: Enter the region for the image capture to be stored. Example format 'solera-uk' required: true schema: type: string requestBody: content: application/json-patch+json: schema: {} application/json: schema: {} text/json: schema: {} application/*+json: schema: {} responses: '400': description: 'Returns an error if the request fails validation: empty new data, image id not found, etc' content: text/plain: schema: type: object additionalProperties: type: string application/json: schema: type: object additionalProperties: type: string text/json: schema: type: object additionalProperties: type: string '200': description: Returns details of the image capture content: text/plain: schema: $ref: '#/components/schemas/ImageMetadataRespModel' application/json: schema: $ref: '#/components/schemas/ImageMetadataRespModel' text/json: schema: $ref: '#/components/schemas/ImageMetadataRespModel' '401': description: Returns an error if the user is not authorised '500': description: Sorry, an unexpected error has occurred /api/v1/HeroImage: post: tags: - HeroImage summary: Uploads a Hero Image description: This endpoint will allow a hero image to be uploaded requestBody: description: '' content: application/json-patch+json: schema: $ref: '#/components/schemas/HeroImageVM' application/json: schema: $ref: '#/components/schemas/HeroImageVM' text/json: schema: $ref: '#/components/schemas/HeroImageVM' application/*+json: schema: $ref: '#/components/schemas/HeroImageVM' required: true responses: '201': description: Returns a created response with the imageId content: text/plain: schema: $ref: '#/components/schemas/SelfViewModel' application/json: schema: $ref: '#/components/schemas/SelfViewModel' text/json: schema: $ref: '#/components/schemas/SelfViewModel' '400': description: Returns an error if the request fails validation content: text/plain: schema: type: object additionalProperties: type: string application/json: schema: type: object additionalProperties: type: string text/json: schema: type: object additionalProperties: type: string '401': description: Returns an error if the user is not authorized get: tags: - HeroImage summary: Retrieves a list of Hero Images description: This endpoint will allow user to retrieve a ist of images that can override the hero images on pages responses: '200': description: Returns an OK response with the list of images content: text/plain: schema: type: array items: $ref: '#/components/schemas/HeroImageModel' application/json: schema: type: array items: $ref: '#/components/schemas/HeroImageModel' text/json: schema: type: array items: $ref: '#/components/schemas/HeroImageModel' '400': description: Returns an error if the request fails content: text/plain: schema: type: object additionalProperties: type: string application/json: schema: type: object additionalProperties: type: string text/json: schema: type: object additionalProperties: type: string '401': description: Returns an error if the user is not authorized /api/v1/Image/Post: post: tags: - Image summary: Add images to an assessmentId description: This endpoint will allow you to add images to an assessment requestBody: description: '' content: application/json-patch+json: schema: $ref: '#/components/schemas/AssessmentImageRequestVM' application/json: schema: $ref: '#/components/schemas/AssessmentImageRequestVM' text/json: schema: $ref: '#/components/schemas/AssessmentImageRequestVM' application/*+json: schema: $ref: '#/components/schemas/AssessmentImageRequestVM' required: true responses: '201': description: Returns a created response content: text/plain: schema: $ref: '#/components/schemas/SelfModel' application/json: schema: $ref: '#/components/schemas/SelfModel' text/json: schema: $ref: '#/components/schemas/SelfModel' '400': description: Returns an error if the request fails validation or if the assessmentId does not exist content: text/plain: schema: type: object additionalProperties: type: string application/json: schema: type: object additionalProperties: type: string text/json: schema: type: object additionalProperties: type: string '500': description: Sorry, an unexpected error has occurred '401': description: Returns an error if the user is not authorised deprecated: true /api/v1/Image/Logo: get: tags: - Image summary: Retrieves a list of logo Images description: This endpoint will allow a logo image to be getted responses: '200': description: Returns an OK response with the list of images content: text/plain: schema: type: array items: $ref: '#/components/schemas/LogoImageRespModel' application/json: schema: type: array items: $ref: '#/components/schemas/LogoImageRespModel' text/json: schema: type: array items: $ref: '#/components/schemas/LogoImageRespModel' '400': description: Returns an error if the request fails content: text/plain: schema: type: object additionalProperties: type: string application/json: schema: type: object additionalProperties: type: string text/json: schema: type: object additionalProperties: type: string '401': description: Returns an error if the user is not authorized content: text/plain: schema: type: string application/json: schema: type: string text/json: schema: type: string '404': description: Not Found content: text/plain: schema: type: string application/json: schema: type: string text/json: schema: type: string '500': description: Server Error content: text/plain: schema: type: string application/json: schema: type: string text/json: schema: type: string post: tags: - Image summary: Uploads a Logo Image description: This endpoint will allow a logo image to be uploaded requestBody: description: '' content: application/json-patch+json: schema: $ref: '#/components/schemas/LogoImageVM' application/json: schema: $ref: '#/components/schemas/LogoImageVM' text/json: schema: $ref: '#/components/schemas/LogoImageVM' application/*+json: schema: $ref: '#/components/schemas/LogoImageVM' required: true responses: '201': description: Returns a created response with the imageId content: text/plain: schema: $ref: '#/components/schemas/SelfViewModel' application/json: schema: $ref: '#/components/schemas/SelfViewModel' text/json: schema: $ref: '#/components/schemas/SelfViewModel' '400': description: Returns an error if the request fails validation content: text/plain: schema: type: object additionalProperties: type: string application/json: schema: type: object additionalProperties: type: string text/json: schema: type: object additionalProperties: type: string '401': description: Returns an error if the user is not authorized content: text/plain: schema: type: string application/json: schema: type: string text/json: schema: type: string '404': description: Not Found content: text/plain: schema: type: string application/json: schema: type: string text/json: schema: type: string '500': description: Server Error content: text/plain: schema: type: string application/json: schema: type: string text/json: schema: type: string /api/v1/ImageAttachment: post: tags: - ImageAttachment summary: POST image capture image attachment description: This endpoint will allow you to send a number of post image capture image attachment and will return an image attachment id parameters: - name: X-Data-Region in: header description: Enter the region for the image capture to be stored. Example format 'solera-uk' required: true schema: type: string requestBody: description: '' content: application/json-patch+json: schema: $ref: '#/components/schemas/ImageAttachmentRequestVM' application/json: schema: $ref: '#/components/schemas/ImageAttachmentRequestVM' text/json: schema: $ref: '#/components/schemas/ImageAttachmentRequestVM' application/*+json: schema: $ref: '#/components/schemas/ImageAttachmentRequestVM' responses: '202': description: Returns an accepted response. The ImageAttachmentId returned, can be used in subsequent GET requests for image attachment content: text/plain: schema: $ref: '#/components/schemas/ImageAttachmentSelfViewModel' application/json: schema: $ref: '#/components/schemas/ImageAttachmentSelfViewModel' text/json: schema: $ref: '#/components/schemas/ImageAttachmentSelfViewModel' '500': description: Sorry, an unexpected error has occurred '400': description: Returns an error if the request fails validation '401': description: Returns an error if the user is not authorised /api/v1/ImageAttachment/{imageCaptureId}/{imageAttachmentId}: get: tags: - ImageAttachment summary: GET image capture image attachment description: This endpoint will allow you to get the details and status of the image capture image attachments parameters: - name: imageCaptureId in: path description: ImageCaptureId required: true schema: type: string format: uuid - name: imageAttachmentId in: path description: ImageAttachmentId required: true schema: type: string format: uuid - name: X-Data-Region in: header description: Enter the region for the image capture to be stored. Example format 'solera-uk' required: true schema: type: string responses: '200': description: Returns a response with details of the image capture image attachment content: text/plain: schema: $ref: '#/components/schemas/ImageAttachmentRespVM' application/json: schema: $ref: '#/components/schemas/ImageAttachmentRespVM' text/json: schema: $ref: '#/components/schemas/ImageAttachmentRespVM' '500': description: Sorry, an unexpected error has occurred '400': description: Returns an error if the request fails validation '401': description: Returns an error if the user is not authorised /api/v1/ImageCapture: post: tags: - ImageCapture summary: Send image capture SMS description: This endpoint will allow you to send image capture SMS parameters: - name: X-Data-Region in: header description: Enter the region for the image capture to be stored. Example format 'solera-uk' required: true schema: type: string requestBody: description: '' content: application/json-patch+json: schema: $ref: '#/components/schemas/ImageCaptureReqViewModel' application/json: schema: $ref: '#/components/schemas/ImageCaptureReqViewModel' text/json: schema: $ref: '#/components/schemas/ImageCaptureReqViewModel' application/*+json: schema: $ref: '#/components/schemas/ImageCaptureReqViewModel' responses: '201': description: Returns a created response content: text/plain: schema: $ref: '#/components/schemas/ImageCaptureSelfViewModel' application/json: schema: $ref: '#/components/schemas/ImageCaptureSelfViewModel' text/json: schema: $ref: '#/components/schemas/ImageCaptureSelfViewModel' '400': description: Returns an error if the request fails validation content: text/plain: schema: type: object additionalProperties: type: string application/json: schema: type: object additionalProperties: type: string text/json: schema: type: object additionalProperties: type: string '500': description: Sorry, an unexpected error has occurred '401': description: Returns an error if the user is not authorised /api/v1/ImageCapture/UsingTemplate: post: tags: - ImageCapture summary: Send image capture SMS using a template description: This endpoint will allow you to send image capture SMS using a template parameters: - name: X-Data-Region in: header description: Enter the region for the image capture to be stored. Example format 'solera-uk' required: true schema: type: string requestBody: description: '' content: application/json-patch+json: schema: $ref: '#/components/schemas/ImageCaptureUsingTemplateReqViewModel' application/json: schema: $ref: '#/components/schemas/ImageCaptureUsingTemplateReqViewModel' text/json: schema: $ref: '#/components/schemas/ImageCaptureUsingTemplateReqViewModel' application/*+json: schema: $ref: '#/components/schemas/ImageCaptureUsingTemplateReqViewModel' responses: '201': description: Returns a created response content: text/plain: schema: $ref: '#/components/schemas/ImageCaptureSelfViewModel' application/json: schema: $ref: '#/components/schemas/ImageCaptureSelfViewModel' text/json: schema: $ref: '#/components/schemas/ImageCaptureSelfViewModel' '400': description: Returns an error if the request fails validation content: text/plain: schema: type: object additionalProperties: type: string application/json: schema: type: object additionalProperties: type: string text/json: schema: type: object additionalProperties: type: string '401': description: Returns an error if the user is not authorised /api/v1/ImageCapture/WithLink: post: tags: - ImageCapture summary: Send image capture SMS and get the link in the response description: This endpoint will allow you to send image capture SMS and get the link in the response parameters: - name: X-Data-Region in: header description: Enter the region for the image capture to be stored. Example format 'solera-uk' required: true schema: type: string requestBody: description: '' content: application/json-patch+json: schema: $ref: '#/components/schemas/ImageCaptureReqViewModel' application/json: schema: $ref: '#/components/schemas/ImageCaptureReqViewModel' text/json: schema: $ref: '#/components/schemas/ImageCaptureReqViewModel' application/*+json: schema: $ref: '#/components/schemas/ImageCaptureReqViewModel' responses: '201': description: Returns a created response including the link content: text/plain: schema: $ref: '#/components/schemas/ImageCaptureSelfViewModel' application/json: schema: $ref: '#/components/schemas/ImageCaptureSelfViewModel' text/json: schema: $ref: '#/components/schemas/ImageCaptureSelfViewModel' '400': description: Returns an error if the request fails validation content: text/plain: schema: type: object additionalProperties: type: string application/json: schema: type: object additionalProperties: type: string text/json: schema: type: object additionalProperties: type: string '500': description: Sorry, an unexpected error has occurred '401': description: Returns an error if the user is not authorised /api/v1/ImageCapture/WithQR: post: tags: - ImageCapture summary: Create image capture request with QR code description: This endpoint creates an image capture request with QR code and returns the SelfViewModel parameters: - name: X-Data-Region in: header description: Enter the region for the image capture to be stored. Example format 'solera-uk' required: true schema: type: string requestBody: description: '' content: application/json-patch+json: schema: $ref: '#/components/schemas/ImageCaptureReqViewModel' application/json: schema: $ref: '#/components/schemas/ImageCaptureReqViewModel' text/json: schema: $ref: '#/components/schemas/ImageCaptureReqViewModel' application/*+json: schema: $ref: '#/components/schemas/ImageCaptureReqViewModel' responses: '201': description: Returns a created response with SelfViewModel content: text/plain: schema: $ref: '#/components/schemas/ImageCaptureSelfViewModel' application/json: schema: $ref: '#/components/schemas/ImageCaptureSelfViewModel' text/json: schema: $ref: '#/components/schemas/ImageCaptureSelfViewModel' '400': description: Returns an error if the request fails validation content: text/plain: schema: type: object additionalProperties: type: string application/json: schema: type: object additionalProperties: type: string text/json: schema: type: object additionalProperties: type: string '500': description: Sorry, an unexpected error has occurred '401': description: Returns an error if the user is not authorised /api/v1/ImageCapture/{imageCaptureId}/WithQR: get: tags: - ImageCapture summary: Get QR code for image capture request description: This endpoint retrieves the QR code as a PNG image file parameters: - name: imageCaptureId in: path description: The id of the image capture required: true schema: type: string format: uuid - name: X-Data-Region in: header description: Enter the region for the image capture to be stored. Example format 'solera-uk' required: true schema: type: string responses: '200': description: Returns PNG image file content: text/plain: schema: $ref: '#/components/schemas/ImageCaptureResViewModel' application/json: schema: $ref: '#/components/schemas/ImageCaptureResViewModel' text/json: schema: $ref: '#/components/schemas/ImageCaptureResViewModel' '400': description: Returns an error if the request fails validation content: text/plain: schema: type: object additionalProperties: type: string application/json: schema: type: object additionalProperties: type: string text/json: schema: type: object additionalProperties: type: string '404': description: Returns an error if the image capture id is not found content: text/plain: schema: type: string application/json: schema: type: string text/json: schema: type: string '500': description: Sorry, an unexpected error has occurred '401': description: Returns an error if the user is not authorised /api/v1/ImageCapture/{imageCaptureId}/Duplicate: post: tags: - ImageCapture summary: Duplicate an expired image capture description: This endpoint will allow you to duplicate an expired image capture parameters: - name: imageCaptureId in: path description: The id of the expired image capture required: true schema: type: string format: uuid - name: X-Data-Region in: header description: Enter the region for the image capture to be stored. Example format 'solera-uk' required: true schema: type: string responses: '201': description: Returns a created response content: text/plain: schema: $ref: '#/components/schemas/ImageCaptureSelfViewModel' application/json: schema: $ref: '#/components/schemas/ImageCaptureSelfViewModel' text/json: schema: $ref: '#/components/schemas/ImageCaptureSelfViewModel' '400': description: Returns an error if the request fails validation content: text/plain: schema: type: object additionalProperties: type: string application/json: schema: type: object additionalProperties: type: string text/json: schema: type: object additionalProperties: type: string '401': description: Returns an error if the user is not authorised content: text/plain: schema: type: string application/json: schema: type: string text/json: schema: type: string '404': description: Returns an error if the image request id is not found content: text/plain: schema: type: string application/json: schema: type: string text/json: schema: type: string '500': description: Sorry, an unexpected error has occurred /api/v1/ImageCapture/{imageCaptureId}: get: tags: - ImageCapture summary: Gets details about an image capture description: This API will allow you to get details of an image capture parameters: - name: imageCaptureId in: path description: The id of the image capture required: true schema: type: string format: uuid - name: scale in: query description: "Optional parameter. To which size the images of the image capture will escalated when they are returned.\r\ \n Currently, only NoScale and OneMP (Default value) are supported. Other values in\ \ the list of available values are for future uses.\r\n Use of default value is strongly recommended." schema: $ref: '#/components/schemas/ScaleTo' - name: X-Data-Region in: header description: Enter the region for the image capture to be stored. Example format 'solera-uk' required: true schema: type: string responses: '400': description: Returns an error if the request fails validation content: text/plain: schema: type: object additionalProperties: type: string application/json: schema: type: object additionalProperties: type: string text/json: schema: type: object additionalProperties: type: string '200': description: Returns details of the image capture if found and if the image capture does not exist or was deleted, returns an empty response. content: text/plain: schema: $ref: '#/components/schemas/ImageCaptureResViewModel' application/json: schema: $ref: '#/components/schemas/ImageCaptureResViewModel' text/json: schema: $ref: '#/components/schemas/ImageCaptureResViewModel' '401': description: Returns an error if the user is not authorised '500': description: Sorry, an unexpected error has occurred delete: tags: - ImageCapture summary: Delete Image Request description: This endpoint will allow you to delete an Image Capture. parameters: - name: imageCaptureId in: path description: '' required: true schema: type: string format: uuid - name: X-Data-Region in: header description: Enter the region for the image capture to be stored. Example format 'solera-uk' required: true schema: type: string responses: '200': description: Returns an Ok response '202': description: Returns an accepted response content: text/plain: schema: type: string application/json: schema: type: string text/json: schema: type: string '400': description: Returns an error if the request fails validation content: text/plain: schema: type: string application/json: schema: type: string text/json: schema: type: string '401': description: Returns an error if the user is not authorized content: text/plain: schema: type: string application/json: schema: type: string text/json: schema: type: string '404': description: Returns an error if the image request does not exist content: text/plain: schema: type: string application/json: schema: type: string text/json: schema: type: string '500': description: Sorry, an unexpected error has occurred content: text/plain: schema: type: string application/json: schema: type: string text/json: schema: type: string /api/v1/ImageCapture/{imageCaptureId}/integration: get: tags: - ImageCapture summary: Gets details about an image capture including the external image id description: "This API will allow you to get details of an image capture without loading the Base64 image data.\r\n\ Only image IDs and metadata are returned." parameters: - name: imageCaptureId in: path description: The id of the image capture required: true schema: type: string format: uuid - name: X-Data-Region in: header description: Enter the region for the image capture to be stored. Example format 'solera-uk' required: true schema: type: string responses: '200': description: Returns details of the image capture if found and if the image capture does not exist or was deleted, returns an empty response. content: text/plain: schema: $ref: '#/components/schemas/ImageCaptureResViewModel' application/json: schema: $ref: '#/components/schemas/ImageCaptureResViewModel' text/json: schema: $ref: '#/components/schemas/ImageCaptureResViewModel' '400': description: Returns an error if the request fails validation content: text/plain: schema: type: object additionalProperties: type: string application/json: schema: type: object additionalProperties: type: string text/json: schema: type: object additionalProperties: type: string '404': description: Returns an error if the image request id is not found content: text/plain: schema: type: object additionalProperties: type: string application/json: schema: type: object additionalProperties: type: string text/json: schema: type: object additionalProperties: type: string '500': description: Sorry, an unexpected error has occurred content: text/plain: schema: type: object additionalProperties: type: string application/json: schema: type: object additionalProperties: type: string text/json: schema: type: object additionalProperties: type: string '401': description: Returns an error if the user is not authorized /api/v1/ImageCapture/Query/{imageCaptureId}: get: tags: - ImageCapture summary: Gets only some information about an image capture description: This API will allow you to get some information of an image capture parameters: - name: imageCaptureId in: path description: The id of the image capture required: true schema: type: string format: uuid - name: fieldsSet in: query schema: uniqueItems: true type: array items: $ref: '#/components/schemas/QueryField' - name: fields in: query schema: type: string - name: defaultFieldNames in: query schema: type: array items: type: string - name: fieldNames in: query schema: type: array items: type: string - name: X-Data-Region in: header description: Enter the region for the image capture to be stored. Example format 'solera-uk' required: true schema: type: string responses: '400': description: Returns an error if the request fails validation content: text/plain: schema: $ref: '#/components/schemas/ValidationProblemDetails' application/json: schema: $ref: '#/components/schemas/ValidationProblemDetails' text/json: schema: $ref: '#/components/schemas/ValidationProblemDetails' '404': description: Not Found content: text/plain: schema: type: string application/json: schema: type: string text/json: schema: type: string '200': description: Returns some information of the image capture content: text/plain: schema: $ref: '#/components/schemas/ImageCaptureQueryResViewModel' application/json: schema: $ref: '#/components/schemas/ImageCaptureQueryResViewModel' text/json: schema: $ref: '#/components/schemas/ImageCaptureQueryResViewModel' '401': description: Returns an error if the user is not authorized '500': description: Sorry, an unexpected error has occurred post: tags: - ImageCapture summary: Gets only some information about an image capture description: This API will allow you to get some information of an image capture parameters: - name: imageCaptureId in: path description: The id of the image capture required: true schema: type: string format: uuid - name: X-Data-Region in: header description: Enter the region for the image capture to be stored. Example format 'solera-uk' required: true schema: type: string requestBody: description: The query parameters required of the image capture content: application/json-patch+json: schema: $ref: '#/components/schemas/QueryReqViewModel' application/json: schema: $ref: '#/components/schemas/QueryReqViewModel' text/json: schema: $ref: '#/components/schemas/QueryReqViewModel' application/*+json: schema: $ref: '#/components/schemas/QueryReqViewModel' responses: '400': description: Returns an error if the request fails validation content: text/plain: schema: $ref: '#/components/schemas/ValidationProblemDetails' application/json: schema: $ref: '#/components/schemas/ValidationProblemDetails' text/json: schema: $ref: '#/components/schemas/ValidationProblemDetails' '404': description: Returns an error if the image request id is not found content: text/plain: schema: type: string application/json: schema: type: string text/json: schema: type: string '200': description: Returns some information of the image capture content: text/plain: schema: $ref: '#/components/schemas/ImageCaptureQueryResViewModel' application/json: schema: $ref: '#/components/schemas/ImageCaptureQueryResViewModel' text/json: schema: $ref: '#/components/schemas/ImageCaptureQueryResViewModel' '401': description: Returns an error if the user is not authorized '500': description: Sorry, an unexpected error has occurred /api/v1/ImageCaptureExternal: post: tags: - ImageCaptureExternal summary: Allows you to upload images from an external image capture solution description: This endpoint allows you to upload images from an external image capture solution parameters: - name: X-Data-Region in: header description: Enter the region for the image capture to be stored. Example format 'solera-uk' required: true schema: type: string requestBody: description: '' content: application/json-patch+json: schema: $ref: '#/components/schemas/ICExternalReqVM' application/json: schema: $ref: '#/components/schemas/ICExternalReqVM' text/json: schema: $ref: '#/components/schemas/ICExternalReqVM' application/*+json: schema: $ref: '#/components/schemas/ICExternalReqVM' responses: '201': description: Returns a created response content: text/plain: schema: $ref: '#/components/schemas/ICExternalSelfVM' application/json: schema: $ref: '#/components/schemas/ICExternalSelfVM' text/json: schema: $ref: '#/components/schemas/ICExternalSelfVM' '400': description: Returns an error if the request fails validation content: text/plain: schema: type: object additionalProperties: type: string application/json: schema: type: object additionalProperties: type: string text/json: schema: type: object additionalProperties: type: string '500': description: Sorry, an unexpected error has occurred '401': description: Returns an error if the user is not authorised /api/v1/ImageCaptureExternal/{imageCaptureId}: get: tags: - ImageCaptureExternal summary: Gets details about an external image capture description: This API will allow you to get details of an image capture parameters: - name: imageCaptureId in: path description: The id of the image capture required: true schema: type: string format: uuid - name: X-Data-Region in: header description: Enter the region for the image capture to be stored. Example format 'solera-uk' required: true schema: type: string responses: '400': description: Returns an error if the request fails validation content: text/plain: schema: type: object additionalProperties: type: string application/json: schema: type: object additionalProperties: type: string text/json: schema: type: object additionalProperties: type: string '200': description: Returns details of the image capture content: text/plain: schema: $ref: '#/components/schemas/ICExternalRespVM' application/json: schema: $ref: '#/components/schemas/ICExternalRespVM' text/json: schema: $ref: '#/components/schemas/ICExternalRespVM' '401': description: Returns an error if the user is not authorised '500': description: Sorry, an unexpected error has occurred /api/v2/ImageCaptureExternal/Open: post: tags: - ImageCaptureExternal summary: Create a new image capture external v2 description: This API will allow you to create a new image capture external parameters: - name: X-Data-Region in: header description: Enter the region for the image capture to be stored. Example format 'solera-uk' required: true schema: type: string requestBody: description: The image capture external input content: application/json-patch+json: schema: $ref: '#/components/schemas/ICExternalV2ReqVM' application/json: schema: $ref: '#/components/schemas/ICExternalV2ReqVM' text/json: schema: $ref: '#/components/schemas/ICExternalV2ReqVM' application/*+json: schema: $ref: '#/components/schemas/ICExternalV2ReqVM' responses: '201': description: Returns a created response content: text/plain: schema: $ref: '#/components/schemas/SelfModel' application/json: schema: $ref: '#/components/schemas/SelfModel' text/json: schema: $ref: '#/components/schemas/SelfModel' '400': description: Returns an error if the request fails validation or if n image capture external fails to create content: text/plain: schema: type: object additionalProperties: type: string application/json: schema: type: object additionalProperties: type: string text/json: schema: type: object additionalProperties: type: string '500': description: Sorry, an unexpected error has occurred '401': description: Returns an error if the user is not authorized /api/v2/ImageCaptureExternal/{imageRequestId}/Complete: put: tags: - ImageCaptureExternal summary: Complete the image capture external v2 description: This API will allow you to complete the image capture external parameters: - name: imageRequestId in: path description: The image capture external input required: true schema: type: string format: uuid - name: X-Data-Region in: header description: Enter the region for the image capture to be stored. Example format 'solera-uk' required: true schema: type: string responses: '200': description: Returns a created response '400': description: Returns an error if the request fails validation or if n image capture external fails to create content: text/plain: schema: type: object additionalProperties: type: string application/json: schema: type: object additionalProperties: type: string text/json: schema: type: object additionalProperties: type: string '500': description: Sorry, an unexpected error has occurred '401': description: Returns an error if the user is not authorised '404': description: Returns an error if image capture external is not found /api/v2/ImageCaptureExternal/{imageCaptureId}: get: tags: - ImageCaptureExternal summary: Gets details about an external image capture v2 description: This API will allow you to get details of an external image capture v2 parameters: - name: imageCaptureId in: path description: The id of the image capture required: true schema: type: string format: uuid - name: X-Data-Region in: header description: Enter the region for the image capture to be stored. Example format 'solera-uk' required: true schema: type: string responses: '400': description: Returns an error if the request fails validation content: text/plain: schema: type: object additionalProperties: type: string application/json: schema: type: object additionalProperties: type: string text/json: schema: type: object additionalProperties: type: string '200': description: Returns details of the image capture content: text/plain: schema: $ref: '#/components/schemas/ICExternalV2RespVM' application/json: schema: $ref: '#/components/schemas/ICExternalV2RespVM' text/json: schema: $ref: '#/components/schemas/ICExternalV2RespVM' '401': description: Returns an error if the user is not authorised '500': description: Sorry, an unexpected error has occurred /api/v2/ImageCaptureExternal/{imageRequestId}/Images: post: tags: - ImageCaptureExternal summary: Upload images info via image capture external v2 description: This API will allow you to upload new images info via capture external parameters: - name: imageRequestId in: path description: '' required: true schema: type: string format: uuid - name: X-Data-Region in: header description: Enter the region for the image capture to be stored. Example format 'solera-uk' required: true schema: type: string requestBody: description: The image capture external input content: application/json-patch+json: schema: $ref: '#/components/schemas/ICExternalV2ImageInfoReqVM' application/json: schema: $ref: '#/components/schemas/ICExternalV2ImageInfoReqVM' text/json: schema: $ref: '#/components/schemas/ICExternalV2ImageInfoReqVM' application/*+json: schema: $ref: '#/components/schemas/ICExternalV2ImageInfoReqVM' responses: '201': description: Returns a created response content: text/plain: schema: $ref: '#/components/schemas/ICExternalSelfVM' application/json: schema: $ref: '#/components/schemas/ICExternalSelfVM' text/json: schema: $ref: '#/components/schemas/ICExternalSelfVM' '400': description: Returns an error if the request fails validation or if n image capture external fails to create content: text/plain: schema: type: object additionalProperties: type: string application/json: schema: type: object additionalProperties: type: string text/json: schema: type: object additionalProperties: type: string '500': description: Sorry, an unexpected error has occurred '401': description: Returns an error if the user is not authorised /api/v2/ImageCaptureExternal/{imageRequestId}/Images/{imageId}/{format}: get: tags: - ImageCaptureExternal summary: Get image by imageId parameters: - name: imageId in: path description: '' required: true schema: type: string format: uuid - name: imageRequestId in: path description: '' required: true schema: type: string format: uuid - name: format in: path description: '' required: true schema: type: string default: binary - name: X-Data-Region in: header description: Enter the region for the image capture to be stored. Example format 'solera-uk' required: true schema: type: string responses: '200': description: Returns a created response content: text/plain: schema: type: string format: binary application/json: schema: type: string format: binary text/json: schema: type: string format: binary '404': description: Not Found content: text/plain: schema: $ref: '#/components/schemas/ProblemDetails' application/json: schema: $ref: '#/components/schemas/ProblemDetails' text/json: schema: $ref: '#/components/schemas/ProblemDetails' '500': description: Sorry, an unexpected error has occurred '400': description: Returns an error if the request fails validation or if image fails to fetch '401': description: Returns an error if the user is not authorised /api/v2/ImageCaptureExternal/{imageRequestId}/Images/{imageId}: put: tags: - ImageCaptureExternal summary: This endpoint will allow you to upload an image associate them with an imageId parameters: - name: imageRequestId in: path description: '' required: true schema: type: string format: uuid - name: imageId in: path description: '' required: true schema: type: string format: uuid - name: X-Data-Region in: header description: Enter the region for the image capture to be stored. Example format 'solera-uk' required: true schema: type: string requestBody: content: multipart/form-data: schema: type: object properties: file: type: string format: binary encoding: file: style: form responses: '201': description: Returns a created response content: text/plain: schema: $ref: '#/components/schemas/ICExternalSelfVM' application/json: schema: $ref: '#/components/schemas/ICExternalSelfVM' text/json: schema: $ref: '#/components/schemas/ICExternalSelfVM' '400': description: Returns an error if the request fails validation content: text/plain: schema: type: object additionalProperties: type: string application/json: schema: type: object additionalProperties: type: string text/json: schema: type: object additionalProperties: type: string '404': description: Returns an error if the ImageId does not exists content: text/plain: schema: type: object additionalProperties: type: string application/json: schema: type: object additionalProperties: type: string text/json: schema: type: object additionalProperties: type: string '500': description: Sorry, an unexpected error has occurred delete: tags: - ImageCaptureExternal summary: Delete an image by imageId description: This API will allow you to delete an image parameters: - name: imageRequestId in: path description: The id of the image required: true schema: type: string format: uuid - name: imageId in: path description: The id of the image required: true schema: type: string format: uuid - name: X-Data-Region in: header description: Enter the region for the image capture to be stored. Example format 'solera-uk' required: true schema: type: string responses: '204': description: No Content '400': description: Returns an error if the request fails validation or if the given imageId does not exist content: text/plain: schema: type: object additionalProperties: type: string application/json: schema: type: object additionalProperties: type: string text/json: schema: type: object additionalProperties: type: string '500': description: Sorry, an unexpected error has occurred '200': description: Returns an Ok response saying the image has been deleted '401': description: Returns an error if the user is not authorised /api/v2/ImageCaptureExternal/{imageRequestId}/Images/{imageId}/binary: put: tags: - ImageCaptureExternal summary: This endpoint will allow you to upload an image associate them with an imageId parameters: - name: imageRequestId in: path description: '' required: true schema: type: string format: uuid - name: imageId in: path description: '' required: true schema: type: string format: uuid - name: X-Data-Region in: header description: Enter the region for the image capture to be stored. Example format 'solera-uk' required: true schema: type: string requestBody: content: multipart/form-data: schema: type: object properties: file: type: string format: binary encoding: file: style: form responses: '201': description: Returns a created response content: text/plain: schema: $ref: '#/components/schemas/ICExternalSelfVM' application/json: schema: $ref: '#/components/schemas/ICExternalSelfVM' text/json: schema: $ref: '#/components/schemas/ICExternalSelfVM' '400': description: Returns an error if the request fails validation content: text/plain: schema: type: object additionalProperties: type: string application/json: schema: type: object additionalProperties: type: string text/json: schema: type: object additionalProperties: type: string '404': description: Returns an error if the ImageId does not exists content: text/plain: schema: type: object additionalProperties: type: string application/json: schema: type: object additionalProperties: type: string text/json: schema: type: object additionalProperties: type: string '500': description: Sorry, an unexpected error has occurred /api/v2/ImageCaptureExternal/{imageRequestId}/Images/{imageId}/base64: put: tags: - ImageCaptureExternal parameters: - name: imageRequestId in: path required: true schema: type: string format: uuid - name: imageId in: path required: true schema: type: string format: uuid - name: X-Data-Region in: header description: Enter the region for the image capture to be stored. Example format 'solera-uk' required: true schema: type: string requestBody: content: application/json-patch+json: schema: type: string application/json: schema: type: string text/json: schema: type: string application/*+json: schema: type: string responses: '204': description: No Content '400': description: Bad Request content: text/plain: schema: type: object additionalProperties: type: string application/json: schema: type: object additionalProperties: type: string text/json: schema: type: object additionalProperties: type: string '404': description: Not Found content: text/plain: schema: type: object additionalProperties: type: string application/json: schema: type: object additionalProperties: type: string text/json: schema: type: object additionalProperties: type: string '500': description: Server Error /api/Introspection/Dependencies: get: tags: - Introspection responses: '200': description: Success /api/Introspection/AppDetails: get: tags: - Introspection responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/AppDetail' /api/Introspection/ErrorCodes: get: tags: - Introspection parameters: - name: culture in: query schema: type: string responses: '200': description: Success content: application/json: schema: type: object additionalProperties: type: object additionalProperties: type: string /api/Introspection/Events: get: tags: - Introspection parameters: - name: culture in: query schema: type: string responses: '200': description: Success content: application/json: schema: type: object additionalProperties: type: object additionalProperties: type: string /api/v1/Job: post: tags: - Job summary: Add a Job associated to an EntityId description: '' requestBody: description: '' content: application/json-patch+json: schema: $ref: '#/components/schemas/JobReqViewModel' application/json: schema: $ref: '#/components/schemas/JobReqViewModel' text/json: schema: $ref: '#/components/schemas/JobReqViewModel' application/*+json: schema: $ref: '#/components/schemas/JobReqViewModel' responses: '201': description: Returns a created response '400': description: Returns an error if the request fails validation content: text/plain: schema: type: object additionalProperties: type: string application/json: schema: type: object additionalProperties: type: string text/json: schema: type: object additionalProperties: type: string '401': description: Returns an error if the user is not authorised content: text/plain: schema: type: string application/json: schema: type: string text/json: schema: type: string '403': description: Returns an error if the user has not the permissions needed content: text/plain: schema: type: string application/json: schema: type: string text/json: schema: type: string '500': description: Sorry, an unexpected error has occurred content: text/plain: schema: type: string application/json: schema: type: string text/json: schema: type: string get: tags: - Job summary: Get the job list description: This endpoint will allow you to get the Job List responses: '200': description: Returns the job list content: text/plain: schema: type: array items: $ref: '#/components/schemas/JobResViewModel' application/json: schema: type: array items: $ref: '#/components/schemas/JobResViewModel' text/json: schema: type: array items: $ref: '#/components/schemas/JobResViewModel' '400': description: Returns an error if the request fails validation content: text/plain: schema: type: string application/json: schema: type: string text/json: schema: type: string '401': description: Returns an error if the user is not authorised content: text/plain: schema: type: string application/json: schema: type: string text/json: schema: type: string '403': description: Returns an error if the user has not the permissions needed content: text/plain: schema: type: string application/json: schema: type: string text/json: schema: type: string '500': description: Sorry, an unexpected error has occurred content: text/plain: schema: type: string application/json: schema: type: string text/json: schema: type: string /api/v1/Job/{id}: get: tags: - Job summary: Get the job for a given id description: This endpoint will allow you to get the Job for an Id parameters: - name: id in: path description: jobId required: true schema: type: string format: uuid responses: '200': description: Returns the job for the id content: text/plain: schema: $ref: '#/components/schemas/JobResViewModel' application/json: schema: $ref: '#/components/schemas/JobResViewModel' text/json: schema: $ref: '#/components/schemas/JobResViewModel' '400': description: Returns an error if the request fails validation content: text/plain: schema: type: object additionalProperties: type: string application/json: schema: type: object additionalProperties: type: string text/json: schema: type: object additionalProperties: type: string '401': description: Returns an error if the user is not authorised content: text/plain: schema: type: string application/json: schema: type: string text/json: schema: type: string '403': description: Returns an error if the user has not the permissions needed content: text/plain: schema: type: string application/json: schema: type: string text/json: schema: type: string '404': description: Returns an error if the job do not exist content: text/plain: schema: type: string application/json: schema: type: string text/json: schema: type: string '500': description: Sorry, an unexpected error has occurred content: text/plain: schema: type: string application/json: schema: type: string text/json: schema: type: string /api/v1/Job/{jobId}: put: tags: - Job summary: Update the job description: This endpoint will allow you to update the Job parameters: - name: jobId in: path required: true schema: type: string format: uuid requestBody: content: application/json-patch+json: schema: $ref: '#/components/schemas/JobReqViewModel' application/json: schema: $ref: '#/components/schemas/JobReqViewModel' text/json: schema: $ref: '#/components/schemas/JobReqViewModel' application/*+json: schema: $ref: '#/components/schemas/JobReqViewModel' responses: '204': description: Returns no content '400': description: Returns a bad request if there is no job content: text/plain: schema: type: object additionalProperties: type: string application/json: schema: type: object additionalProperties: type: string text/json: schema: type: object additionalProperties: type: string '401': description: Returns an error if the user is not authorized content: text/plain: schema: type: string application/json: schema: type: string text/json: schema: type: string '403': description: Returns an error if the user has not the permissions needed content: text/plain: schema: type: string application/json: schema: type: string text/json: schema: type: string '404': description: Returns an error if any job do not exist content: text/plain: schema: type: string application/json: schema: type: string text/json: schema: type: string '500': description: Returns an error if any job cannot be updated content: text/plain: schema: type: string application/json: schema: type: string text/json: schema: type: string delete: tags: - Job summary: Delete Job description: This endpoint will allow you to delete a job. parameters: - name: jobId in: path description: '' required: true schema: type: string format: uuid responses: '202': description: Returns an accepted response content: text/plain: schema: type: string application/json: schema: type: string text/json: schema: type: string '204': description: Returns an NoContent response '401': description: Returns an error if the user is not authorized content: text/plain: schema: type: string application/json: schema: type: string text/json: schema: type: string '403': description: Returns an error if the user has not the permissions needed content: text/plain: schema: type: string application/json: schema: type: string text/json: schema: type: string '404': description: Returns an error if the job does not exist content: text/plain: schema: type: string application/json: schema: type: string text/json: schema: type: string '500': description: Sorry, an unexpected error has occurred content: text/plain: schema: type: string application/json: schema: type: string text/json: schema: type: string /api/LogManagement: get: tags: - LogManagement responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/LogLevelResponse' put: tags: - LogManagement requestBody: content: application/json-patch+json: schema: $ref: '#/components/schemas/LogElevationRequest' application/json: schema: $ref: '#/components/schemas/LogElevationRequest' text/json: schema: $ref: '#/components/schemas/LogElevationRequest' application/*+json: schema: $ref: '#/components/schemas/LogElevationRequest' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/LogLevelResponse' /api/v1/Offer: post: tags: - Offer summary: Create a new Intelligent Offer request description: This API will allow you to create a new Intelligent Offer request requestBody: description: The Intelligent Offer input content: application/json-patch+json: schema: $ref: '#/components/schemas/OfferRequestViewModel' application/json: schema: $ref: '#/components/schemas/OfferRequestViewModel' text/json: schema: $ref: '#/components/schemas/OfferRequestViewModel' application/*+json: schema: $ref: '#/components/schemas/OfferRequestViewModel' responses: '201': description: Returns a created response content: text/plain: schema: $ref: '#/components/schemas/SelfModel' application/json: schema: $ref: '#/components/schemas/SelfModel' text/json: schema: $ref: '#/components/schemas/SelfModel' '400': description: Returns an error if the request fails validation content: text/plain: schema: type: object additionalProperties: type: string application/json: schema: type: object additionalProperties: type: string text/json: schema: type: object additionalProperties: type: string '500': description: Sorry, an unexpected error has occurred '401': description: Returns an error if the user is not authorized /api/v1/Offer/{offerId}: get: tags: - Offer summary: Get details about an Intelligent Offer request description: This API will allow you to get details of an Intelligent Offer request parameters: - name: offerId in: path description: The id of the Intelligent Offer request required: true schema: type: string format: uuid responses: '200': description: Returns details of the Intelligent Offer request content: text/plain: schema: $ref: '#/components/schemas/OfferResponseViewModel' application/json: schema: $ref: '#/components/schemas/OfferResponseViewModel' text/json: schema: $ref: '#/components/schemas/OfferResponseViewModel' '400': description: Returns an error if the request fails validation content: text/plain: schema: type: object additionalProperties: type: string application/json: schema: type: object additionalProperties: type: string text/json: schema: type: object additionalProperties: type: string '404': description: Returns an error if the Intelligent Offer request is not found content: text/plain: schema: $ref: '#/components/schemas/ProblemDetails' application/json: schema: $ref: '#/components/schemas/ProblemDetails' text/json: schema: $ref: '#/components/schemas/ProblemDetails' '500': description: Sorry, an unexpected error has occurred content: text/plain: schema: $ref: '#/components/schemas/ProblemDetails' application/json: schema: $ref: '#/components/schemas/ProblemDetails' text/json: schema: $ref: '#/components/schemas/ProblemDetails' '401': description: Returns an error if the user is not authorized /api/v1/Offer/Query/{offerId}: get: tags: - Offer summary: Gets only some information about an Intelligent Offer description: This API will allow you to get some information of an Intelligent Offer (GIC-5348) parameters: - name: offerId in: path description: The id of the Intelligent Offer required: true schema: type: string format: uuid - name: fieldsSet in: query schema: uniqueItems: true type: array items: $ref: '#/components/schemas/OfferQueryField' - name: fields in: query schema: type: string - name: defaultFieldNames in: query schema: type: array items: type: string - name: fieldNames in: query schema: type: array items: type: string responses: '400': description: Returns an error if the request fails validation content: text/plain: schema: $ref: '#/components/schemas/ValidationProblemDetails' application/json: schema: $ref: '#/components/schemas/ValidationProblemDetails' text/json: schema: $ref: '#/components/schemas/ValidationProblemDetails' '404': description: Returns an error if the Intelligent Offer is not found content: text/plain: schema: type: string application/json: schema: type: string text/json: schema: type: string '200': description: Returns some information of the Intelligent Offer content: text/plain: schema: $ref: '#/components/schemas/OfferQueryModel' application/json: schema: $ref: '#/components/schemas/OfferQueryModel' text/json: schema: $ref: '#/components/schemas/OfferQueryModel' '401': description: Returns an error if the user is not authorized '500': description: Sorry, an unexpected error has occurred post: tags: - Offer summary: Gets only some information about an Intelligent Offer (POST version) description: This API will allow you to get some information of an Intelligent Offer using POST (GIC-5348) parameters: - name: offerId in: path description: The id of the Intelligent Offer required: true schema: type: string format: uuid requestBody: description: The query parameters required of the Intelligent Offer content: application/json-patch+json: schema: $ref: '#/components/schemas/OfferQueryReqViewModel' application/json: schema: $ref: '#/components/schemas/OfferQueryReqViewModel' text/json: schema: $ref: '#/components/schemas/OfferQueryReqViewModel' application/*+json: schema: $ref: '#/components/schemas/OfferQueryReqViewModel' responses: '400': description: Returns an error if the request fails validation content: text/plain: schema: $ref: '#/components/schemas/ValidationProblemDetails' application/json: schema: $ref: '#/components/schemas/ValidationProblemDetails' text/json: schema: $ref: '#/components/schemas/ValidationProblemDetails' '404': description: Returns an error if the Intelligent Offer is not found content: text/plain: schema: type: string application/json: schema: type: string text/json: schema: type: string '200': description: Returns some information of the Intelligent Offer content: text/plain: schema: $ref: '#/components/schemas/OfferQueryModel' application/json: schema: $ref: '#/components/schemas/OfferQueryModel' text/json: schema: $ref: '#/components/schemas/OfferQueryModel' '401': description: Returns an error if the user is not authorized '500': description: Sorry, an unexpected error has occurred /api/v1/PingEvent: post: tags: - PingEvent summary: Creates a ping description: This API will allow you to create a ping responses: '201': description: Returns a created response content: text/plain: schema: $ref: '#/components/schemas/PingModel' application/json: schema: $ref: '#/components/schemas/PingModel' text/json: schema: $ref: '#/components/schemas/PingModel' '400': description: Returns an error if region fails validation content: text/plain: schema: type: string application/json: schema: type: string text/json: schema: type: string '401': description: Returns an error if the user is not authorized content: text/plain: schema: type: string application/json: schema: type: string text/json: schema: type: string '403': description: Returns an error if the user has not the permissions needed content: text/plain: schema: type: string application/json: schema: type: string text/json: schema: type: string '429': description: Returns an error if the rate limit has been exceeded content: text/plain: schema: type: string application/json: schema: type: string text/json: schema: type: string '500': description: Sorry, an unexpected error has occurred content: text/plain: schema: type: string application/json: schema: type: string text/json: schema: type: string /api/v1/PingEvent/{pingId}: get: tags: - PingEvent summary: Gets details about a ping description: This API will allow you to get details about a ping parameters: - name: pingId in: path description: The id of the ping required: true schema: type: string format: uuid responses: '200': description: Returns details of the ping content: text/plain: schema: $ref: '#/components/schemas/PingResponse' application/json: schema: $ref: '#/components/schemas/PingResponse' text/json: schema: $ref: '#/components/schemas/PingResponse' '400': description: Returns an error if the ping fails validation content: text/plain: schema: type: string application/json: schema: type: string text/json: schema: type: string '401': description: Returns an error if the user is not authorized content: text/plain: schema: type: string application/json: schema: type: string text/json: schema: type: string '403': description: Returns an error if the user has not the permissions needed content: text/plain: schema: type: string application/json: schema: type: string text/json: schema: type: string '404': description: Returns an error if the pingId does not exist content: text/plain: schema: type: string application/json: schema: type: string text/json: schema: type: string '500': description: Sorry, an unexpected error has occurred content: text/plain: schema: type: string application/json: schema: type: string text/json: schema: type: string /api/v1/Reminder: post: tags: - Reminder summary: Create a reminder message description: This API will allow you to create a reminder message requestBody: description: The reminder input content: application/json-patch+json: schema: $ref: '#/components/schemas/ReminderReqViewModel' application/json: schema: $ref: '#/components/schemas/ReminderReqViewModel' text/json: schema: $ref: '#/components/schemas/ReminderReqViewModel' application/*+json: schema: $ref: '#/components/schemas/ReminderReqViewModel' responses: '201': description: Returns a created response content: text/plain: schema: $ref: '#/components/schemas/SelfViewModel' application/json: schema: $ref: '#/components/schemas/SelfViewModel' text/json: schema: $ref: '#/components/schemas/SelfViewModel' '400': description: Returns an error if the request fails validation or if n image request fails to create content: text/plain: schema: type: string application/json: schema: type: string text/json: schema: type: string '401': description: Returns an error if the user is not authorised content: text/plain: schema: type: string application/json: schema: type: string text/json: schema: type: string '403': description: Returns an error if the user has not the permissions needed content: text/plain: schema: type: string application/json: schema: type: string text/json: schema: type: string '500': description: Sorry, an unexpected error has occurred content: text/plain: schema: type: string application/json: schema: type: string text/json: schema: type: string /api/v1/Reminder/{reminderId}: get: tags: - Reminder summary: Gets details about a reminder message description: This API will allow you to get details about a reminder message parameters: - name: reminderId in: path description: The id of the reminder message required: true schema: type: string format: uuid responses: '200': description: Returns details of the reminder message content: text/plain: schema: $ref: '#/components/schemas/ImageCaptureCommunicationResVM' application/json: schema: $ref: '#/components/schemas/ImageCaptureCommunicationResVM' text/json: schema: $ref: '#/components/schemas/ImageCaptureCommunicationResVM' '400': description: Returns an error if the reminder fails validation content: text/plain: schema: type: string application/json: schema: type: string text/json: schema: type: string '401': description: Returns an error if the user is not authorised content: text/plain: schema: type: string application/json: schema: type: string text/json: schema: type: string '403': description: Returns an error if the user has not the permissions needed content: text/plain: schema: type: string application/json: schema: type: string text/json: schema: type: string '404': description: Returns an error if the reminder message does not exist content: text/plain: schema: type: string application/json: schema: type: string text/json: schema: type: string '500': description: Sorry, an unexpected error has occurred content: text/plain: schema: type: string application/json: schema: type: string text/json: schema: type: string /api/v1/Repairer/Get: get: tags: - Repairer summary: Get the details of a repairer by repairerId description: The details returned about the repairer are controlled via the OAuth2 scopes. parameters: - name: repairerId in: query description: The id of the repairer required: true schema: type: string format: uuid responses: '200': description: Returns the repairer details content: text/plain: schema: $ref: '#/components/schemas/RepairerResponseVM' application/json: schema: $ref: '#/components/schemas/RepairerResponseVM' text/json: schema: $ref: '#/components/schemas/RepairerResponseVM' '400': description: Returns an error if the request fails validation content: text/plain: schema: type: object additionalProperties: type: string application/json: schema: type: object additionalProperties: type: string text/json: schema: type: object additionalProperties: type: string '500': description: Sorry, an unexpected error has occurred '401': description: Returns an error if the user is not authorised deprecated: true /api/v1/Repairers/search: get: tags: - Repairers summary: Search repairers by name description: This endpoint performs a wildcard search on Repairer name and aliases. parameters: - name: country in: query required: true schema: $ref: '#/components/schemas/Country' - name: name in: query required: true schema: minLength: 2 type: string - name: pageSize in: query schema: type: integer format: int32 - name: page in: query schema: type: integer format: int32 responses: '200': description: Returns list of entities content: application/json: schema: type: array items: $ref: '#/components/schemas/RepairerRespVM' '400': description: Returns an error if the request fails validation content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' '500': description: Sorry, an unexpected error has occurred '401': description: Returns an error if the user is not authorised /api/v1/Reports/{format}/IntelligentDamageDetection/{imageCaptureId}/{commandId}/{language}: get: tags: - Reports summary: GET a Report of a VI case translated to the selected language, in the format that was selected description: This endpoint will allow you to get a Intelligent Damage Detection report parameters: - name: imageCaptureId in: path required: true schema: type: string format: uuid - name: commandId in: path required: true schema: type: string format: uuid - name: language in: path required: true schema: type: string - name: format in: path required: true schema: type: string - name: X-Data-Region in: header description: Enter the region for the image capture to be stored. Example format 'solera-uk' required: true schema: type: string responses: '200': description: Returns a response with a VI report. content: text/plain: schema: type: string format: binary application/json: schema: type: string format: binary text/json: schema: type: string format: binary '400': description: Returns an error if the request fails validation content: text/plain: schema: type: object additionalProperties: type: string application/json: schema: type: object additionalProperties: type: string text/json: schema: type: object additionalProperties: type: string '500': description: Sorry, an unexpected error has occurred '401': description: Returns an error if the user is not authorised /api/v1/Template: post: tags: - Template summary: Add a Template associated to an EntityId description: '' requestBody: description: '' content: application/json-patch+json: schema: $ref: '#/components/schemas/TemplateReqViewModel' application/json: schema: $ref: '#/components/schemas/TemplateReqViewModel' text/json: schema: $ref: '#/components/schemas/TemplateReqViewModel' application/*+json: schema: $ref: '#/components/schemas/TemplateReqViewModel' responses: '201': description: Returns a created response '404': description: Not Found content: text/plain: schema: type: string application/json: schema: type: string text/json: schema: type: string '400': description: Returns an error if the request fails validation content: text/plain: schema: type: string application/json: schema: type: string text/json: schema: type: string '401': description: Returns an error if the user is not authorised '500': description: Sorry, an unexpected error has occurred get: tags: - Template summary: Get the template list description: This endpoint will allow you to get the Template List responses: '200': description: Returns the template list content: text/plain: schema: type: array items: $ref: '#/components/schemas/TemplateResViewModel' application/json: schema: type: array items: $ref: '#/components/schemas/TemplateResViewModel' text/json: schema: type: array items: $ref: '#/components/schemas/TemplateResViewModel' '400': description: Returns a bad request if there is no template content: text/plain: schema: type: string application/json: schema: type: string text/json: schema: type: string '401': description: Returns an error if the user is not authorised content: text/plain: schema: type: string application/json: schema: type: string text/json: schema: type: string '404': description: Returns an error if any template do not exist content: text/plain: schema: type: string application/json: schema: type: string text/json: schema: type: string /api/v1/Template/{id}: get: tags: - Template summary: Get the template for a given id description: This endpoint will allow you to get the Template for an Id parameters: - name: id in: path description: templateId required: true schema: type: string format: uuid responses: '200': description: Returns the template for the id content: text/plain: schema: $ref: '#/components/schemas/TemplateResViewModel' application/json: schema: $ref: '#/components/schemas/TemplateResViewModel' text/json: schema: $ref: '#/components/schemas/TemplateResViewModel' '401': description: Returns an error if the user is not authorised content: text/plain: schema: type: string application/json: schema: type: string text/json: schema: type: string '404': description: Returns an error if the template do not exist content: text/plain: schema: type: string application/json: schema: type: string text/json: schema: type: string '500': description: Sorry, an unexpected error has occurred content: text/plain: schema: type: string application/json: schema: type: string text/json: schema: type: string put: tags: - Template summary: Update the template description: This endpoint will allow you to update the Template parameters: - name: id in: path required: true schema: type: string format: uuid requestBody: content: application/json-patch+json: schema: $ref: '#/components/schemas/TemplateReqViewModel' application/json: schema: $ref: '#/components/schemas/TemplateReqViewModel' text/json: schema: $ref: '#/components/schemas/TemplateReqViewModel' application/*+json: schema: $ref: '#/components/schemas/TemplateReqViewModel' responses: '204': description: Returns no content '400': description: Returns a bad request if there is no template content: text/plain: schema: type: object additionalProperties: type: string application/json: schema: type: object additionalProperties: type: string text/json: schema: type: object additionalProperties: type: string '404': description: Returns an error if any template do not exist content: text/plain: schema: type: string application/json: schema: type: string text/json: schema: type: string '500': description: Returns an error if any template cannot be updated content: text/plain: schema: type: string application/json: schema: type: string text/json: schema: type: string /api/v1/Template/{templateId}: delete: tags: - Template summary: Delete Template description: This endpoint will allow you to delete a template. parameters: - name: templateId in: path description: '' required: true schema: type: string format: uuid responses: '200': description: Returns an Ok response '400': description: Returns an error if the request fails validation or if no template is found content: text/plain: schema: type: object additionalProperties: type: string application/json: schema: type: object additionalProperties: type: string text/json: schema: type: object additionalProperties: type: string '404': description: Returns an error if the template does not exist content: text/plain: schema: type: string application/json: schema: type: string text/json: schema: type: string '500': description: Sorry, an unexpected error has occurred '401': description: Returns an error if the user is not authorized /api/v1/Template/Default: get: tags: - Template summary: Get the default template description: This endpoint will allow you to get the Default Template responses: '200': description: Returns the default template content: text/plain: schema: $ref: '#/components/schemas/TemplateResViewModel' application/json: schema: $ref: '#/components/schemas/TemplateResViewModel' text/json: schema: $ref: '#/components/schemas/TemplateResViewModel' '400': description: Returns a bad request if there is no template content: text/plain: schema: type: string application/json: schema: type: string text/json: schema: type: string '401': description: Returns an error if the user is not authorised content: text/plain: schema: type: string application/json: schema: type: string text/json: schema: type: string '404': description: Returns an error if any template do not exist content: text/plain: schema: type: string application/json: schema: type: string text/json: schema: type: string '500': description: Indicates an internal server error or an unexpected error occurred content: text/plain: schema: type: string application/json: schema: type: string text/json: schema: type: string /api/v1/Template/Default/{name}: put: tags: - Template summary: Update the default template description: This endpoint will allow you to update the default Template parameters: - name: name in: path required: true schema: type: string responses: '204': description: Returns no content '400': description: Returns a bad request if there is no template content: text/plain: schema: type: object additionalProperties: type: string application/json: schema: type: object additionalProperties: type: string text/json: schema: type: object additionalProperties: type: string '404': description: Returns an error if any template do not exist content: text/plain: schema: type: string application/json: schema: type: string text/json: schema: type: string '500': description: Returns an error if any template cannot be updated content: text/plain: schema: type: string application/json: schema: type: string text/json: schema: type: string /api/v1/Vass: post: tags: - Vass summary: Creates a new Video Assessment instance description: This endpoint proxies a POST request to the external Video Assessment Service requestBody: description: The video assessment creation request payload content: application/json-patch+json: schema: $ref: '#/components/schemas/VideoAssessmentModel' application/json: schema: $ref: '#/components/schemas/VideoAssessmentModel' text/json: schema: $ref: '#/components/schemas/VideoAssessmentModel' application/*+json: schema: $ref: '#/components/schemas/VideoAssessmentModel' responses: '201': description: Successfully created the assessment content: text/plain: schema: $ref: '#/components/schemas/VassCreateResponseM' application/json: schema: $ref: '#/components/schemas/VassCreateResponseM' text/json: schema: $ref: '#/components/schemas/VassCreateResponseM' '400': description: Validation error content: text/plain: schema: type: object additionalProperties: type: string application/json: schema: type: object additionalProperties: type: string text/json: schema: type: object additionalProperties: type: string '500': description: Unexpected error from downstream service /api/v1/Vass/{vassId}: get: tags: - Vass summary: Get an existing Video Assessment instance details by ID description: This endpoint proxies a GET request to the external Video Assessment Service parameters: - name: vassId in: path required: true schema: type: string format: uuid responses: '200': description: Successfully retrieved the assessment content: text/plain: schema: $ref: '#/components/schemas/VassInstanceDetailsM' application/json: schema: $ref: '#/components/schemas/VassInstanceDetailsM' text/json: schema: $ref: '#/components/schemas/VassInstanceDetailsM' '400': description: Validation error content: text/plain: schema: type: object additionalProperties: type: string application/json: schema: type: object additionalProperties: type: string text/json: schema: type: object additionalProperties: type: string '500': description: Unexpected error from downstream service /api/v1/Vehicle/Get: get: tags: - Vehicle summary: Get details of a vehicle by vehicleId description: The details return about the vehicle are controlled via the OAuth2 scopes. parameters: - name: vehicleId in: query description: The id of the vehicle schema: type: string format: uuid responses: '200': description: Returns the vehicle details content: text/plain: schema: $ref: '#/components/schemas/VehicleResponseVM' application/json: schema: $ref: '#/components/schemas/VehicleResponseVM' text/json: schema: $ref: '#/components/schemas/VehicleResponseVM' '400': description: Returns an error if the request fails validation content: text/plain: schema: type: object additionalProperties: type: string application/json: schema: type: object additionalProperties: type: string text/json: schema: type: object additionalProperties: type: string '401': description: Returns an error if the user is not authorised deprecated: true /api/v1/ViDamagedParts: post: tags: - ViDamagedParts summary: POST Vi DamagedParts request description: This endpoint will allow you to request a VI DamagedParts requestBody: description: '' content: application/json-patch+json: schema: $ref: '#/components/schemas/ViDamagedPartsReqVM' application/json: schema: $ref: '#/components/schemas/ViDamagedPartsReqVM' text/json: schema: $ref: '#/components/schemas/ViDamagedPartsReqVM' application/*+json: schema: $ref: '#/components/schemas/ViDamagedPartsReqVM' responses: '202': description: Returns an accepted response. The CalculationId returned, can be used in subsequent GET requests for ViDamagedParts. content: text/plain: schema: $ref: '#/components/schemas/CalculationSelfViewModel' application/json: schema: $ref: '#/components/schemas/CalculationSelfViewModel' text/json: schema: $ref: '#/components/schemas/CalculationSelfViewModel' '400': description: Returns an error if the request fails validation or if the imageCapture cannot be found or if the imageCapture status is not yet complete content: text/plain: schema: type: object additionalProperties: type: string application/json: schema: type: object additionalProperties: type: string text/json: schema: type: object additionalProperties: type: string '500': description: Sorry, an unexpected error has occurred '401': description: Returns an error if the user is not authorised /api/v1/ViDamagedParts/{imageCaptureId}/{calculationId}: get: tags: - ViDamagedParts summary: GET a VI DamagedParts request description: This endpoint will allow you to get the details of a VI DamagedParts parameters: - name: imageCaptureId in: path description: '' required: true schema: type: string format: uuid - name: calculationId in: path description: '' required: true schema: type: string format: uuid responses: '200': description: Returns a response with the details of a ViDamagedParts content: text/plain: schema: $ref: '#/components/schemas/ViDamagedPartsRespVM' application/json: schema: $ref: '#/components/schemas/ViDamagedPartsRespVM' text/json: schema: $ref: '#/components/schemas/ViDamagedPartsRespVM' '400': description: Returns an error if the request fails validation content: text/plain: schema: type: object additionalProperties: type: string application/json: schema: type: object additionalProperties: type: string text/json: schema: type: object additionalProperties: type: string '500': description: Sorry, an unexpected error has occurred '401': description: Returns an error if the user is not authorised /api/v1/Video: post: tags: - Video summary: Upload a File description: This endpoint will allow a file to be uploaded responses: '201': description: Returns a created response with the imageId content: text/plain: schema: $ref: '#/components/schemas/SelfViewModel' application/json: schema: $ref: '#/components/schemas/SelfViewModel' text/json: schema: $ref: '#/components/schemas/SelfViewModel' '400': description: Returns an error if the request fails validation content: text/plain: schema: type: object additionalProperties: type: string application/json: schema: type: object additionalProperties: type: string text/json: schema: type: object additionalProperties: type: string '500': description: Sorry, an unexpected error has occurred '401': description: Returns an error if the user is not authorised get: tags: - Video summary: Get content of a file by fileId description: This API will allow you to get a file stream parameters: - name: fileId in: query description: The id of the file required: true schema: type: string format: uuid responses: '200': description: Returns the file stream content: text/plain: schema: $ref: '#/components/schemas/Stream' application/json: schema: $ref: '#/components/schemas/Stream' text/json: schema: $ref: '#/components/schemas/Stream' '400': description: Returns an error if the request fails validation content: text/plain: schema: type: object additionalProperties: type: string application/json: schema: type: object additionalProperties: type: string text/json: schema: type: object additionalProperties: type: string '401': description: Returns an error if the user is not authorised delete: tags: - Video summary: delete content of a file by fileId description: This API will allow you to delete a file stream parameters: - name: fileId in: query description: The id of the file required: true schema: type: string format: uuid responses: '200': description: Returns the file stream content: text/plain: schema: $ref: '#/components/schemas/Stream' application/json: schema: $ref: '#/components/schemas/Stream' text/json: schema: $ref: '#/components/schemas/Stream' '400': description: Returns an error if the request fails validation content: text/plain: schema: type: object additionalProperties: type: string application/json: schema: type: object additionalProperties: type: string text/json: schema: type: object additionalProperties: type: string '401': description: Returns an error if the user is not authorised /api/v1/Video/Info: post: tags: - Video summary: Create a file space in the service to be used to upload a file stream description: This endpoint will create the file data necessary in DB to upload a file requestBody: description: '' content: application/json-patch+json: schema: $ref: '#/components/schemas/FileModel' application/json: schema: $ref: '#/components/schemas/FileModel' text/json: schema: $ref: '#/components/schemas/FileModel' application/*+json: schema: $ref: '#/components/schemas/FileModel' responses: '201': description: Returns a created response with the fileId content: text/plain: schema: $ref: '#/components/schemas/SelfViewModel' application/json: schema: $ref: '#/components/schemas/SelfViewModel' text/json: schema: $ref: '#/components/schemas/SelfViewModel' '400': description: Returns an error if the request fails validation content: text/plain: schema: type: object additionalProperties: type: string application/json: schema: type: object additionalProperties: type: string text/json: schema: type: object additionalProperties: type: string '500': description: Sorry, an unexpected error has occurred '401': description: Returns an error if the user is not authorised /api/v1/ViFullCalculation: post: tags: - ViFullCalculation summary: POST Full VI Calculation request description: This endpoint will allow you to request a Full VI Calculation parameters: - name: X-Data-Region in: header description: Enter the region for the image capture to be stored. Example format 'solera-uk' required: true schema: type: string requestBody: description: '' content: application/json-patch+json: schema: $ref: '#/components/schemas/ViFullCalculationReqVM' application/json: schema: $ref: '#/components/schemas/ViFullCalculationReqVM' text/json: schema: $ref: '#/components/schemas/ViFullCalculationReqVM' application/*+json: schema: $ref: '#/components/schemas/ViFullCalculationReqVM' responses: '202': description: Returns an accepted response. The CalculationId returned, can be used in subsequent GET requests for viFullCalculation. content: text/plain: schema: $ref: '#/components/schemas/CalculationSelfViewModel' application/json: schema: $ref: '#/components/schemas/CalculationSelfViewModel' text/json: schema: $ref: '#/components/schemas/CalculationSelfViewModel' '500': description: Sorry, an unexpected error has occurred '400': description: Returns an error if the request fails validation or if the imageCapture cannot be found or if the imageCapture status is not yet complete '401': description: Returns an error if the user is not authorised /api/v1/ViFullCalculation/{imageCaptureId}/{calculationId}: get: tags: - ViFullCalculation summary: GET a Full VI Calculation response description: This endpoint will allow you to get the details of Full VI Calculation parameters: - name: imageCaptureId in: path description: '' required: true schema: type: string format: uuid - name: calculationId in: path description: '' required: true schema: type: string format: uuid - name: X-Data-Region in: header description: Enter the region for the image capture to be stored. Example format 'solera-uk' required: true schema: type: string responses: '200': description: Returns a response with the details of a Full VI Calculation content: text/plain: schema: $ref: '#/components/schemas/ViFullCalculationRespVM' application/json: schema: $ref: '#/components/schemas/ViFullCalculationRespVM' text/json: schema: $ref: '#/components/schemas/ViFullCalculationRespVM' '500': description: Sorry, an unexpected error has occurred '400': description: Returns an error if the request fails validation '401': description: Returns an error if the user is not authorised /api/v1/ViNoCalculation: post: tags: - ViNoCalculation summary: POST VI Calculation request description: This endpoint will allow you to request a VI Calculation parameters: - name: X-Data-Region in: header description: Enter the region for the image capture to be stored. Example format 'solera-uk' required: true schema: type: string requestBody: description: '' content: application/json-patch+json: schema: $ref: '#/components/schemas/ViNoCalculationReqVM' application/json: schema: $ref: '#/components/schemas/ViNoCalculationReqVM' text/json: schema: $ref: '#/components/schemas/ViNoCalculationReqVM' application/*+json: schema: $ref: '#/components/schemas/ViNoCalculationReqVM' responses: '202': description: Returns an accepted response. The CalculationId returned, can be used in subsequent GET requests for viNoCalculation. content: text/plain: schema: $ref: '#/components/schemas/CalculationSelfViewModel' application/json: schema: $ref: '#/components/schemas/CalculationSelfViewModel' text/json: schema: $ref: '#/components/schemas/CalculationSelfViewModel' '500': description: Sorry, an unexpected error has occurred '400': description: Returns an error if the request fails validation or if the imageCapture cannot be found or if the imageCapture status is not yet complete '401': description: Returns an error if the user is not authorised /api/v1/ViNoCalculation/{imageCaptureId}/{calculationId}: get: tags: - ViNoCalculation summary: GET a VI Calculation request description: This endpoint will allow you to get the details of a VI Calculation parameters: - name: imageCaptureId in: path description: '' required: true schema: type: string format: uuid - name: calculationId in: path description: '' required: true schema: type: string format: uuid - name: X-Data-Region in: header description: Enter the region for the image capture to be stored. Example format 'solera-uk' required: true schema: type: string responses: '200': description: Returns a response with the details of a VI Calculation content: text/plain: schema: $ref: '#/components/schemas/ViNoCalculationRespVM' application/json: schema: $ref: '#/components/schemas/ViNoCalculationRespVM' text/json: schema: $ref: '#/components/schemas/ViNoCalculationRespVM' '500': description: Sorry, an unexpected error has occurred '400': description: Returns an error if the request fails validation '401': description: Returns an error if the user is not authorised /api/v1/ViNoCalculation/{imageCaptureId}/{calculationId}/images/{imageId}/{format}: get: tags: - ViNoCalculation summary: GET an image of a VI Calculation request, with contours description: This endpoint will allow you to get an image of a VI Calculation request, with contours parameters: - name: imageCaptureId in: path description: '' required: true schema: type: string format: uuid - name: calculationId in: path description: '' required: true schema: type: string format: uuid - name: imageId in: path description: '' required: true schema: type: string format: uuid - name: format in: path description: '' required: true schema: type: string default: binary - name: contourThickness in: query description: '' schema: type: integer format: int32 default: 3 - name: X-Data-Region in: header description: Enter the region for the image capture to be stored. Example format 'solera-uk' required: true schema: type: string responses: '200': description: Returns a response with the image of a VI Calculation with contours '204': description: Returns no content '400': description: Returns an error if the request fails validation '401': description: Returns an error if the user is not authorised '500': description: Sorry, an unexpected error has occurred /api/v2/ViNoCalculation: post: tags: - ViNoCalculation summary: POST VI Calculation V2 request description: This endpoint will allow you to request a VI Calculation V2 parameters: - name: X-Data-Region in: header description: Enter the region for the image capture to be stored. Example format 'solera-uk' required: true schema: type: string requestBody: description: '' content: application/json-patch+json: schema: $ref: '#/components/schemas/ViNoCalculationV2ReqVM' application/json: schema: $ref: '#/components/schemas/ViNoCalculationV2ReqVM' text/json: schema: $ref: '#/components/schemas/ViNoCalculationV2ReqVM' application/*+json: schema: $ref: '#/components/schemas/ViNoCalculationV2ReqVM' responses: '202': description: Returns an accepted response. The CalculationId returned, can be used in subsequent GET requests for viNoCalculation V2. content: text/plain: schema: $ref: '#/components/schemas/CalculationSelfViewModel' application/json: schema: $ref: '#/components/schemas/CalculationSelfViewModel' text/json: schema: $ref: '#/components/schemas/CalculationSelfViewModel' '400': description: Returns an error if the request fails validation or if the imageCapture cannot be found or if the imageCapture status is not yet complete content: text/plain: schema: $ref: '#/components/schemas/ProblemDetails' application/json: schema: $ref: '#/components/schemas/ProblemDetails' text/json: schema: $ref: '#/components/schemas/ProblemDetails' '401': description: Returns an error if the user is not authorised content: text/plain: schema: $ref: '#/components/schemas/ProblemDetails' application/json: schema: $ref: '#/components/schemas/ProblemDetails' text/json: schema: $ref: '#/components/schemas/ProblemDetails' '500': description: Sorry, an unexpected error has occurred /api/v2/ViNoCalculation/{imageCaptureId}/{calculationId}: get: tags: - ViNoCalculation summary: GET a VI Calculation V2 request description: This endpoint will allow you to get the details of a VI Calculation V2 parameters: - name: imageCaptureId in: path description: '' required: true schema: type: string format: uuid - name: calculationId in: path description: '' required: true schema: type: string format: uuid - name: X-Data-Region in: header description: Enter the region for the image capture to be stored. Example format 'solera-uk' required: true schema: type: string responses: '200': description: Returns a response with the details of a VI Calculation V2 content: text/plain: schema: $ref: '#/components/schemas/ViNoCalculationV2RespVM' application/json: schema: $ref: '#/components/schemas/ViNoCalculationV2RespVM' text/json: schema: $ref: '#/components/schemas/ViNoCalculationV2RespVM' '400': description: Returns an error if the request fails validation content: text/plain: schema: $ref: '#/components/schemas/ProblemDetails' application/json: schema: $ref: '#/components/schemas/ProblemDetails' text/json: schema: $ref: '#/components/schemas/ProblemDetails' '401': description: Returns an error if the user is not authorised content: text/plain: schema: $ref: '#/components/schemas/ProblemDetails' application/json: schema: $ref: '#/components/schemas/ProblemDetails' text/json: schema: $ref: '#/components/schemas/ProblemDetails' '500': description: Sorry, an unexpected error has occurred /api/v1/Webhooks: get: tags: - Webhooks summary: Gets all Webhooks description: This API returns all the Webhook entities responses: '200': description: Returns collection of webhooks content: text/plain: schema: type: array items: $ref: '#/components/schemas/WebhookResViewModel' application/json: schema: type: array items: $ref: '#/components/schemas/WebhookResViewModel' text/json: schema: type: array items: $ref: '#/components/schemas/WebhookResViewModel' '400': description: Returns an error if collection of webhook cannot be retrieved content: text/plain: schema: $ref: '#/components/schemas/ProblemDetails' application/json: schema: $ref: '#/components/schemas/ProblemDetails' text/json: schema: $ref: '#/components/schemas/ProblemDetails' '500': description: Sorry, an unexpected error has occurred '401': description: Returns an error if the user is not authorised post: tags: - Webhooks summary: Creates a new Webhook description: This API creates a new Webhook requestBody: content: application/json-patch+json: schema: $ref: '#/components/schemas/WebhookReqViewModel' application/json: schema: $ref: '#/components/schemas/WebhookReqViewModel' text/json: schema: $ref: '#/components/schemas/WebhookReqViewModel' application/*+json: schema: $ref: '#/components/schemas/WebhookReqViewModel' responses: '201': description: Successfully created the new Webhook content: text/plain: schema: $ref: '#/components/schemas/SelfViewModel' application/json: schema: $ref: '#/components/schemas/SelfViewModel' text/json: schema: $ref: '#/components/schemas/SelfViewModel' '400': description: Returns an error if request fails validation or if webhook cannot be created content: text/plain: schema: $ref: '#/components/schemas/ProblemDetails' application/json: schema: $ref: '#/components/schemas/ProblemDetails' text/json: schema: $ref: '#/components/schemas/ProblemDetails' '500': description: Sorry, an unexpected error has occurred '401': description: Returns an error if the user is not authorised /api/v1/Webhooks/{id}: get: tags: - Webhooks summary: Gets Webhook by Id description: This API returns Webhook for given id parameters: - name: id in: path required: true schema: type: string format: uuid responses: '200': description: Returns Webhook for given id content: text/plain: schema: $ref: '#/components/schemas/WebhookResViewModel' application/json: schema: $ref: '#/components/schemas/WebhookResViewModel' text/json: schema: $ref: '#/components/schemas/WebhookResViewModel' '400': description: Returns an error if request fails validation or if cannot retrieve webhook content: text/plain: schema: $ref: '#/components/schemas/ProblemDetails' application/json: schema: $ref: '#/components/schemas/ProblemDetails' text/json: schema: $ref: '#/components/schemas/ProblemDetails' '500': description: Sorry, an unexpected error has occurred '401': description: Returns an error if the user is not authorised delete: tags: - Webhooks summary: Deletes a Webhook description: Deletes a Webhook for a given Id parameters: - name: id in: path description: Id of Webhook to delete required: true schema: type: string format: uuid responses: '200': description: Deleted the Webhook successfully '400': description: Returns an error if the request fails validation, e.g. Id NotFound content: text/plain: schema: $ref: '#/components/schemas/ProblemDetails' application/json: schema: $ref: '#/components/schemas/ProblemDetails' text/json: schema: $ref: '#/components/schemas/ProblemDetails' '500': description: Sorry, an unexpected error has occurred '401': description: Returns an error if the user is not authorised put: tags: - Webhooks summary: Updates a Webhook description: Updates a Webhook with given id to state given parameters: - name: id in: path description: Id of Webhook to update required: true schema: type: string format: uuid requestBody: description: New state of Webhook content: application/json-patch+json: schema: $ref: '#/components/schemas/WebhookUpdViewModel' application/json: schema: $ref: '#/components/schemas/WebhookUpdViewModel' text/json: schema: $ref: '#/components/schemas/WebhookUpdViewModel' application/*+json: schema: $ref: '#/components/schemas/WebhookUpdViewModel' responses: '200': description: Successfully updated the Webhook '400': description: Returns an error if the request fails validation or if no matching webhook can be found content: text/plain: schema: $ref: '#/components/schemas/ProblemDetails' application/json: schema: $ref: '#/components/schemas/ProblemDetails' text/json: schema: $ref: '#/components/schemas/ProblemDetails' '500': description: Sorry, an unexpected error has occurred '401': description: Returns an error if the user is not authorised /api/v1/Webhooks/debug: get: tags: - Webhooks summary: Returns webhook debug information by imageCaptureId and optional event types parameters: - name: imageCaptureId in: query description: The source identifier (e.g., imageCaptureId) schema: type: string format: uuid - name: events in: query description: Optional list of event types (e.g., sent, delivered, etc.) schema: type: array items: type: string responses: '200': description: Returns debug events content: text/plain: schema: type: array items: $ref: '#/components/schemas/WebhookDebugEventViewModel' application/json: schema: type: array items: $ref: '#/components/schemas/WebhookDebugEventViewModel' text/json: schema: type: array items: $ref: '#/components/schemas/WebhookDebugEventViewModel' '400': description: Invalid input or downstream error content: text/plain: schema: $ref: '#/components/schemas/ProblemDetails' application/json: schema: $ref: '#/components/schemas/ProblemDetails' text/json: schema: $ref: '#/components/schemas/ProblemDetails' '500': description: Unexpected server error '401': description: Unauthorized content: text/plain: schema: $ref: '#/components/schemas/ProblemDetails' application/json: schema: $ref: '#/components/schemas/ProblemDetails' text/json: schema: $ref: '#/components/schemas/ProblemDetails' '403': description: Forbidden content: text/plain: schema: $ref: '#/components/schemas/ProblemDetails' application/json: schema: $ref: '#/components/schemas/ProblemDetails' text/json: schema: $ref: '#/components/schemas/ProblemDetails' '404': description: Not Found content: text/plain: schema: $ref: '#/components/schemas/ProblemDetails' application/json: schema: $ref: '#/components/schemas/ProblemDetails' text/json: schema: $ref: '#/components/schemas/ProblemDetails' components: schemas: AddressResponseVM: type: object properties: line1: type: string description: Street address / P.O. Box nullable: true line2: type: string description: Additional address data nullable: true line3: type: string description: Locality nullable: true line4: type: string description: City / Postal Town nullable: true line5: type: string description: County / Province / State nullable: true line6: type: string description: Postal Code / ZIP nullable: true country: type: string nullable: true latitude: type: number format: double nullable: true longitude: type: number format: double nullable: true additionalProperties: false AiTriageCode: enum: - FRAUD_CHECK - TOTAL_LOSS - TOW_TRUCK - DAMAGE_SEVERITY - IMAGE_METADATA - AREA_SEVERITY type: string AiTriageReqV2VM: required: - countryCode - imageCaptureId type: object properties: imageCaptureId: type: string description: The imageCaptureId format: uuid countryCode: $ref: '#/components/schemas/Country' codes: type: array items: $ref: '#/components/schemas/AiTriageCode' description: List of AI Triage codes nullable: true clientReferenceID: maxLength: 250 minLength: 1 type: string description: Data sent by external system as cross reference nullable: true additionalProperties: false AiTriageRespVM: type: object properties: status: type: string description: Status message nullable: true totalLoss: $ref: '#/components/schemas/TotalLossRespVM' errors: type: array items: $ref: '#/components/schemas/ViErrorViewModel' description: Error messages nullable: true additionalProperties: false AppDetail: type: object properties: name: type: string nullable: true description: type: string nullable: true assemblyVersion: type: string nullable: true fileVersion: type: string nullable: true productVersion: type: string nullable: true applicationType: type: string nullable: true readOnly: true productAlignment: $ref: '#/components/schemas/ProductAlignment' domainAlignment: $ref: '#/components/schemas/DomainAlignment' scopes: type: array items: $ref: '#/components/schemas/Scope' nullable: true additionalProperties: false AppointmentViewModel: type: object properties: id: type: string description: Appointment Id format: uuid reservation: $ref: '#/components/schemas/ReservationViewModel' additionalProperties: false description: The appointment details AssessmentImageRequestVM: required: - assessmentId - images type: object properties: assessmentId: type: string description: The assessmentId to add the images to format: uuid images: type: array items: $ref: '#/components/schemas/ImageRequestVM' description: The list of images additionalProperties: false AssessmentReqViewModel: required: - assessmentNumber - originator - vehicle type: object properties: assessmentNumber: maxLength: 50 minLength: 1 type: string description: The assessment number originator: maxLength: 50 minLength: 1 type: string description: The originator Id for the assessment vehicle: $ref: '#/components/schemas/AssessmentVehicleReqViewModel' additionalProperties: false AssessmentVehicleReqViewModel: required: - licencePlate type: object properties: licencePlate: maxLength: 10 minLength: 1 type: string description: The licence plate of vehicle mileage: maximum: 50 minimum: 0 type: integer description: The mileage of vehicle format: int32 nullable: true additionalProperties: false AssessmentViewModel: type: object properties: id: type: string description: The Id of the assesment format: uuid externalAssessmentId: type: string description: The external assessment Id nullable: true assessmentNumber: type: string description: The assessment number nullable: true originator: type: string description: The originator Id for the assessment nullable: true additionalProperties: false description: Details of an assessment associated with the claim AssetIdentifier: enum: - VIN type: string AssetPropertiesReqVM: required: - axManufacturer - axModel - axModelOptions - axSubModel - bodyType - make - model - year type: object properties: make: minLength: 1 type: string model: minLength: 1 type: string year: minLength: 1 type: string bodyType: minLength: 1 type: string axManufacturer: minLength: 1 type: string axModel: minLength: 1 type: string axSubModel: minLength: 1 type: string axModelOptions: minLength: 1 type: string additionalProperties: false AuthenticationViewModel: required: - type type: object properties: type: $ref: '#/components/schemas/WebhookAuthType' username: type: string description: username for Basic authentication. Required when authentication type is Basic. nullable: true password: type: string description: password for Basic authentication. Required when authentication type is Basic. nullable: true client_id: type: string description: client_id for OAuth2 authentication. Required when authentication type is OAuth2. nullable: true client_secret: type: string description: client_secret for OAuth2 authentication. Required when authentication type is OAuth2. nullable: true authenticationUri: type: string description: Uri of the authentication server to retrieve OAuth2 tokens. Required when authentication type is OAuth2. nullable: true scope: type: string description: "This value will be sent as scope property when retrieveng the OAuth2 token. It is Optional but it\ \ is only\r\nadmitted if authentication type is OAuth2." nullable: true additionalProperties: false BubbleModel: type: object properties: id: type: integer format: int32 name: type: string nullable: true additionalProperties: false CalculationSelfViewModel: type: object properties: calculationId: type: string format: uuid self: type: string nullable: true warnings: type: array items: type: string nullable: true additionalProperties: false ClaimRepairerRespViewModel: type: object properties: rank: type: integer format: int32 repairerName: type: string nullable: true repairerId: type: string format: uuid clientRepairerId: type: integer format: int32 terminalId: type: string nullable: true latitude: type: number format: double longitude: type: number format: double customFields: type: array items: $ref: '#/components/schemas/RAMCustomField' nullable: true distance: $ref: '#/components/schemas/RamGenericData' duration: $ref: '#/components/schemas/RamGenericData' ncrPerformance: type: number format: double nullable: true priority: type: boolean isWarranty: type: boolean additionalProperties: false ClaimRepairersClaimViewModel: required: - claimNumber - clientKey - incidentDateTimeUTC - policyNumber type: object properties: clientKey: type: string format: uuid claimNumber: minLength: 1 type: string policyNumber: minLength: 1 type: string incidentDateTimeUTC: type: string format: date-time additionalProperties: false ClaimRepairersReqViewModel: required: - claim - insured - numberOfResultsPerScheme - vehicle - vehicleLocation type: object properties: claim: $ref: '#/components/schemas/ClaimRepairersClaimViewModel' vehicle: $ref: '#/components/schemas/VehicleViewModel' vehicleLocation: $ref: '#/components/schemas/LocationViewModel' insured: $ref: '#/components/schemas/InsuredViewModel' numberOfResultsPerScheme: maximum: 4294967295 minimum: 1 type: integer format: int32 additionalProperties: false ClaimReqViewModel: required: - claimId - externalAssessmentId type: object properties: claimId: type: string description: The claim Id for the assessment to be associated with format: uuid externalAssessmentId: maxLength: 50 minLength: 1 type: string description: The external assessment Id of the assessment to be created assessmentNumber: maxLength: 50 type: string description: The assessment number nullable: true originator: maxLength: 50 type: string description: The originator Id for the assessment nullable: true additionalProperties: false description: Claim to Allocation request View Model ClaimRespViewModel: type: object properties: id: type: string description: ClaimId format: uuid claim: $ref: '#/components/schemas/ClaimViewModel' appointment: $ref: '#/components/schemas/AppointmentViewModel' repairer: $ref: '#/components/schemas/RepairerViewModel' assessments: type: array items: $ref: '#/components/schemas/AssessmentViewModel' description: List of associated assessments nullable: true additionalProperties: false description: Claim Response view model for the Get request ClaimViewModel: type: object properties: claimNumber: type: string description: Claim number nullable: true uniqueClientkey: type: string description: Unique client key nullable: true policyNumber: type: string description: Policy number against the claim nullable: true parties: type: array items: $ref: '#/components/schemas/PartyViewModel' description: List of parties if any exist against the claim nullable: true additionalProperties: false description: The claim details ClientConfigurationReqViewModel: required: - dataExpirationMonths type: object properties: id: type: string format: uuid dataExpirationMonths: maximum: 36 minimum: 1 type: integer format: int32 additionalProperties: false ClientConfigurationResViewModel: type: object properties: dataExpirationMonths: type: integer format: int32 additionalProperties: false CommunicationStatus: enum: - Sent - Delivered - Undelivered - Error - Unknown type: string CommunicationType: enum: - SMS - Whatsapp type: string Country: enum: - UK - ZA - US - CA - FR - IE - RO - PL - CH - AD - AR - AU - AT - AZ - BH - BY - BE - BA - BW - BR - BG - CL - CN - CO - CR - HR - CZ - DK - DO - EC - SV - EE - FI - GF - DE - GR - GP - GT - HN - HU - IS - IN - ID - IL - IT - JP - KR - KW - LV - LT - LU - MY - MT - MQ - MX - MD - ME - MA - NA - NL - NC - NZ - NI - 'NO' - OM - PA - PE - PT - PR - MK - RU - RE - SA - RS - SG - SK - SI - ES - SE - TW - TR - UA - AE - GB - VE type: string DimensionResponseVM: type: object properties: area: $ref: '#/components/schemas/ValueUnitResponseVM' width: $ref: '#/components/schemas/ValueUnitResponseVM' length: $ref: '#/components/schemas/ValueUnitResponseVM' additionalProperties: false DomainAlignment: type: object properties: domainContext: type: string nullable: true additionalProperties: false EnvironmentVariableTarget: enum: - Process - User - Machine type: string ErrorModel: type: object properties: code: type: string nullable: true message: type: string nullable: true isNoError: type: boolean readOnly: true isCreated: type: boolean readOnly: true isAccepted: type: boolean readOnly: true isInternalError: type: boolean readOnly: true isBadRequest: type: boolean readOnly: true isNotFoundError: type: boolean readOnly: true isUnauthorizedCodeError: type: boolean readOnly: true isBadGatewayError: type: boolean readOnly: true getHttpCode: type: integer format: int32 readOnly: true additionalProperties: false ErrorViewModel: type: object properties: code: type: string nullable: true message: type: string nullable: true additionalProperties: false EstimaticImageAttachmentRequestVM: required: - country - sourceSystem - sourceSystemKey type: object properties: sourceSystemKey: maxLength: 250 minLength: 1 type: string description: "Key of the estimating source system\r\nthat you wish to upload the images for" sourceSystem: $ref: '#/components/schemas/EstimatingSourceSystem' country: $ref: '#/components/schemas/Country' attachmentType: $ref: '#/components/schemas/ImageAttachmentType' additionalProperties: false EstimatingSourceSystem: enum: - AEG - ADXE - Qapter type: string ExternalImageRequestV2Images: type: object properties: imageId: type: string format: uuid filename: type: string nullable: true description: type: string nullable: true type: type: string nullable: true tags: type: array items: type: string nullable: true additionalProperties: false FileModel: type: object properties: filename: maxLength: 200 type: string nullable: true description: type: string nullable: true type: $ref: '#/components/schemas/FileType' collectionId: type: string format: uuid nullable: true additionalProperties: false FileType: enum: - MP4 - AVI - MOV - WAV type: string HeroImageModel: type: object properties: id: type: string format: uuid filename: type: string nullable: true description: type: string nullable: true height: type: integer format: int32 nullable: true width: type: integer format: int32 nullable: true dateCreated: type: string format: date-time dateUpdated: type: string format: date-time nullable: true deleteAfter: type: string format: date-time nullable: true additionalProperties: false HeroImageVM: required: - base64EncodedImage type: object properties: usageType: $ref: '#/components/schemas/ImageUsageType' base64EncodedImage: minLength: 1 type: string description: The image data as a Base64 encoded string filename: maxLength: 200 type: string description: The file name of the image nullable: true description: type: string description: Description of the image nullable: true additionalProperties: false ICExternalImageRespVM: type: object properties: imageId: type: string format: uuid image: type: string nullable: true tags: type: array items: $ref: '#/components/schemas/Tag' nullable: true clientReferenceImageId: type: string description: Reference id setting by the client for this particular image nullable: true additionalProperties: false ICExternalImageVM: required: - base64EncodedImage type: object properties: base64EncodedImage: minLength: 1 type: string description: The image data as a Base64 encoded string tags: type: array items: $ref: '#/components/schemas/Tag' description: Tags associated with this Image nullable: true clientReferenceImageId: type: string description: Reference id setting by the client for this particular image nullable: true additionalProperties: false ICExternalReqVM: required: - clientReferenceId - images type: object properties: clientReferenceId: maxLength: 255 minLength: 1 type: string description: Customer unique reference Id asset: $ref: '#/components/schemas/ImageCaptureAssetIdentifierReqVM' images: type: array items: $ref: '#/components/schemas/ICExternalImageVM' description: Images associated with this ImageRequest jobId: type: string description: Job for the Image Capture to be linked with format: uuid nullable: true additionalProperties: false ICExternalRespVM: type: object properties: images: type: array items: $ref: '#/components/schemas/ICExternalImageRespVM' nullable: true clientReferenceId: type: string nullable: true asset: $ref: '#/components/schemas/ImageCaptureAssetIdentifierResVM' status: $ref: '#/components/schemas/ImageCaptureStatusType' jobId: type: string format: uuid nullable: true additionalProperties: false ICExternalSelfVM: type: object properties: id: type: string format: uuid self: type: string nullable: true error: $ref: '#/components/schemas/ErrorModel' additionalProperties: false ICExternalV2ImageInfoReqVM: required: - type type: object properties: filename: maxLength: 200 type: string nullable: true description: type: string nullable: true tags: type: array items: $ref: '#/components/schemas/Tag' nullable: true type: $ref: '#/components/schemas/ImageType' additionalProperties: false ICExternalV2ReqVM: required: - clientReferenceId type: object properties: clientReferenceId: maxLength: 255 minLength: 1 type: string description: Customer unique reference Id asset: $ref: '#/components/schemas/ImageCaptureAssetIdentifierReqVM' collectionId: type: string description: Image CollectionId format: uuid nullable: true jobId: type: string description: Job for this ImageRequest to be linked with format: uuid nullable: true expiryDate: maximum: 30 minimum: 1 type: integer format: int32 nullable: true images: type: array items: $ref: '#/components/schemas/ICExternalV2ImageInfoReqVM' description: List of images information to be initialized nullable: true additionalProperties: false ICExternalV2RespVM: type: object properties: images: type: array items: $ref: '#/components/schemas/ExternalImageRequestV2Images' nullable: true clientReferenceId: type: string nullable: true asset: $ref: '#/components/schemas/ImageCaptureAssetIdentifierResVM' status: $ref: '#/components/schemas/ImageCaptureStatusType' jobId: type: string format: uuid nullable: true additionalProperties: false ImageAttachmentRequestVM: required: - estimaticImageAttachment - imageCaptureId type: object properties: imageCaptureId: type: string format: uuid estimaticImageAttachment: $ref: '#/components/schemas/EstimaticImageAttachmentRequestVM' additionalProperties: false ImageAttachmentRespVM: type: object properties: input: nullable: true output: $ref: '#/components/schemas/OutputViewModel' additionalProperties: false ImageAttachmentSelfViewModel: type: object properties: imageAttachmentId: type: string format: uuid self: type: string nullable: true additionalProperties: false ImageAttachmentType: enum: - All - Owner type: string ImageCaptureAssetIdentifierReqVM: required: - identifier - value type: object properties: identifier: $ref: '#/components/schemas/AssetIdentifier' value: maxLength: 255 minLength: 1 type: string description: Value against the identifier assetProperties: $ref: '#/components/schemas/AssetPropertiesReqVM' additionalProperties: false ImageCaptureAssetIdentifierResVM: type: object properties: identifier: type: string nullable: true value: type: string nullable: true properties: type: array items: $ref: '#/components/schemas/ImageCaptureAssetPropertyRespVM' nullable: true additionalProperties: false ImageCaptureAssetPropertyRespVM: type: object properties: key: type: string nullable: true value: type: string nullable: true additionalProperties: false ImageCaptureAudiosResVM: type: object properties: id: type: string format: uuid pageId: type: string format: uuid name: type: string nullable: true url: type: string nullable: true additionalProperties: false ImageCaptureCommunicationResVM: type: object properties: id: type: string format: uuid recipient: $ref: '#/components/schemas/ImageCaptureRecipientVM' message: type: string nullable: true from: type: string nullable: true type: $ref: '#/components/schemas/CommunicationType' status: $ref: '#/components/schemas/ImageCaptureStatusType' deliveryStatus: $ref: '#/components/schemas/CommunicationStatus' dateSent: $ref: '#/components/schemas/ImageCaptureDateViewModel' enableLineTypeIntelligence: type: boolean template: type: string nullable: true variables: type: object additionalProperties: type: string nullable: true nullable: true reminders: $ref: '#/components/schemas/ReminderConfigModel' additionalProperties: false ImageCaptureCommunicationVM: required: - from - recipient - type type: object properties: recipient: $ref: '#/components/schemas/ImageCaptureRecipientVM' from: maxLength: 150 minLength: 1 type: string description: The name of the sender message: maxLength: 300 type: string description: The message to be sent in SMS. The API will substitute {IC_URL} for the image request link and {IC_PIN} for the image request pin. nullable: true type: $ref: '#/components/schemas/CommunicationType' shortUrl: maxLength: 50 type: string description: The short Url for the image capture link nullable: true enableLineTypeIntelligence: type: boolean description: "Enable the line type intelligence, it means when there is a communication,\r\nwe validate the line\ \ type of the phone number." template: type: string nullable: true variables: type: object additionalProperties: type: string nullable: true nullable: true reminders: $ref: '#/components/schemas/ReminderConfigModel' additionalProperties: false ImageCaptureCustomerCommentResVM: type: object properties: comment: type: string nullable: true additionalProperties: false ImageCaptureCustomerSurveyRatingResVM: type: object properties: starRating: type: integer format: int32 comment: type: string nullable: true bubbles: type: array items: $ref: '#/components/schemas/BubbleModel' nullable: true additionalProperties: false ImageCaptureDateViewModel: type: object properties: utc: type: string format: date-time local: type: string format: date-time additionalProperties: false ImageCaptureImageResVM: type: object properties: id: type: string format: uuid externalImageId: type: string format: uuid nullable: true pageType: $ref: '#/components/schemas/PageType' tags: type: array items: $ref: '#/components/schemas/Tag' nullable: true isFromLibrary: type: boolean readOnly: true pageId: type: string format: uuid nullable: true quality: $ref: '#/components/schemas/Quality' data: type: string nullable: true additionalProperties: false ImageCapturePageConfigurationVM: required: - pages type: object properties: pages: type: array items: $ref: '#/components/schemas/ImageCapturePageVM' description: List of pages that are to be displayed as part of the image request additionalProperties: false ImageCapturePageVM: required: - displayOrder - pageType type: object properties: id: type: string description: Page Id format: uuid pageType: $ref: '#/components/schemas/PageType' overrideTitle: maxLength: 500 type: string description: If the value is null then the defaulting title is shown nullable: true overrideText: maxLength: 4000 type: string description: "If the value is null then the defaulting text is shown\r\nThis will be ignored in Damage Photos page" nullable: true heroImageId: type: string description: If the value is not found then the default hero image is shown format: uuid nullable: true surveySchema: description: "Set the value of the Survey Schema for SurveyPages\r\nThis will be ignored in Damage Photos page" nullable: true acknowledgeText: type: string description: Set the value of the checkbox from Survey page and Digital Signature page nullable: true isImageRequired: type: boolean description: "If set to true then an image is required for this page.\r\nThis will be ignored in Confirm Vehicle\ \ page and Damage Photos page, as pictures\r\nare mandatory for those pages." minimumImages: maximum: 10 minimum: 1 type: integer description: "Minimum number of images that must be uploaded in this page.\r\nif IsImageRequired is set\ \ to false, then this value is ignored." format: int32 nullable: true maximumImages: maximum: 2147483647 minimum: 1 type: integer description: Maximum number of images that must be uploaded in this page. format: int32 nullable: true isVideoRequired: type: boolean description: If set to true then a video is required for this page. displayOrder: maximum: 99 minimum: 1 type: integer description: Sets the display order for the page format: int32 isOnlyDamagePhotoRequired: type: boolean description: "If set to true then only damage image is required for Damage Photos page.\r\nThis will be ignored\ \ in the other page types" isMultiplePictureEnable: type: boolean description: If set to true then multiple pictures can be uploaded for this page nullable: true initialDamageTitle: maxLength: 500 type: string description: "If the value is null then the defaulting title is shown\r\nOnly available for Damage Photos page,\ \ on the first step (Indicate damage)" nullable: true initialDamageText: maxLength: 4000 type: string description: "If the value is null then the defaulting text is shown\r\nOnly available for Damage Photos page, on\ \ the first step (Indicate damage)" nullable: true photosDamageTitle: maxLength: 500 type: string description: "If the value is null then the defaulting title is shown\r\nOnly available for Damage Photos page,\ \ on the second step (Required photos)" nullable: true photosDamageText: maxLength: 4000 type: string description: "If the value is null then the defaulting text is shown\r\nOnly available for Damage Photos page, on\ \ the second step (Required photos)" nullable: true completeDamageTitle: maxLength: 500 type: string description: "If the value is null then the defaulting title is shown\r\nOnly available for Damage Photos page,\ \ on the third step (Damage summary)" nullable: true completeDamageText: maxLength: 4000 type: string description: "If the value is null then the defaulting text is shown\r\nOnly available for Damage Photos page, on\ \ the third step (Damage summary)" nullable: true pointOfImpact: description: Set the value of the PointOfImpact for PointOfImpactPages nullable: true disableGalleryUpload: type: boolean description: If set to true then pictures from gallery can not be uploaded for this page nullable: true units: type: string description: Only If the mileage page is selected, this field will hold the unit value nullable: true validateVin: type: integer description: "If set, the VIN lenght will be validated to the number provided, only 16 and 17 are allowed\r\nOnly\ \ available for Confirm Vehicle page" format: int32 nullable: true tags: type: array items: type: string description: Set the list of tags for this page nullable: true isAudioRequired: type: boolean description: If set to true then audio is required for this page additionalProperties: false ImageCaptureQueryResViewModel: type: object properties: id: type: string format: uuid nullable: true status: $ref: '#/components/schemas/ImageCaptureStatusType' deliveryStatus: type: string nullable: true dateSent: type: string format: date-time nullable: true isLinkOpened: type: boolean nullable: true expiryDays: type: integer format: int32 nullable: true remindersSent: type: integer format: int32 nullable: true link: type: string nullable: true clientReferenceId: type: string nullable: true vin: type: string nullable: true qrLink: type: string nullable: true additionalProperties: false ImageCaptureRecipientVM: required: - dialingCode - mobileNumber type: object properties: dialingCode: maxLength: 5 minLength: 1 type: string description: Dialing code for mobile number. Format +XX mobileNumber: maxLength: 11 minLength: 8 type: string description: The Mobile number where Image capture SMS will be sent. lineType: type: string description: The LineType of the mobile number. nullable: true additionalProperties: false ImageCaptureReqViewModel: required: - linkExpiryDays - pageConfiguration - timeZone type: object properties: linkExpiryDays: maximum: 30 minimum: 1 type: integer description: Set the time in days that the image request link will expire in. format: int32 language: type: string description: Set the language for the image capture UI. Optionally supply the culture code (RFC 4646), e.g. 'en-US'; defaults to 'en-GB' if not provided. nullable: true timeZone: $ref: '#/components/schemas/TimeZone' styling: $ref: '#/components/schemas/ImageCaptureStylingVM' pageConfiguration: $ref: '#/components/schemas/ImageCapturePageConfigurationVM' clientReferenceId: maxLength: 255 type: string description: Customer unique reference Id nullable: true asset: $ref: '#/components/schemas/ImageCaptureAssetIdentifierReqVM' communication: $ref: '#/components/schemas/ImageCaptureCommunicationVM' disableGalleryUpload: type: boolean description: Flag to set if a user can upload images from their gallery on their mobile device termsAndConditionsUrl: maxLength: 500 type: string description: Set the Terms and Conditions Url, a default will display if null nullable: true settings: description: Settings configuration for image capture nullable: true enableVin: type: boolean description: "Enable the vin validation, it means when a vin number is sent, the global vin is \r\ncalled, if this\ \ property is false, the endpoint is not called to get the car\r\nidentification." disableLink: type: boolean description: Flag to indicate whether a user is allowed to send links other than the GIC link. country: $ref: '#/components/schemas/RequestCountry' templateName: type: string description: get templates by template name nullable: true jobId: type: string description: Job for the Image Capture to be linked with format: uuid nullable: true additionalProperties: false ImageCaptureResCommunicationVM: type: object properties: communicationId: type: string format: uuid nullable: true status: $ref: '#/components/schemas/ImageCaptureStatusType' dateSent: type: string format: date-time dateReceived: type: string format: date-time errorMessage: type: string nullable: true additionalProperties: false ImageCaptureResViewModel: type: object properties: id: type: string format: uuid clientReferenceId: type: string nullable: true link: type: string nullable: true dateCreated: $ref: '#/components/schemas/ImageCaptureDateViewModel' isLinkOpened: type: boolean dateOpened: $ref: '#/components/schemas/ImageCaptureDateViewModel' dateCompleted: $ref: '#/components/schemas/ImageCaptureDateViewModel' status: $ref: '#/components/schemas/ImageCaptureStatusType' linkExpiryDays: type: integer format: int32 jobId: type: string format: uuid nullable: true images: type: array items: $ref: '#/components/schemas/ImageCaptureImageResVM' nullable: true videos: type: array items: $ref: '#/components/schemas/ImageCaptureVideosResVM' nullable: true audios: type: array items: $ref: '#/components/schemas/ImageCaptureAudiosResVM' nullable: true styling: $ref: '#/components/schemas/ImageCaptureStylingVM' pageConfiguration: $ref: '#/components/schemas/ImageCapturePageConfigurationVM' language: type: string description: Language culture code for the image request UI. (RFC 4646), i.e. 'en-US' nullable: true accessCode: type: string nullable: true qrLink: type: string description: Base64-encoded QR code image containing IC_Link/PIN nullable: true pin: type: string nullable: true originatingRegion: type: string nullable: true timeZone: $ref: '#/components/schemas/ImageCaptureTimeZoneVM' asset: $ref: '#/components/schemas/ImageCaptureAssetIdentifierResVM' communications: type: array items: $ref: '#/components/schemas/ImageCaptureCommunicationResVM' nullable: true customerSurveyRating: $ref: '#/components/schemas/ImageCaptureCustomerSurveyRatingResVM' customerComment: $ref: '#/components/schemas/ImageCaptureCustomerCommentResVM' disableGalleryUpload: type: boolean description: Flag to set if a user can upload images from their gallery on their mobile device termsAndConditionsUrl: type: string nullable: true userInputs: type: array items: $ref: '#/components/schemas/ImageCaptureUserInputResVM' nullable: true settings: nullable: true country: $ref: '#/components/schemas/RequestCountry' enableVin: type: boolean description: "Enable the vin validation, it means when a vin number is sent, the global vin is \r\ncalled, if this\ \ property is false, the endpoint is not called to get the car\r\nidentification." disableLink: type: boolean lastVisitedPage: type: integer format: int32 nullable: true additionalProperties: false ImageCaptureSelfViewModel: type: object properties: id: type: string format: uuid self: type: string nullable: true responseCommunication: $ref: '#/components/schemas/ImageCaptureResCommunicationVM' error: $ref: '#/components/schemas/ErrorModel' warnings: type: array items: $ref: '#/components/schemas/WarningModel' nullable: true additionalProperties: false ImageCaptureStatusType: enum: - Pending - Expired - Completed type: string ImageCaptureStylingModel: type: object properties: logoId: type: string format: uuid nullable: true logo: type: string format: byte nullable: true primaryHex: type: string nullable: true secondaryHex: type: string nullable: true buttonHex: type: string nullable: true additionalProperties: false ImageCaptureStylingVM: required: - buttonHex - primaryHex - secondaryHex type: object properties: logoId: type: string description: LogoId for entity logo mapping format: uuid nullable: true logo: type: string description: Logo to be used when rendering the image capture on the UI. This must be 250KB or less of .png format data. format: byte nullable: true primaryHex: minLength: 1 pattern: ^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$ type: string description: 'Primary Hex colour of the format #000000. Used for header background.' secondaryHex: minLength: 1 pattern: ^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$ type: string description: 'Secondary Hex colour of the format #000000. Used for header border and submit button' buttonHex: minLength: 1 pattern: ^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$ type: string description: 'Button Hex colour of the format #000000. Used for the primary buttons' additionalProperties: false ImageCaptureTimeZoneModel: type: object properties: name: type: string nullable: true offset: type: integer format: int32 additionalProperties: false ImageCaptureTimeZoneVM: type: object properties: name: type: string nullable: true offset: type: integer format: int32 additionalProperties: false ImageCaptureUserInputResVM: type: object properties: userInputId: type: string format: uuid property: type: string nullable: true unit: type: string nullable: true propertyValue: nullable: true tags: type: array items: type: string nullable: true additionalProperties: false ImageCaptureUsingTemplateCommunicationVM: required: - recipient type: object properties: recipient: $ref: '#/components/schemas/ImageCaptureRecipientVM' from: maxLength: 150 type: string description: The name of the sender nullable: true message: maxLength: 300 type: string description: The message to be sent in SMS. The API will substitute {IC_URL} for the image request link and {IC_PIN} for the image request pin. nullable: true type: $ref: '#/components/schemas/CommunicationType' shortUrl: maxLength: 50 type: string description: The short Url for the image capture link nullable: true template: type: string nullable: true variables: type: object additionalProperties: type: string nullable: true nullable: true reminders: $ref: '#/components/schemas/ReminderConfigModel' additionalProperties: false ImageCaptureUsingTemplateReqViewModel: required: - templateName type: object properties: linkExpiryDays: maximum: 30 minimum: 1 type: integer description: Set the time in days that the image request link will expire in. format: int32 nullable: true language: type: string description: Set the language for the image capture UI. Optional; if not provided, defaults to "en-GB". nullable: true timeZone: $ref: '#/components/schemas/TimeZone' styling: $ref: '#/components/schemas/ImageCaptureStylingVM' pageConfiguration: $ref: '#/components/schemas/ImageCapturePageConfigurationVM' clientReferenceId: maxLength: 255 type: string description: Customer unique reference Id nullable: true asset: $ref: '#/components/schemas/ImageCaptureAssetIdentifierReqVM' communication: $ref: '#/components/schemas/ImageCaptureUsingTemplateCommunicationVM' disableGalleryUpload: type: boolean description: Flag to set if a user can upload images from their gallery on their mobile device nullable: true termsAndConditionsUrl: maxLength: 500 type: string description: Set the Terms and Conditions Url, a default will display if null nullable: true settings: description: Settings configuration for image capture nullable: true enableVin: type: boolean description: "Enable the vin validation, it means when a vin number is sent, the global vin is \r\ncalled, if this\ \ property is false, the endpoint is not called to get the car\r\nidentification." nullable: true disableLink: type: boolean description: Flag to indicate whether a user is allowed to send links other than the GIC link. nullable: true country: $ref: '#/components/schemas/RequestCountry' templateName: minLength: 1 type: string description: get templates by template name additionalProperties: false ImageCaptureVideosResVM: type: object properties: id: type: string format: uuid pageId: type: string format: uuid name: type: string nullable: true url: type: string nullable: true additionalProperties: false ImageMetadataRespModel: type: object properties: imageId: type: string format: uuid imageMetadata: nullable: true systemMetadata: nullable: true userMetadata: nullable: true additionalProperties: false ImageRequestResponseVM: type: object properties: id: type: string format: uuid dateCreated: type: string format: date-time dateCompleted: type: string format: date-time status: type: string nullable: true images: type: array items: $ref: '#/components/schemas/SelfModel' nullable: true additionalProperties: false ImageRequestVM: required: - base64EncodedImage - type type: object properties: usageType: $ref: '#/components/schemas/ImageUsageType' type: $ref: '#/components/schemas/ImageType' base64EncodedImage: minLength: 1 type: string description: The image data as a Base64 encoded string filename: maxLength: 200 type: string description: The file name of the image nullable: true description: type: string description: Description of the image nullable: true additionalProperties: false ImageType: enum: - Png - Jpeg - Svg type: string ImageUsageType: enum: - Regular - Hero - Logo type: string InsuredViewModel: required: - name type: object properties: name: type: string additionalProperties: false JobReqViewModel: type: object properties: id: type: string format: uuid name: maxLength: 50 type: string nullable: true additionalProperties: false JobResViewModel: type: object properties: id: type: string format: uuid name: type: string nullable: true additionalProperties: false LocationViewModel: required: - latitude - longitude type: object properties: latitude: maximum: 90 minimum: -90 type: number format: double longitude: maximum: 180 minimum: -180 type: number format: double additionalProperties: false LogElevationRequest: type: object properties: logLevel: $ref: '#/components/schemas/LogLevel' duration: type: string format: date-span additionalProperties: false LogLevel: enum: - Trace - Debug - Information - Warning - Error - Critical - None type: string LogLevelResponse: type: object properties: logLevel: $ref: '#/components/schemas/LogLevel' until: type: string format: date-time additionalProperties: false LogoImageRespModel: type: object properties: id: type: string format: uuid filename: type: string nullable: true description: type: string nullable: true height: type: integer format: int32 nullable: true width: type: integer format: int32 nullable: true dateCreated: type: string format: date-time dateUpdated: type: string format: date-time nullable: true deleteAfter: type: string format: date-time additionalProperties: false LogoImageVM: required: - base64EncodedImage type: object properties: usageType: $ref: '#/components/schemas/ImageUsageType' base64EncodedImage: minLength: 1 type: string description: The image data as a Base64 encoded string filename: maxLength: 200 type: string description: The file name of the image nullable: true description: type: string description: Description of the image nullable: true additionalProperties: false OfferAssetModel: type: object properties: id: type: string format: uuid identifier: type: string nullable: true value: type: string nullable: true properties: type: array items: $ref: '#/components/schemas/OfferAssetPropertyModel' nullable: true additionalProperties: false OfferAssetPropertyModel: type: object properties: id: type: string format: uuid property: type: string nullable: true value: type: string nullable: true additionalProperties: false OfferCommunicationResViewModel: type: object properties: id: type: string format: uuid recipient: $ref: '#/components/schemas/ImageCaptureRecipientVM' message: type: string nullable: true from: type: string nullable: true type: $ref: '#/components/schemas/CommunicationType' status: $ref: '#/components/schemas/ImageCaptureStatusType' deliveryStatus: $ref: '#/components/schemas/CommunicationStatus' dateSent: $ref: '#/components/schemas/ImageCaptureDateViewModel' enableLineTypeIntelligence: type: boolean template: type: string nullable: true variables: type: object additionalProperties: type: string nullable: true nullable: true additionalProperties: false description: "ViewModel for communication response data in Offer.\r\nMatches the structure of ImageCaptureCommunicationResVM\ \ for API consistency." OfferDetailsModel: required: - currency - offerAmount - vehicle type: object properties: currency: maxLength: 3 minLength: 1 type: string offerAmount: minLength: 1 type: string repairs: type: object additionalProperties: type: string nullable: true nullable: true vehicle: $ref: '#/components/schemas/VehicleOfferModel' customFields: type: object additionalProperties: type: string nullable: true nullable: true additionalProperties: false OfferDetailsViewModel: required: - currency - offerAmount - vehicle type: object properties: currency: maxLength: 3 minLength: 1 type: string description: Currency code (e.g., USD, EUR, GBP) offerAmount: minLength: 1 type: string description: Offer amount as string to preserve decimal formatting repairs: type: object additionalProperties: type: string nullable: true description: Repairs details (key-value pairs) nullable: true vehicle: $ref: '#/components/schemas/VehicleOfferViewModel' customFields: type: object additionalProperties: type: string nullable: true description: Custom fields (key-value pairs) nullable: true additionalProperties: false description: ViewModel for Offer details in Intelligent Offer request OfferImageModel: type: object properties: page: type: string nullable: true imageRequestPageId: type: string format: uuid nullable: true image: $ref: '#/components/schemas/OfferImageSelfModel' additionalProperties: false OfferImageSelfModel: type: object properties: id: type: string format: uuid self: type: string nullable: true additionalProperties: false OfferPageConfigurationModel: type: object properties: pages: type: array items: $ref: '#/components/schemas/OfferPageModel' nullable: true additionalProperties: false OfferPageModel: type: object properties: id: type: string format: uuid page: type: string nullable: true pageTitle: type: string nullable: true pageText: type: string nullable: true heroImageId: type: string format: uuid nullable: true isImageRequired: type: boolean minimumImages: type: integer format: int32 nullable: true maximumImages: type: integer format: int32 nullable: true displayOrder: type: integer format: int32 surveySchema: nullable: true acknowledgeText: type: string nullable: true isOnlyDamagePhotoRequired: type: boolean isMultiplePictureEnable: type: boolean initialDamageTitle: type: string nullable: true initialDamageText: type: string nullable: true photosDamageTitle: type: string nullable: true photosDamageText: type: string nullable: true completeDamageTitle: type: string nullable: true completeDamageText: type: string nullable: true isVideoRequired: type: boolean pointOfImpact: nullable: true disableGalleryUpload: type: boolean units: type: string nullable: true validateVin: type: integer format: int32 nullable: true tags: type: array items: type: string nullable: true isAudioRequired: type: boolean additionalProperties: false OfferQueryField: enum: - Id - Status - OfferStatus - DeliveryStatus - DateSent - IsLinkOpened - ExpiryDays - Link - ClientReferenceId type: string OfferQueryModel: type: object properties: id: type: string format: uuid nullable: true status: type: string nullable: true offerStatus: type: string nullable: true deliveryStatus: type: string nullable: true dateSent: type: string format: date-time nullable: true isLinkOpened: type: boolean nullable: true expiryDays: type: integer format: int32 nullable: true link: type: string nullable: true clientReferenceId: type: string nullable: true additionalProperties: false OfferQueryReqViewModel: type: object properties: fieldsSet: uniqueItems: true type: array items: $ref: '#/components/schemas/OfferQueryField' nullable: true fields: type: string nullable: true defaultFieldNames: type: array items: type: string nullable: true readOnly: true fieldNames: type: array items: type: string nullable: true readOnly: true additionalProperties: false OfferRequestViewModel: required: - clientReferenceId - linkExpiryDays - offer - timeZone type: object properties: clientReferenceId: maxLength: 255 minLength: 1 type: string description: Customer unique reference Id linkExpiryDays: maximum: 30 minimum: 1 type: integer description: Set the time in days that the image request link will expire in (1-30 days) format: int32 language: type: string description: Set the language for the image request UI. Optionally supply the culture code (RFC 4646), e.g. 'en-US'; defaults to 'en-GB' if not provided. nullable: true country: $ref: '#/components/schemas/RequestCountry' timeZone: $ref: '#/components/schemas/TimeZone' termsAndConditionsUrl: maxLength: 500 type: string description: Set the Terms and Conditions Url (max 500 characters) nullable: true settings: description: Settings configuration using JToken (same format as ImageCapture V2) nullable: true offer: $ref: '#/components/schemas/OfferDetailsViewModel' communication: $ref: '#/components/schemas/ImageCaptureCommunicationVM' styling: $ref: '#/components/schemas/ImageCaptureStylingVM' asset: $ref: '#/components/schemas/ImageCaptureAssetIdentifierReqVM' additionalProperties: false description: ViewModel for Intelligent Offer request creation (GIC-4020) OfferResponseViewModel: type: object properties: id: type: string format: uuid clientReferenceId: type: string nullable: true link: type: string nullable: true linkExpiryDays: type: integer format: int32 isLinkOpened: type: boolean language: type: string nullable: true country: $ref: '#/components/schemas/RequestCountry' timeZone: $ref: '#/components/schemas/ImageCaptureTimeZoneModel' originatingRegion: type: string nullable: true termsAndConditionsUrl: type: string nullable: true imageRequestJsonSettings: nullable: true offer: $ref: '#/components/schemas/OfferDetailsModel' styling: $ref: '#/components/schemas/ImageCaptureStylingModel' assetIdentifierType: type: string nullable: true assetValue: type: string nullable: true status: type: string nullable: true accessCode: type: string nullable: true pin: type: string nullable: true disableGalleryUpload: type: boolean enableVin: type: boolean disableLink: type: boolean lastVisitedPage: type: integer format: int32 nullable: true images: type: array items: $ref: '#/components/schemas/OfferImageModel' nullable: true userInputs: type: array items: $ref: '#/components/schemas/OfferUserInputModel' nullable: true pageConfiguration: $ref: '#/components/schemas/OfferPageConfigurationModel' asset: $ref: '#/components/schemas/OfferAssetModel' settings: nullable: true offerStatus: type: string nullable: true dateCreated: $ref: '#/components/schemas/ImageCaptureDateViewModel' dateOpened: $ref: '#/components/schemas/ImageCaptureDateViewModel' dateCompleted: $ref: '#/components/schemas/ImageCaptureDateViewModel' communications: type: array items: $ref: '#/components/schemas/OfferCommunicationResViewModel' description: Communications sent for this offer with full delivery status information nullable: true additionalProperties: false description: "ViewModel for Intelligent Offer response.\r\nExtends the base model with properly typed ViewModels for\ \ nested objects." OfferUserInputModel: type: object properties: userInputId: type: string format: uuid property: type: string nullable: true unit: type: string nullable: true propertyValue: nullable: true tags: type: array items: type: string nullable: true additionalProperties: false OutputViewModel: type: object properties: status: type: string nullable: true errors: type: array items: $ref: '#/components/schemas/ErrorViewModel' nullable: true object: nullable: true additionalProperties: false PageType: enum: - FrontLeft - FrontRight - RearRight - RearLeft - Mileage - VIN - AdHoc - Front - SideLeft - SideRight - Rear - CloseUp - LicenseGeneric - FrontInterior - RearInterior - PoliceReport - RegistrationDocument - Generic - LicenseUAE - Wheels - Blank - ConfirmVehicle - DamagePhotos - Keys - Survey - DigitalSignature - CloseFrontLeft - CloseFrontRight - CloseRearRight - CloseRearLeft - CloseFront - CloseSideLeft - CloseSideRight - CloseRear - FrontWindscreen - RearWindscreen - LicensePlate - VideoUpload - PointOfImpact - DamageCloseUps - Audio - SelfPortrait type: string PartResponseVM: type: object properties: name: type: string nullable: true side: type: string nullable: true additionalProperties: false PartyViewModel: type: object properties: id: type: string description: The Id of the party format: uuid addressId: type: string description: The address Id if one has been associated with the party format: uuid nullable: true vehicleId: type: string description: The vehicle Id if one has been associated with the party format: uuid nullable: true vehicleLocationId: type: string description: The vehicle address / location if one has been associated with the vehicle format: uuid nullable: true partyType: type: string description: The type of party nullable: true additionalProperties: false description: Details of a party associated with the claim PingModel: type: object properties: pingId: type: string format: uuid additionalProperties: false PingResponse: type: object properties: pingId: type: string format: uuid pingResults: type: array items: $ref: '#/components/schemas/PingResult' nullable: true additionalProperties: false PingResult: type: object properties: webhookId: type: string format: uuid callbackUri: type: string nullable: true status: $ref: '#/components/schemas/PingStatus' message: type: string nullable: true additionalProperties: false PingStatus: enum: - Failure - Success type: string ProblemDetails: type: object properties: type: type: string nullable: true title: type: string nullable: true status: type: integer format: int32 nullable: true detail: type: string nullable: true instance: type: string nullable: true additionalProperties: {} ProductAlignment: type: object properties: vertical: type: string nullable: true productCategory: type: string nullable: true product: type: string nullable: true additionalProperties: false Quality: enum: - Ok - TooBlurry - TooDark - TooBright type: string QueryField: enum: - Id - Status - IsLinkOpened - ExpiryDays - DeliveryStatus - DateSent - RemindersSent - Link - ClientReferenceId - VIN - QRLink type: string QueryReqViewModel: type: object properties: fieldsSet: uniqueItems: true type: array items: $ref: '#/components/schemas/QueryField' nullable: true fields: type: string nullable: true defaultFieldNames: type: array items: type: string nullable: true readOnly: true fieldNames: type: array items: type: string nullable: true readOnly: true additionalProperties: false RAMCustomField: type: object properties: fieldId: type: string format: uuid name: type: string nullable: true value: type: string nullable: true additionalProperties: false RamGenericData: type: object properties: text: type: string nullable: true value: type: string nullable: true additionalProperties: false ReminderConfigModel: type: object properties: delays: type: array items: type: integer format: int32 nullable: true reminderMessage: type: string nullable: true additionalProperties: false ReminderReqViewModel: required: - from - recipient - type type: object properties: recipient: $ref: '#/components/schemas/ImageCaptureRecipientVM' from: minLength: 1 type: string message: maxLength: 800 type: string nullable: true type: $ref: '#/components/schemas/CommunicationType' imageRequestId: type: string format: uuid enableLineTypeIntelligence: type: boolean template: type: string nullable: true variables: type: object additionalProperties: type: string nullable: true nullable: true additionalProperties: false RepairerCustomFieldResponseVM: type: object properties: id: type: string format: uuid name: type: string nullable: true type: type: string nullable: true values: type: array items: type: string nullable: true additionalProperties: false RepairerRatesResponseVM: type: object properties: labourRate: type: number format: double nullable: true paintRate: type: number format: double nullable: true paintIndex: type: number format: double nullable: true overallDiscount: type: number format: double nullable: true partsDiscountPcnt: type: number format: double nullable: true sundryPartsPcnt: type: number format: double nullable: true pearlescentPcnt: type: number format: double nullable: true corrosionProtectionMat: type: number format: double nullable: true fixedPricePaintMat: type: number format: double nullable: true additionalProperties: false RepairerRespVM: type: object properties: id: type: string format: uuid name: type: string nullable: true countryCode: type: string nullable: true address: $ref: '#/components/schemas/AddressResponseVM' aliases: type: array items: type: string nullable: true additionalProperties: false RepairerResponseVM: type: object properties: id: type: string format: uuid name: type: string nullable: true internalId: type: string nullable: true addressDetails: $ref: '#/components/schemas/SelfWithAddressResponseVM' emailAddress: type: string nullable: true telephoneNumber: type: string nullable: true aliases: type: array items: type: string nullable: true rates: $ref: '#/components/schemas/RepairerRatesResponseVM' schemes: type: array items: $ref: '#/components/schemas/RepairerSchemeResponseVM' nullable: true customFields: type: array items: $ref: '#/components/schemas/RepairerCustomFieldResponseVM' nullable: true additionalProperties: false RepairerSchemeResponseVM: type: object properties: id: type: string format: uuid name: type: string nullable: true additionalProperties: false RepairerViewModel: type: object properties: id: type: string description: The repairer Id format: uuid name: type: string description: The repairer name nullable: true siteId: type: string description: The site Id nullable: true primaryTerminalId: type: string description: The primar terminal Id nullable: true additionalProperties: false description: The details of the allocated repairer RequestCountry: enum: - DZ - AO - AR - AU - AT - AZ - BH - BY - BE - BA - BR - BN - BG - KH - CA - CL - CN - CO - CR - HR - CY - CZ - DK - EE - FI - FR - GE - DE - GR - HK - HU - IN - ID - IE - IL - IT - JP - KZ - KE - KR - KW - LA - LV - LB - LT - LU - MK - MY - MT - MU - MX - MD - ME - MA - MM - NL - NZ - 'NO' - OM - PA - PE - PH - PL - PT - PR - QA - RO - RU - SA - RS - SG - SK - SI - ZA - ES - LK - SE - CH - TW - TH - TN - TR - UA - AE - GB - US - UY - VE - VN type: string ReservationViewModel: type: object properties: id: type: string description: The Id of the reservation format: uuid entityId: type: string description: The Id of the entity that the reservation was made against format: uuid estimatorId: type: string description: The Id of the estimator that the reservation was made against format: uuid timeSlot: $ref: '#/components/schemas/TimeSlotViewModel' additionalProperties: false description: Details of the reservation ResponseCommunicationM: type: object properties: status: type: string nullable: true dateSent: type: string format: date-time nullable: true errorMessage: type: string nullable: true additionalProperties: false ResponseCommunicationRecipientM: required: - dialingCode - mobileNumber type: object properties: dialingCode: maxLength: 5 minLength: 1 type: string mobileNumber: maxLength: 11 minLength: 8 type: string lineType: type: string nullable: true additionalProperties: false ScaleTo: enum: - NoScale - OneMP - TwoMP - FiveMP - TenMP type: string Scope: type: object properties: name: type: string nullable: true displayName: type: string nullable: true description: type: string nullable: true additionalProperties: false SelfModel: type: object properties: id: type: string format: uuid self: type: string nullable: true communicationId: type: string format: uuid nullable: true warnings: type: array items: $ref: '#/components/schemas/WarningModel' nullable: true communicationErrors: type: array items: $ref: '#/components/schemas/WarningModel' nullable: true images: type: array items: $ref: '#/components/schemas/SelfModel' nullable: true additionalProperties: false SelfViewModel: type: object properties: id: type: string format: uuid self: type: string nullable: true additionalProperties: false SelfWithAddressResponseVM: type: object properties: id: type: string format: uuid line1: type: string nullable: true line2: type: string nullable: true line3: type: string nullable: true line4: type: string nullable: true line5: type: string nullable: true line6: type: string nullable: true country: type: string nullable: true latitude: type: number format: double nullable: true longitude: type: number format: double nullable: true self: type: string nullable: true additionalProperties: false SelfWithErrorModel: type: object properties: id: type: string format: uuid self: type: string nullable: true error: $ref: '#/components/schemas/ErrorModel' additionalProperties: false Stream: type: object properties: canRead: type: boolean readOnly: true canWrite: type: boolean readOnly: true canSeek: type: boolean readOnly: true canTimeout: type: boolean readOnly: true length: type: integer format: int64 readOnly: true position: type: integer format: int64 readTimeout: type: integer format: int32 writeTimeout: type: integer format: int32 additionalProperties: false SupplementaryResponseVM: type: object properties: type: type: string nullable: true probability: type: number format: double part: $ref: '#/components/schemas/PartResponseVM' dimensions: $ref: '#/components/schemas/DimensionResponseVM' foundInImages: type: array items: $ref: '#/components/schemas/SelfModel' nullable: true additionalProperties: false Tag: enum: - wheel - front - rear - left - right - interior - mileage - vin - centre - roof - window - library - digitalSignature - wideAngle - selfPortrait - fullView - closeUp type: string TemplateReqViewModel: required: - body type: object properties: name: maxLength: 50 type: string nullable: true body: {} additionalProperties: false TemplateResViewModel: type: object properties: id: type: string format: uuid name: type: string nullable: true body: nullable: true additionalProperties: false TimeSlotViewModel: type: object properties: slot: type: string description: The slot that was used to create the reservation nullable: true slotNumber: type: string description: "If a day booking was made then this parameter will be visible.\r\nIf a time interval booking was made\ \ then this paramater will not be shown" nullable: true date: type: string description: This is the date the reservation was made for. It will be display in IS0-8601 format (yyyy-mm-dd) nullable: true timeFrom: type: string description: This will only be displayed if a time interval booking was made, e.g. "09:00" nullable: true timeTo: type: string description: This will only be displayed if a time interval booking was made, e.g. "09:30" nullable: true additionalProperties: false description: The details of the reservation time slot TimeZone: enum: - Dateline_Standard_Time - Hawaiian_Standard_Time - Alaskan_Standard_Time - Pacific_Standard_Time - Pacific_Standard_Time_Mexico - Mountain_Standard_Time - Mountain_Standard_Time_Mexico - US_Mountain_Standard_Time - Canada_Central_Standard_Time - Central_America_Standard_Time - Central_Standard_Time - Central_Standard_Time_Mexico - Eastern_Standard_Time - SA_Pacific_Standard_Time - US_Eastern_Standard_Time - Atlantic_Standard_Time - Central_Brazilian_Standard_Time - Pacific_SA_Standard_Time - SA_Western_Standard_Time - Venezuela_Standard_Time - Paraguay_Standard_Time - Newfoundland_Standard_Time - E_South_America_Standard_Time - Greenland_Standard_Time - Montevideo_Standard_Time - SA_Eastern_Standard_Time - Argentina_Standard_Time - Mid_Atlantic_Standard_Time - Azores_Standard_Time - Cabo_Verde_Standard_Time - GMT_Standard_Time - Greenwich_Standard_Time - Morocco_Standard_Time - UTC - Central_Europe_Standard_Time - Central_European_Standard_Time - Romance_Standard_Time - W_Central_Africa_Standard_Time - W_Europe_Standard_Time - Namibia_Standard_Time - E_Europe_Standard_Time - Egypt_Standard_Time - FLE_Standard_Time - GTB_Standard_Time - Israel_Standard_Time - Jordan_Standard_Time - Middle_East_Standard_Time - South_Africa_Standard_Time - Syria_Standard_Time - Turkey_Standard_Time - Arab_Standard_Time - Arabic_Standard_Time - E_Africa_Standard_Time - Kaliningrad_Standard_Time - Russian_Standard_Time - Iran_Standard_Time - Arabian_Standard_Time - Azerbaijan_Standard_Time - Caucasus_Standard_Time - Afghanistan_Standard_Time - Georgian_Standard_Time - Mauritius_Standard_Time - Ekaterinburg_Standard_Time - West_Asia_Standard_Time - India_Standard_Time - Sri_Lanka_Standard_Time - Nepal_Standard_Time - Pakistan_Standard_Time - Central_Asia_Standard_Time - N_Central_Asia_Standard_Time - Myanmar_Standard_Time - Bangladesh_Standard_Time - North_Asia_Standard_Time - SE_Asia_Standard_Time - China_Standard_Time - North_Asia_East_Standard_Time - Singapore_Standard_Time - Taipei_Standard_Time - W_Australia_Standard_Time - Ulaanbaatar_Standard_Time - Korea_Standard_Time - Tokyo_Standard_Time - Yakutsk_Standard_Time - AUS_Central_Standard_Time - Central_Australia_Standard_Time - AUS_Eastern_Standard_Time - E_Australia_Standard_Time - Tasmania_Standard_Time - Vladivostok_Standard_Time - West_Pacific_Standard_Time - Central_Pacific_Standard_Time - Magadan_Standard_Time - Fiji_Standard_Time - New_Zealand_Standard_Time - Tonga_Standard_Time - Samoa_Standard_Time type: string TotalLossRespVM: type: object properties: probability: type: string description: The probability of a correct estimate nullable: true response: type: string description: The value of the estimate nullable: true additionalProperties: false ValidationProblemDetails: type: object properties: errors: type: object additionalProperties: type: array items: type: string nullable: true type: type: string nullable: true title: type: string nullable: true status: type: integer format: int32 nullable: true detail: type: string nullable: true instance: type: string nullable: true additionalProperties: {} ValueUnitResponseVM: type: object properties: value: type: number format: double unit: type: string nullable: true readOnly: true additionalProperties: false VassCreateResponseM: type: object properties: id: type: string nullable: true self: type: string nullable: true additionalProperties: false VassImageM: type: object properties: id: type: string format: uuid self: type: string nullable: true tags: type: array items: type: string nullable: true data: type: string nullable: true additionalProperties: false VassInstanceDetailsM: type: object properties: id: type: string format: uuid assessorLink: type: string nullable: true surveyorLink: type: string nullable: true dateCreated: $ref: '#/components/schemas/VassInstantM' dateCompleted: $ref: '#/components/schemas/VassInstantM' status: type: string nullable: true linkExpiryDays: type: integer format: int32 images: type: array items: $ref: '#/components/schemas/VassImageM' nullable: true videos: type: array items: $ref: '#/components/schemas/VassVideoM' nullable: true language: type: string nullable: true originatingRegion: type: string nullable: true timeZone: $ref: '#/components/schemas/VassTimeZoneM' country: $ref: '#/components/schemas/RequestCountry' responseCommunication: $ref: '#/components/schemas/ResponseCommunicationM' additionalProperties: false VassInstantM: type: object properties: utc: type: string format: date-time local: type: string format: date-time additionalProperties: false VassResponseCommunicationM: required: - from - message - recipient - type type: object properties: recipient: $ref: '#/components/schemas/ResponseCommunicationRecipientM' from: minLength: 1 type: string message: minLength: 1 type: string type: $ref: '#/components/schemas/CommunicationType' additionalProperties: false VassTimeZoneM: type: object properties: name: type: string nullable: true offset: type: integer format: int32 additionalProperties: false VassVideoM: type: object properties: id: type: string nullable: true self: type: string nullable: true additionalProperties: false VehicleDetailResponseVM: type: object properties: id: type: string format: uuid vin: type: string nullable: true licencePlate: type: string nullable: true make: type: string nullable: true model: type: string nullable: true manufacturedYear: type: string nullable: true mileage: type: string nullable: true additionalProperties: false VehicleOfferModel: required: - make - model type: object properties: make: minLength: 1 type: string model: minLength: 1 type: string additionalProperties: false VehicleOfferViewModel: required: - make - model type: object properties: make: minLength: 1 type: string description: Vehicle make (required) model: minLength: 1 type: string description: Vehicle model (required) additionalProperties: false description: Vehicle information for Offer VehicleResponseVM: type: object properties: vehicle: $ref: '#/components/schemas/VehicleDetailResponseVM' supplementary: type: array items: $ref: '#/components/schemas/SupplementaryResponseVM' description: The supplementary information associated with the vehicle nullable: true imageRequest: $ref: '#/components/schemas/ImageRequestResponseVM' additionalProperties: false description: Vehicle Response view model for the Get request VehicleViewModel: required: - make - model - monthRegistered - registration - year type: object properties: registration: minLength: 1 type: string make: minLength: 1 type: string model: minLength: 1 type: string monthRegistered: maximum: 12 minimum: 1 type: integer format: int32 year: maximum: 9999 minimum: 1901 type: integer format: int32 additionalProperties: false ViCalculationDamageRespVM: type: object properties: damageId: type: string format: uuid type: type: string nullable: true probability: type: number format: double part: $ref: '#/components/schemas/ViCalculationPartRespVM' dimensions: $ref: '#/components/schemas/ViCalculationDimensionRespVM' foundInImages: type: array items: $ref: '#/components/schemas/ViCalculationIdWithContoursRespVM' nullable: true additionalProperties: false ViCalculationDimensionRespVM: type: object properties: areaInCmSq: type: number format: double nullable: true widthInCm: type: number format: double nullable: true lengthInCm: type: number format: double nullable: true relativeSize: type: number format: double nullable: true additionalProperties: false ViCalculationIdWithContoursRespVM: type: object properties: id: type: string format: uuid damageContour: type: array items: type: array items: type: number format: double nullable: true additionalProperties: false ViCalculationPartRespVM: type: object properties: name: type: string nullable: true side: type: string nullable: true additionalProperties: false ViCalculationV2DamageRespVM: type: object properties: damageId: type: string format: uuid type: type: string nullable: true probability: type: number format: double relativeSize: type: number format: double nullable: true part: $ref: '#/components/schemas/ViCalculationPartRespVM' foundInImages: type: array items: $ref: '#/components/schemas/ViCalculationIdWithContoursRespVM' nullable: true additionalProperties: false ViDamagedPartsPartsRespVM: type: object properties: standardGuideNumber: type: integer format: int32 nullable: true genericPartName: type: string nullable: true objectDetectionLabels: type: array items: type: string nullable: true p: type: number format: double nullable: true positions: type: array items: type: integer format: int32 nullable: true relatedImageIds: type: array items: type: string format: uuid nullable: true position: $ref: '#/components/schemas/ViDamagedPartsPositionRespVM' additionalProperties: false ViDamagedPartsPositionRespVM: type: object properties: code: type: integer format: int32 nullable: true p: type: number format: double nullable: true additionalProperties: false ViDamagedPartsReqVM: required: - countryCode - imageCaptureId type: object properties: imageCaptureId: type: string description: The imageCaptureId format: uuid countryCode: $ref: '#/components/schemas/Country' additionalProperties: false ViDamagedPartsRespVM: type: object properties: status: type: string nullable: true errors: type: array items: $ref: '#/components/schemas/ViErrorViewModel' nullable: true damagedParts: type: array items: $ref: '#/components/schemas/ViDamagedPartsValueRespVM' nullable: true additionalProperties: false ViDamagedPartsValueRespVM: type: object properties: damagedPartsGroupid: type: string format: uuid p: type: number format: double nullable: true damagedPartsGroup: type: string nullable: true side: type: string nullable: true parts: type: array items: $ref: '#/components/schemas/ViDamagedPartsPartsRespVM' nullable: true additionalProperties: false ViErrorPropertyViewModel: type: object properties: name: type: string nullable: true value: type: string nullable: true additionalProperties: false ViErrorViewModel: type: object properties: code: type: string nullable: true message: type: string nullable: true properties: type: array items: $ref: '#/components/schemas/ViErrorPropertyViewModel' nullable: true additionalProperties: false ViFullCalculationReqVM: required: - countryCode - imageCaptureId - sourceSystem - sourceSystemKey type: object properties: imageCaptureId: type: string description: The imageCaptureId format: uuid sourceSystemKey: maxLength: 250 minLength: 1 type: string description: Data sent by external system as cross reference sourceSystem: $ref: '#/components/schemas/EstimatingSourceSystem' includeContours: type: boolean description: "Include damage contours in the result data\r\nThis will default to false" countryCode: $ref: '#/components/schemas/Country' additionalProperties: false ViFullCalculationRespVM: type: object properties: calculationId: type: string format: uuid additionalProperties: false ViNoCalculationReqVM: required: - countryCode - imageCaptureId type: object properties: imageCaptureId: type: string description: The imageCaptureId format: uuid enhancedVerification: type: boolean description: "EnhancedVerification required\r\nThis will default to false" includeContours: type: boolean description: "Include damage contours in the result data\r\nThis will default to false" countryCode: $ref: '#/components/schemas/Country' additionalProperties: false ViNoCalculationRespVM: type: object properties: status: type: string nullable: true errors: type: array items: $ref: '#/components/schemas/ViErrorViewModel' nullable: true damages: type: array items: $ref: '#/components/schemas/ViCalculationDamageRespVM' nullable: true additionalProperties: false ViNoCalculationV2ReqVM: required: - countryCode - imageCaptureId type: object properties: imageCaptureId: type: string description: The imageCaptureId format: uuid includeContours: type: boolean description: "Include damage contours in the result data\r\nThis will default to false" includeDamagedParts: type: boolean description: "Include damaged parts in the result data\r\nThis will default to false" countryCode: $ref: '#/components/schemas/Country' additionalProperties: false ViNoCalculationV2RespVM: type: object properties: status: type: string nullable: true errors: type: array items: $ref: '#/components/schemas/ViErrorViewModel' nullable: true damagedParts: type: array items: $ref: '#/components/schemas/ViDamagedPartsValueRespVM' nullable: true damages: type: array items: $ref: '#/components/schemas/ViCalculationV2DamageRespVM' nullable: true additionalProperties: false VideoAssessmentModel: required: - country - linkExpiryDays - timeZone type: object properties: linkExpiryDays: maximum: 7 minimum: 1 type: integer format: int32 language: type: string nullable: true timeZone: $ref: '#/components/schemas/TimeZone' settings: nullable: true country: $ref: '#/components/schemas/RequestCountry' communication: $ref: '#/components/schemas/VassResponseCommunicationM' additionalProperties: false WarningModel: type: object properties: message: type: string nullable: true additionalProperties: false WebhookAuthType: enum: - None - Basic - OAuth2 type: string WebhookDebugEventViewModel: type: object properties: webhookId: type: string format: uuid eventType: type: string nullable: true eventName: type: string nullable: true sendDate: type: string format: date-time result: type: string nullable: true isSuccess: type: boolean nullable: true additionalProperties: false WebhookEventType: enum: - ImageRequest_Expired - ImageRequest_Completed - ImageCollection_Estimatic_Attachment_Processed - ImageCollection_Vi_No_Calculation_Processed - ImageCollection_Ai_Triage_Completed - ImageRequest_Deletion_Completed - ImageRequest_Sent - ImageRequest_Reminder - Communication_Delivered - Communication_Undelivered - ImageRequest_Opened - ImageRequest_Delivered - ImageRequest_Undelivered - Ping_Sent type: string WebhookEventViewModel: type: object properties: id: type: integer format: int32 name: type: string nullable: true type: type: string nullable: true additionalProperties: false WebhookReqViewModel: required: - authentication - callbackUri - webhookEvents type: object properties: callbackUri: minLength: 1 type: string authentication: $ref: '#/components/schemas/AuthenticationViewModel' webhookEvents: type: array items: $ref: '#/components/schemas/WebhookEventType' description: Ids for WebhookEvents this webhook is subscribing to additionalProperties: false WebhookResViewModel: type: object properties: id: type: string format: uuid callbackUri: type: string nullable: true authType: $ref: '#/components/schemas/WebhookAuthType' webhookEvents: type: array items: $ref: '#/components/schemas/WebhookEventViewModel' nullable: true additionalProperties: false WebhookUpdViewModel: required: - authentication - callbackUri - id - webhookEvents type: object properties: id: type: string format: uuid callbackUri: minLength: 1 type: string authentication: $ref: '#/components/schemas/AuthenticationViewModel' webhookEvents: type: array items: $ref: '#/components/schemas/WebhookEventType' additionalProperties: false securitySchemes: Bearer: type: apiKey description: "JWT Authorization header using the Bearer scheme. \r\n\r\n Enter 'Bearer' [space] and then your token\ \ in the text input below.\r\n\r\nExample: \"Bearer 12345abcdef\"" name: Authorization in: header security: - Bearer: [] - Bearer: []