InitiateInstall (...)

Introduction
Starts a Verified Install session for one device. Validates the install code, the customer name and the device serial number, and returns an install token that every later call in the session needs.
Call order for one device. To install or swap a device: InitiateInstall, then RegisterDevice, then optionally the device checks (GetDeviceStatus, InitiateDevicePeripheralSetup, ConfigureDevicePeripheral), then exactly one of SubmitInstall or LogSwap. To record a removal or a service visit: InitiateInstall, then optionally GetDeviceStatus (it lists the service types LogService accepts), then exactly one of LogRemoval or LogService. RegisterDevice is not needed for a removal or a service visit. The install token is valid for 24 hours. At most 5 install tokens can be issued for the same serial number in any one hour. This method is available on API version v3 only. Errors (error code): InstallerNameRequired, InstallerCompanyRequired, InvalidInstallCode (the code is not valid or has expired), CustomerNameMismatch (the customer name does not belong to the code), InvalidSerialNumber, DeviceAlreadyOwned (the device is registered to a different account), 5803 (too many install tokens requested for this device), UnsupportedApiVersion.
Parameters

apiKey

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

customerName

Name of the customer the install code was issued to. It must match the code.

installCode

The install code issued for the customer's database.

installerCompany

Company of the installer.

installerName

Full name of the installer.

serialNo

Serial number of the device to install. For LogRemoval this is the device being removed.

sessionId

The session ID of the authenticated caller, as returned by Authenticate. Send null when authenticating with a Bearer token.
Return value
An ApiInitiateInstallResult with the install token and the UTC time it expires.
Remarks
Call order for one device. To install or swap a device: InitiateInstall, then RegisterDevice, then optionally the device checks (GetDeviceStatus, InitiateDevicePeripheralSetup, ConfigureDevicePeripheral), then exactly one of SubmitInstall or LogSwap. To record a removal or a service visit: InitiateInstall, then optionally GetDeviceStatus (it lists the service types LogService accepts), then exactly one of LogRemoval or LogService. RegisterDevice is not needed for a removal or a service visit. The install token is valid for 24 hours. At most 5 install tokens can be issued for the same serial number in any one hour. This method is available on API version v3 only. Errors (error code): InstallerNameRequired, InstallerCompanyRequired, InvalidInstallCode (the code is not valid or has expired), CustomerNameMismatch (the customer name does not belong to the code), InvalidSerialNumber, DeviceAlreadyOwned (the device is registered to a different account), 5803 (too many install tokens requested for this device), UnsupportedApiVersion.
Code samples

Loading API Runner...