SubmitInstall (...)

Introduction
Final step for a new installation. Records the install, with the vehicle details and optional photos, and ends the install session.
Requires RegisterDevice first. An install token can be used for one final call only: after a successful SubmitInstall, LogSwap, LogRemoval or LogService, calling again with the same token fails with error 5800. Errors (error code): VehicleNameRequired, InvalidVin, DeviceNotRegistered, TooManyPhotos, InvalidPhotoData (missing or invalid base64 data, or a file name over 100 characters), UnsupportedMimeType, PhotoTooLarge, 5804 (invalid or expired install token), 5800 (the install token was already submitted), GenericError (the install could not be recorded), UnsupportedApiVersion.
Parameters

apiKey

The API key (user ID) of the authenticated caller, as returned by Authenticate. Send null when authenticating with a Bearer token.

cameraId

Optional. Camera serial number, if a camera is being paired.

comments

Optional. Installer comments.

engineHours

Optional. Engine hours at the time of install.

installToken

The install session token returned by InitiateInstall.

licensePlate

Optional. License plate.

make

Optional. Vehicle make.

model

Optional. Vehicle model.

odometer

Optional. Odometer reading at the time of install. Send odometerUnit with it.

odometerUnit

Optional. Unit of the odometer reading: Kilometers or Miles.

photos

Optional photos to attach, as InstallPhotoUpload items. At most 5 photos, each at most 10 MB once decoded, JPEG or PNG only (HEIC is not accepted).

sessionId

The session ID of the authenticated caller, as returned by Authenticate. Send null when authenticating with a Bearer token.

vehicleName

Name or description of the vehicle.

vin

Vehicle Identification Number.

workOrderReference

Optional. Work order reference number.

year

Optional. Vehicle model year.
Return value
An ApiInstallResult with the record ID, the device serial number, the time of the record and the device communication status.
Remarks
Requires RegisterDevice first. An install token can be used for one final call only: after a successful SubmitInstall, LogSwap, LogRemoval or LogService, calling again with the same token fails with error 5800. Errors (error code): VehicleNameRequired, InvalidVin, DeviceNotRegistered, TooManyPhotos, InvalidPhotoData (missing or invalid base64 data, or a file name over 100 characters), UnsupportedMimeType, PhotoTooLarge, 5804 (invalid or expired install token), 5800 (the install token was already submitted), GenericError (the install could not be recorded), UnsupportedApiVersion.
Code samples

Loading API Runner...