POST api/Unit/Retrieve

Retreives a list of units who are either unassigned or whose date of registration is within 60 mins from now.

Request Information

Parameters

Name	Description	Additional information
req		Define this parameter in the request body.

Request body formats

application/json, text/json

Sample:

{
  "Mode": "sample string 1",
  "Token": "sample string 2",
  "FreeText": "sample string 3",
  "GroupIds": [
    1,
    2,
    3
  ],
  "FromIndex": 4,
  "ToIndex": 5,
  "IsWebCalling": true,
  "RequestMode": "sample string 7",
  "Client": "sample string 8",
  "AppVersion": "sample string 9",
  "AppOperatingSystem": "sample string 10",
  "AppName": "sample string 11",
  "MasterUserID": 12,
  "IsRecurringRequest": true
}

text/html

Sample:

{"Mode":"sample string 1","Token":"sample string 2","FreeText":"sample string 3","GroupIds":[1,2,3],"FromIndex":4,"ToIndex":5,"IsWebCalling":true,"RequestMode":"sample string 7","Client":"sample string 8","AppVersion":"sample string 9","AppOperatingSystem":"sample string 10","AppName":"sample string 11","MasterUserID":12,"IsRecurringRequest":true}

application/xml, text/xml

Sample:

<APIUnitRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Accessor.Common.Models.APIModels">
  <AppName>sample string 11</AppName>
  <AppOperatingSystem>sample string 10</AppOperatingSystem>
  <AppVersion>sample string 9</AppVersion>
  <Client>sample string 8</Client>
  <FreeText>sample string 3</FreeText>
  <FromIndex>4</FromIndex>
  <GroupIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
    <d2p1:int>3</d2p1:int>
  </GroupIds>
  <IsRecurringRequest>true</IsRecurringRequest>
  <IsWebCalling>true</IsWebCalling>
  <MasterUserID>12</MasterUserID>
  <RequestMode>sample string 7</RequestMode>
  <ToIndex>5</ToIndex>
  <Token>sample string 2</Token>
  <Mode>sample string 1</Mode>
</APIUnitRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Response body formats

application/json, text/json

Sample:

{
  "Units": [
    {
      "ID": 1,
      "IMEINumber": "sample string 2",
      "DateOfRegistration": "2025-04-03T11:21:31.2317503+02:00",
      "SerialNumber": "sample string 4",
      "LastUpdate": "2025-04-03T11:21:31.2317503+02:00",
      "SimNumber": "sample string 6"
    },
    {
      "ID": 1,
      "IMEINumber": "sample string 2",
      "DateOfRegistration": "2025-04-03T11:21:31.2317503+02:00",
      "SerialNumber": "sample string 4",
      "LastUpdate": "2025-04-03T11:21:31.2317503+02:00",
      "SimNumber": "sample string 6"
    },
    {
      "ID": 1,
      "IMEINumber": "sample string 2",
      "DateOfRegistration": "2025-04-03T11:21:31.2317503+02:00",
      "SerialNumber": "sample string 4",
      "LastUpdate": "2025-04-03T11:21:31.2317503+02:00",
      "SimNumber": "sample string 6"
    }
  ],
  "Success": true,
  "ErrorMessage": "sample string 2",
  "MenuAccessData": {
    "HasAccessToMap": true,
    "HasAccessToVehicle": true,
    "HasAccessToVehicleAdministration": true,
    "HasAccessToDriver": true,
    "HasAccessToPOI": true,
    "HasAccessToReports": true,
    "HasAccessToSettings": true,
    "HasAccessToTrips": true,
    "HasAccessToTranslations": true,
    "HasAccessToDashboard": true,
    "HasAccessToLogBook": true,
    "HasAccessToGroup": true,
    "HasAccessToTemplate": true,
    "HasAccessToUnit": true,
    "HasAccessToUser": true,
    "HasAccessToTicket": true,
    "HasAccessToContract": true,
    "HasAccessToSIM": true,
    "HasAccessToCommand": true,
    "HasAccessToUnitProfile": true,
    "HasAccessToProfileTrigger": true,
    "HasAccessToScript": true,
    "HasAccessToTriggerSchedule": true
  },
  "StatusCode": 3,
  "ComponentFilterIds": [
    1,
    2,
    3
  ]
}

text/html

Sample:

