GET api/CheckList/GetCheckListByTransaction?apiKey={apiKey}&agreementID={agreementID}&replacementID={replacementID}&type={type}&status={status}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
apiKey

string

Required
agreementID

globally unique identifier

Required
replacementID

globally unique identifier

Required
type

integer

Required
status

integer

Required

Body Parameters

None.

Response Information

Resource Description

Collection of VehicleCheckList
NameDescriptionTypeAdditional information
VehicleCheckListID

globally unique identifier

None.
Name

string

None.
CheckOutCheckInStatus

CheckOutCheckInStatus

None.
VehicleCheckListIDs

Collection of globally unique identifier

None.
CheckInStatus

boolean

None.
CheckOutStatus

boolean

None.
TransactionID

globally unique identifier

None.
TransactionType

TransactionType

None.
ReplacementID

globally unique identifier

None.
VehicleID

globally unique identifier

None.

Response Formats

application/json, text/json

Sample: 
[
  {
    "VehicleCheckListID": "47543e4c-292f-4910-a657-7ae4155868b3",
    "Name": "sample string 2",
    "CheckOutCheckInStatus": 1,
    "VehicleCheckListIDs": [
      "bb7f9fd9-c3cc-4da4-8da0-be517d8f6419",
      "ca9cd8b5-f895-41d2-b77c-6975bebd4bb2"
    ],
    "CheckInStatus": true,
    "CheckOutStatus": true,
    "TransactionID": "566b3fc4-c8a1-4e3b-baf8-c6a28dfb0aaa",
    "TransactionType": 0,
    "ReplacementID": "9a7f3679-a846-457d-ae6a-ff4ac1b6ae74",
    "VehicleID": "43b1373c-04ef-4083-a66e-7a76e8cc7a56"
  },
  {
    "VehicleCheckListID": "47543e4c-292f-4910-a657-7ae4155868b3",
    "Name": "sample string 2",
    "CheckOutCheckInStatus": 1,
    "VehicleCheckListIDs": [
      "bb7f9fd9-c3cc-4da4-8da0-be517d8f6419",
      "ca9cd8b5-f895-41d2-b77c-6975bebd4bb2"
    ],
    "CheckInStatus": true,
    "CheckOutStatus": true,
    "TransactionID": "566b3fc4-c8a1-4e3b-baf8-c6a28dfb0aaa",
    "TransactionType": 0,
    "ReplacementID": "9a7f3679-a846-457d-ae6a-ff4ac1b6ae74",
    "VehicleID": "43b1373c-04ef-4083-a66e-7a76e8cc7a56"
  }
]

application/xml, text/xml

Sample: 
<ArrayOfVehicleCheckList xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Fleetlet.Entity.Vehicles">
  <VehicleCheckList>
    <CheckInStatus>true</CheckInStatus>
    <CheckOutCheckInStatus>CheckOut</CheckOutCheckInStatus>
    <CheckOutStatus>true</CheckOutStatus>
    <Name>sample string 2</Name>
    <ReplacementID>9a7f3679-a846-457d-ae6a-ff4ac1b6ae74</ReplacementID>
    <TransactionID>566b3fc4-c8a1-4e3b-baf8-c6a28dfb0aaa</TransactionID>
    <TransactionType>None</TransactionType>
    <VehicleCheckListID>47543e4c-292f-4910-a657-7ae4155868b3</VehicleCheckListID>
    <VehicleCheckListIDs xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:guid>bb7f9fd9-c3cc-4da4-8da0-be517d8f6419</d3p1:guid>
      <d3p1:guid>ca9cd8b5-f895-41d2-b77c-6975bebd4bb2</d3p1:guid>
    </VehicleCheckListIDs>
    <VehicleID>43b1373c-04ef-4083-a66e-7a76e8cc7a56</VehicleID>
  </VehicleCheckList>
  <VehicleCheckList>
    <CheckInStatus>true</CheckInStatus>
    <CheckOutCheckInStatus>CheckOut</CheckOutCheckInStatus>
    <CheckOutStatus>true</CheckOutStatus>
    <Name>sample string 2</Name>
    <ReplacementID>9a7f3679-a846-457d-ae6a-ff4ac1b6ae74</ReplacementID>
    <TransactionID>566b3fc4-c8a1-4e3b-baf8-c6a28dfb0aaa</TransactionID>
    <TransactionType>None</TransactionType>
    <VehicleCheckListID>47543e4c-292f-4910-a657-7ae4155868b3</VehicleCheckListID>
    <VehicleCheckListIDs xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:guid>bb7f9fd9-c3cc-4da4-8da0-be517d8f6419</d3p1:guid>
      <d3p1:guid>ca9cd8b5-f895-41d2-b77c-6975bebd4bb2</d3p1:guid>
    </VehicleCheckListIDs>
    <VehicleID>43b1373c-04ef-4083-a66e-7a76e8cc7a56</VehicleID>
  </VehicleCheckList>
</ArrayOfVehicleCheckList>