LogService (...)

Introduction
Final step to record a field service visit with no hardware change, and ends the install session. It does not need RegisterDevice.
Call GetDeviceStatus to get the service types valid for the device. An install token can be used for one final call only (see SubmitInstall). Errors (error code): InvalidServiceType (the response message lists the valid values), ServiceCommentRequired, TooManyPhotos, InvalidPhotoData, UnsupportedMimeType, PhotoTooLarge, 5804 (invalid or expired install token), 5800 (the install token was already submitted), GenericError (the service visit 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 serviced.

engineHours

Optional. Engine hours at the time of the service.

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 the service. 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).

serviceComment

Description of the work performed.

serviceType

Nature of the service visit. Pass a key from the serviceTypes list returned by GetDeviceStatus (for example DEVICE_ISSUE or HARNESS_WIRING_ISSUE). The valid keys vary by device.

sessionId

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

vehicleName

Optional. Name or description of the vehicle.

vin

Optional. Vehicle Identification Number.

workOrderReference

Optional. Work order reference number.

year

Optional. Vehicle model year.
Return value
An ApiServiceResult with the record ID, the device serial number, the service type, the time of the record and the device communication status.
Remarks
Call GetDeviceStatus to get the service types valid for the device. An install token can be used for one final call only (see SubmitInstall). Errors (error code): InvalidServiceType (the response message lists the valid values), ServiceCommentRequired, TooManyPhotos, InvalidPhotoData, UnsupportedMimeType, PhotoTooLarge, 5804 (invalid or expired install token), 5800 (the install token was already submitted), GenericError (the service visit could not be recorded), UnsupportedApiVersion.
Code samples

Loading API Runner...