POST apioauth/installations/{installationId}

Complete an installation or service call

Request Information

URI Parameters

Name	Description	Type	Additional information
installationId	The id of the installation	integer	Required

Body Parameters

The CompleteInstallationRequest

CompleteInstallationRequest

Name	Description	Type	Additional information
StartDate	When the installation was started	date	None.
EndDate	When the installation was finished	date	None.
VehicleRegistration	Update the vehicle registration if required	string	None.
Latitude	The latitude where the location took place	decimal number	None.
Longitude	The longitude where the location took place	decimal number	None.
CustomerUnavailable	If the customer was unavailable	boolean	None.
CustomerUnavailableReason	Why the customer was unavailable	string	None.
SignatureData	The signature encoded as a Base64 string	string	None.
SignatureFileName	The name of the signature file	string	None.
CameraInstalled	If a camera was installed	boolean	None.
BuzzerInstalled	If a buzzer was installed	boolean	None.
DriverIdReaderInstalled	If a driver id reader was installed	boolean	None.
PanicButtonInstalled	If a panic button was installed	boolean	None.
KeysReturned	If the keys were returned	boolean	None.
Odometer	The vehicle odometer in metres	integer	None.
IMEISwap	Set to an IMEI if a swap is required	string	None.
SectionsCompleted	The sections completed as a flag/bitmask	Sections	None.
SectionsSkipped	The sections skipped as a flag/bitmask	Sections	None.
Signature2Data	The signature 2 encoded as a Base64 string	string	None.
Signature2FileName	The name of the signature 2 file	string	None.
SupportAgentName	The support agent name	string	None.
CommissionDate	The commission date	date	None.
Notes	Any notes for the install	string	None.
KeypadInstalled	If a keypad was installed	boolean	None.
OtherInstalled	If other hardware was installed	boolean	None.
ImeiRequired	If an imei is required but doesnt need swapping straight away	string	None.
CustomerName	The name of the customer	string	None.
InstallationStatus	The installation status	InstallationStatus	None.
AllKitUsed	If all kit was used	boolean	None.
AnyKitRemoved	If any kit was removed	boolean	None.
KitLeftOnSite	If kit was left on site	boolean	None.
InstallationVideoS3Key	The s3 key for a video	string	None.

Request Formats

application/json, text/json

Sample:

{
  "StartDate": "2025-04-27T16:39:57.4752883+00:00",
  "EndDate": "2025-04-27T16:39:57.4752883+00:00",
  "VehicleRegistration": "sample string 3",
  "Latitude": 4.1,
  "Longitude": 5.1,
  "CustomerUnavailable": true,
  "CustomerUnavailableReason": "sample string 7",
  "SignatureData": "sample string 8",
  "SignatureFileName": "sample string 9",
  "CameraInstalled": true,
  "BuzzerInstalled": true,
  "DriverIdReaderInstalled": true,
  "PanicButtonInstalled": true,
  "KeysReturned": true,
  "Odometer": 15,
  "IMEISwap": "sample string 16",
  "SectionsCompleted": 1,
  "SectionsSkipped": 1,
  "Signature2Data": "sample string 17",
  "Signature2FileName": "sample string 18",
  "SupportAgentName": "sample string 19",
  "CommissionDate": "2025-04-27T16:39:57.4752883+00:00",
  "Notes": "sample string 21",
  "KeypadInstalled": true,
  "OtherInstalled": true,
  "ImeiRequired": "sample string 24",
  "CustomerName": "sample string 25",
  "InstallationStatus": 0,
  "AllKitUsed": true,
  "AnyKitRemoved": true,
  "KitLeftOnSite": true,
  "InstallationVideoS3Key": "sample string 29"
}

application/xml, text/xml

Sample:

<CompleteInstallationRequest xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <StartDate>2025-04-27T16:39:57.4752883+00:00</StartDate>
  <EndDate>2025-04-27T16:39:57.4752883+00:00</EndDate>
  <VehicleRegistration>sample string 3</VehicleRegistration>
  <Latitude>4.1</Latitude>
  <Longitude>5.1</Longitude>
  <CustomerUnavailable>true</CustomerUnavailable>
  <CustomerUnavailableReason>sample string 7</CustomerUnavailableReason>
  <SignatureData>sample string 8</SignatureData>
  <SignatureFileName>sample string 9</SignatureFileName>
  <CameraInstalled>true</CameraInstalled>
  <BuzzerInstalled>true</BuzzerInstalled>
  <DriverIdReaderInstalled>true</DriverIdReaderInstalled>
  <PanicButtonInstalled>true</PanicButtonInstalled>
  <KeysReturned>true</KeysReturned>
  <Odometer>15</Odometer>
  <IMEISwap>sample string 16</IMEISwap>
  <SectionsCompleted>Gallery</SectionsCompleted>
  <SectionsSkipped>Gallery</SectionsSkipped>
  <Signature2Data>sample string 17</Signature2Data>
  <Signature2FileName>sample string 18</Signature2FileName>
  <SupportAgentName>sample string 19</SupportAgentName>
  <CommissionDate>2025-04-27T16:39:57.4752883+00:00</CommissionDate>
  <Notes>sample string 21</Notes>
  <KeypadInstalled>true</KeypadInstalled>
  <OtherInstalled>true</OtherInstalled>
  <ImeiRequired>sample string 24</ImeiRequired>
  <CustomerName>sample string 25</CustomerName>
  <InstallationStatus>Incomplete</InstallationStatus>
  <AllKitUsed>true</AllKitUsed>
  <AnyKitRemoved>true</AnyKitRemoved>
  <KitLeftOnSite>true</KitLeftOnSite>
  <InstallationVideoS3Key>sample string 29</InstallationVideoS3Key>
</CompleteInstallationRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

200 on success

HttpResponseMessage

Name	Type	Additional information
Version	Version	None.
Content	HttpContent	None.
StatusCode	HttpStatusCode	None.
ReasonPhrase	string	None.
Headers	Collection of Object	None.
RequestMessage	HttpRequestMessage	None.
IsSuccessStatusCode	boolean	None.