POST apioauth/installations

Complete multiple installation or service calls together

Request Information

URI Parameters

None.

Body Parameters

A collection of MultipleInstallationRequest

Collection of MultipleInstallationRequest
NameDescriptionTypeAdditional information
InstallationId

The id of the installation

integer

None.

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:
[
  {
    "InstallationId": 1,
    "StartDate": "2025-04-27T16:14:32.599768+00:00",
    "EndDate": "2025-04-27T16:14:32.599768+00:00",
    "VehicleRegistration": "sample string 4",
    "Latitude": 5.1,
    "Longitude": 6.1,
    "CustomerUnavailable": true,
    "CustomerUnavailableReason": "sample string 8",
    "SignatureData": "sample string 9",
    "SignatureFileName": "sample string 10",
    "CameraInstalled": true,
    "BuzzerInstalled": true,
    "DriverIdReaderInstalled": true,
    "PanicButtonInstalled": true,
    "KeysReturned": true,
    "Odometer": 16,
    "IMEISwap": "sample string 17",
    "SectionsCompleted": 1,
    "SectionsSkipped": 1,
    "Signature2Data": "sample string 18",
    "Signature2FileName": "sample string 19",
    "SupportAgentName": "sample string 20",
    "CommissionDate": "2025-04-27T16:14:32.599768+00:00",
    "Notes": "sample string 22",
    "KeypadInstalled": true,
    "OtherInstalled": true,
    "ImeiRequired": "sample string 25",
    "CustomerName": "sample string 26",
    "InstallationStatus": 0,
    "AllKitUsed": true,
    "AnyKitRemoved": true,
    "KitLeftOnSite": true,
    "InstallationVideoS3Key": "sample string 30"
  },
  {
    "InstallationId": 1,
    "StartDate": "2025-04-27T16:14:32.599768+00:00",
    "EndDate": "2025-04-27T16:14:32.599768+00:00",
    "VehicleRegistration": "sample string 4",
    "Latitude": 5.1,
    "Longitude": 6.1,
    "CustomerUnavailable": true,
    "CustomerUnavailableReason": "sample string 8",
    "SignatureData": "sample string 9",
    "SignatureFileName": "sample string 10",
    "CameraInstalled": true,
    "BuzzerInstalled": true,
    "DriverIdReaderInstalled": true,
    "PanicButtonInstalled": true,
    "KeysReturned": true,
    "Odometer": 16,
    "IMEISwap": "sample string 17",
    "SectionsCompleted": 1,
    "SectionsSkipped": 1,
    "Signature2Data": "sample string 18",
    "Signature2FileName": "sample string 19",
    "SupportAgentName": "sample string 20",
    "CommissionDate": "2025-04-27T16:14:32.599768+00:00",
    "Notes": "sample string 22",
    "KeypadInstalled": true,
    "OtherInstalled": true,
    "ImeiRequired": "sample string 25",
    "CustomerName": "sample string 26",
    "InstallationStatus": 0,
    "AllKitUsed": true,
    "AnyKitRemoved": true,
    "KitLeftOnSite": true,
    "InstallationVideoS3Key": "sample string 30"
  }
]

application/xml, text/xml