{"Units":[{"ID":1,"IMEINumber":"sample string 2","DateOfRegistration":"2025-04-03T11:21:31.2317503+02:00","SerialNumber":"sample string 4","LastUpdate":"2025-04-03T11:21:31.2317503+02:00","SimNumber":"sample string 6"},{"ID":1,"IMEINumber":"sample string 2","DateOfRegistration":"2025-04-03T11:21:31.2317503+02:00","SerialNumber":"sample string 4","LastUpdate":"2025-04-03T11:21:31.2317503+02:00","SimNumber":"sample string 6"},{"ID":1,"IMEINumber":"sample string 2","DateOfRegistration":"2025-04-03T11:21:31.2317503+02:00","SerialNumber":"sample string 4","LastUpdate":"2025-04-03T11:21:31.2317503+02:00","SimNumber":"sample string 6"}],"Success":true,"ErrorMessage":"sample string 2","MenuAccessData":{"HasAccessToMap":true,"HasAccessToVehicle":true,"HasAccessToVehicleAdministration":true,"HasAccessToDriver":true,"HasAccessToPOI":true,"HasAccessToReports":true,"HasAccessToSettings":true,"HasAccessToTrips":true,"HasAccessToTranslations":true,"HasAccessToDashboard":true,"HasAccessToLogBook":true,"HasAccessToGroup":true,"HasAccessToTemplate":true,"HasAccessToUnit":true,"HasAccessToUser":true,"HasAccessToTicket":true,"HasAccessToContract":true,"HasAccessToSIM":true,"HasAccessToCommand":true,"HasAccessToUnitProfile":true,"HasAccessToProfileTrigger":true,"HasAccessToScript":true,"HasAccessToTriggerSchedule":true},"StatusCode":3,"ComponentFilterIds":[1,2,3]}

application/xml, text/xml

Sample:

<APIUnitResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Accessor.Common.Models.APIModels">
  <ResponseCode xmlns="http://schemas.datacontract.org/2004/07/Accessor.Common.Model.Transport">Success</ResponseCode>
  <ComponentFilterIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
    <d2p1:int>3</d2p1:int>
  </ComponentFilterIds>
  <ErrorMessage>sample string 2</ErrorMessage>
  <MenuAccessData>
    <HasAccessToCommand>true</HasAccessToCommand>
    <HasAccessToContract>true</HasAccessToContract>
    <HasAccessToDashboard>true</HasAccessToDashboard>
    <HasAccessToDriver>true</HasAccessToDriver>
    <HasAccessToGroup>true</HasAccessToGroup>
    <HasAccessToLogBook>true</HasAccessToLogBook>
    <HasAccessToMap>true</HasAccessToMap>
    <HasAccessToPOI>true</HasAccessToPOI>
    <HasAccessToProfileTrigger>true</HasAccessToProfileTrigger>
    <HasAccessToReports>true</HasAccessToReports>
    <HasAccessToSIM>true</HasAccessToSIM>
    <HasAccessToScript>true</HasAccessToScript>
    <HasAccessToSettings>true</HasAccessToSettings>
    <HasAccessToTemplate>true</HasAccessToTemplate>
    <HasAccessToTicket>true</HasAccessToTicket>
    <HasAccessToTranslations>true</HasAccessToTranslations>
    <HasAccessToTriggerSchedule>true</HasAccessToTriggerSchedule>
    <HasAccessToTrips>true</HasAccessToTrips>
    <HasAccessToUnit>true</HasAccessToUnit>
    <HasAccessToUnitProfile>true</HasAccessToUnitProfile>
    <HasAccessToUser>true</HasAccessToUser>
    <HasAccessToVehicle>true</HasAccessToVehicle>
    <HasAccessToVehicleAdministration>true</HasAccessToVehicleAdministration>
  </MenuAccessData>
  <StatusCode>3</StatusCode>
  <Success>true</Success>
  <Units>
    <APIUnit>
      <DateOfRegistration>2025-04-03T11:21:31.2317503+02:00</DateOfRegistration>
      <ID>1</ID>
      <IMEINumber>sample string 2</IMEINumber>
      <LastUpdate>2025-04-03T11:21:31.2317503+02:00</LastUpdate>
      <SerialNumber>sample string 4</SerialNumber>
      <SimNumber>sample string 6</SimNumber>
    </APIUnit>
    <APIUnit>
      <DateOfRegistration>2025-04-03T11:21:31.2317503+02:00</DateOfRegistration>
      <ID>1</ID>
      <IMEINumber>sample string 2</IMEINumber>
      <LastUpdate>2025-04-03T11:21:31.2317503+02:00</LastUpdate>
      <SerialNumber>sample string 4</SerialNumber>
      <SimNumber>sample string 6</SimNumber>
    </APIUnit>
    <APIUnit>
      <DateOfRegistration>2025-04-03T11:21:31.2317503+02:00</DateOfRegistration>
      <ID>1</ID>
      <IMEINumber>sample string 2</IMEINumber>
      <LastUpdate>2025-04-03T11:21:31.2317503+02:00</LastUpdate>
      <SerialNumber>sample string 4</SerialNumber>
      <SimNumber>sample string 6</SimNumber>
    </APIUnit>
  </Units>
</APIUnitResponse>