Sample:
<ArrayOfMultipleInstallationRequest xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <MultipleInstallationRequest>
    <StartDate>2025-04-27T16:14:32.599768+00:00</StartDate>
    <EndDate>2025-04-27T16:14:32.599768+00:00</EndDate>
    <VehicleRegistration>sample string 4</VehicleRegistration>
    <Latitude>5.1</Latitude>
    <Longitude>6.1</Longitude>
    <CustomerUnavailable>true</CustomerUnavailable>
    <CustomerUnavailableReason>sample string 8</CustomerUnavailableReason>
    <SignatureData>sample string 9</SignatureData>
    <SignatureFileName>sample string 10</SignatureFileName>
    <CameraInstalled>true</CameraInstalled>
    <BuzzerInstalled>true</BuzzerInstalled>
    <DriverIdReaderInstalled>true</DriverIdReaderInstalled>
    <PanicButtonInstalled>true</PanicButtonInstalled>
    <KeysReturned>true</KeysReturned>
    <Odometer>16</Odometer>
    <IMEISwap>sample string 17</IMEISwap>
    <SectionsCompleted>Gallery</SectionsCompleted>
    <SectionsSkipped>Gallery</SectionsSkipped>
    <Signature2Data>sample string 18</Signature2Data>
    <Signature2FileName>sample string 19</Signature2FileName>
    <SupportAgentName>sample string 20</SupportAgentName>
    <CommissionDate>2025-04-27T16:14:32.599768+00:00</CommissionDate>
    <Notes>sample string 22</Notes>
    <KeypadInstalled>true</KeypadInstalled>
    <OtherInstalled>true</OtherInstalled>
    <ImeiRequired>sample string 25</ImeiRequired>
    <CustomerName>sample string 26</CustomerName>
    <InstallationStatus>Incomplete</InstallationStatus>
    <AllKitUsed>true</AllKitUsed>
    <AnyKitRemoved>true</AnyKitRemoved>
    <KitLeftOnSite>true</KitLeftOnSite>
    <InstallationVideoS3Key>sample string 30</InstallationVideoS3Key>
    <InstallationId>1</InstallationId>
  </MultipleInstallationRequest>
  <MultipleInstallationRequest>
    <StartDate>2025-04-27T16:14:32.599768+00:00</StartDate>
    <EndDate>2025-04-27T16:14:32.599768+00:00</EndDate>
    <VehicleRegistration>sample string 4</VehicleRegistration>
    <Latitude>5.1</Latitude>
    <Longitude>6.1</Longitude>
    <CustomerUnavailable>true</CustomerUnavailable>
    <CustomerUnavailableReason>sample string 8</CustomerUnavailableReason>
    <SignatureData>sample string 9</SignatureData>
    <SignatureFileName>sample string 10</SignatureFileName>
    <CameraInstalled>true</CameraInstalled>
    <BuzzerInstalled>true</BuzzerInstalled>
    <DriverIdReaderInstalled>true</DriverIdReaderInstalled>
    <PanicButtonInstalled>true</PanicButtonInstalled>
    <KeysReturned>true</KeysReturned>
    <Odometer>16</Odometer>
    <IMEISwap>sample string 17</IMEISwap>
    <SectionsCompleted>Gallery</SectionsCompleted>
    <SectionsSkipped>Gallery</SectionsSkipped>
    <Signature2Data>sample string 18</Signature2Data>
    <Signature2FileName>sample string 19</Signature2FileName>
    <SupportAgentName>sample string 20</SupportAgentName>
    <CommissionDate>2025-04-27T16:14:32.599768+00:00</CommissionDate>
    <Notes>sample string 22</Notes>
    <KeypadInstalled>true</KeypadInstalled>
    <OtherInstalled>true</OtherInstalled>
    <ImeiRequired>sample string 25</ImeiRequired>
    <CustomerName>sample string 26</CustomerName>
    <InstallationStatus>Incomplete</InstallationStatus>
    <AllKitUsed>true</AllKitUsed>
    <AnyKitRemoved>true</AnyKitRemoved>
    <KitLeftOnSite>true</KitLeftOnSite>
    <InstallationVideoS3Key>sample string 30</InstallationVideoS3Key>
    <InstallationId>1</InstallationId>
  </MultipleInstallationRequest>
</ArrayOfMultipleInstallationRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

200 on success

HttpResponseMessage
NameDescriptionTypeAdditional information
Version

Version

None.

Content

HttpContent

None.

StatusCode

HttpStatusCode

None.

ReasonPhrase

string

None.

Headers

Collection of Object

None.

RequestMessage

HttpRequestMessage

None.

IsSuccessStatusCode

boolean

None.