GET Api/Renewal?clientID={clientID}&vehicleID={vehicleID}&renewalTypeID={renewalTypeID}
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| clientID | globally unique identifier |
Required |
|
| vehicleID | globally unique identifier |
Required |
|
| renewalTypeID | globally unique identifier |
Required |
Body Parameters
None.
Response Information
Resource Description
Collection of VehicleRenewal| Name | Description | Type | Additional information |
|---|---|---|---|
| VehicleRenewalID | globally unique identifier |
None. |
|
| Vehicle | VehicleBase |
None. |
|
| RenewalType | RenewalType |
None. |
|
| DueDate | date |
None. |
|
| ExpiryDate | date |
None. |
|
| RenewalDoneOn | date |
None. |
|
| IsOverdue | boolean |
None. |
|
| OverdueReason | string |
None. |
|
| UsersToNotify | user_alert_setting |
None. |
|
| AmountSpent | decimal number |
None. |
|
| Note | string |
None. |
|
| Days | integer |
None. |
|
| ReminderBeforeDays | integer |
None. |
|
| DueDetail | string |
None. |
|
| Attachment | Attachment |
None. |
|
| Id | globally unique identifier |
None. |
|
| UserName | string |
None. |
|
| UserID | globally unique identifier |
None. |
|
| CreatedBy | string |
None. |
|
| CreatedOn | date |
None. |
|
| ClientID | globally unique identifier |
None. |
|
| ClientName | string |
None. |
|
| PartnerID | globally unique identifier |
None. |
|
| PartnerName | string |
None. |
Response Formats
application/json, text/json
Sample:
[
{
"VehicleRenewalID": "7ca4e4e7-18fd-4e6d-9bb2-247d44a33b1f",
"Vehicle": {
"VehicleID": "ace95583-e96e-4505-b143-6e17b92d146c",
"Name": "sample string 2",
"VehicleNo": "sample string 3",
"Odometer": 4,
"ModelName": "sample string 5",
"DriverID": "a9ab863f-50dd-4126-84ba-ae799a3e7208",
"DriverName": "sample string 7",
"DriverContactNo": "sample string 8",
"IMEINo": "sample string 9",
"ClientID": "80e668ee-2f92-4271-a293-35e91a5164c9",
"PartnerID": "9b2a33c4-0e06-47d2-8197-80fc6fc4b7ce"
},
"RenewalType": {
"RenewalTypeID": "3a3524b1-106f-4723-aa6b-77c6e5175cc2",
"Name": "sample string 2",
"FrequencyDays": 3,
"Description": "sample string 4",
"Id": "01e8131a-3246-4dbc-abd3-414f4d7f948f",
"UserName": "sample string 6",
"UserID": "e30a681a-91d3-4845-acda-a941052cd470",
"CreatedBy": "sample string 8",
"CreatedOn": "2026-09-28T14:00:11.115503+04:00",
"ClientID": "1158d2ad-34b1-4463-a794-6da879b5e05f",
"ClientName": "sample string 11",
"PartnerID": "c6128844-4e60-46e1-ae90-37ac510d5735",
"PartnerName": "sample string 13"
},
"DueDate": "2026-09-28T14:00:11.115503+04:00",
"ExpiryDate": "2026-09-28T14:00:11.115503+04:00",
"RenewalDoneOn": "2026-09-28T14:00:11.115503+04:00",
"IsOverdue": true,
"OverdueReason": "sample string 6",
"UsersToNotify": {
"Users": [
{
"m_Item1": "sample string 1",
"m_Item2": "sample string 2"
},
{
"m_Item1": "sample string 1",
"m_Item2": "sample string 2"
}
],
"BusinessHoursID": "0a85de77-7589-4232-9832-e40709c71615",
"IsNotifyUsingSms": true,
"IsNotifyUsingEmail": true,
"IsNotifyUsingPortal": true,
"IsNotifyUsingMobileApp": true,
"UserEmailIds": [
"sample string 1",
"sample string 2"
],
"IsNotifyDriverUsingSms": true,
"IsNotifyDriverUsingEmail": true,
"IsNotifyDriverUsingMobileApp": true
},
"AmountSpent": 7.0,
"Note": "sample string 8",
"Days": 9,
"ReminderBeforeDays": 10,
"DueDetail": "sample string 11",
"Attachment": {
"AttachmentID": "482e86cb-9aea-49c4-b4fe-24d3670f6ace",
"AttachmentData": "QEA=",
"AttachmentDataBase64": "sample string 2",
"ContentType": "sample string 3",
"FileName": "sample string 4",
"ImageString": "sample string 5",
"IsDeleted": true
},
"Id": "dc35f5e0-85e9-4272-b6d5-a3e5ec0e8503",
"UserName": "sample string 13",
"UserID": "508b5e6e-6b32-4f37-a26f-1efe1809d1e8",
"CreatedBy": "sample string 15",
"CreatedOn": "2026-09-28T14:00:11.115503+04:00",
"ClientID": "8816e0d6-6743-4f75-a70c-0bde7c42a84c",
"ClientName": "sample string 18",
"PartnerID": "05afd0a3-4555-4a60-ab14-c624b415c719",
"PartnerName": "sample string 20"
},
{
"VehicleRenewalID": "7ca4e4e7-18fd-4e6d-9bb2-247d44a33b1f",
"Vehicle": {
"VehicleID": "ace95583-e96e-4505-b143-6e17b92d146c",
"Name": "sample string 2",
"VehicleNo": "sample string 3",
"Odometer": 4,
"ModelName": "sample string 5",
"DriverID": "a9ab863f-50dd-4126-84ba-ae799a3e7208",
"DriverName": "sample string 7",
"DriverContactNo": "sample string 8",
"IMEINo": "sample string 9",
"ClientID": "80e668ee-2f92-4271-a293-35e91a5164c9",
"PartnerID": "9b2a33c4-0e06-47d2-8197-80fc6fc4b7ce"
},
"RenewalType": {
"RenewalTypeID": "3a3524b1-106f-4723-aa6b-77c6e5175cc2",
"Name": "sample string 2",
"FrequencyDays": 3,
"Description": "sample string 4",
"Id": "01e8131a-3246-4dbc-abd3-414f4d7f948f",
"UserName": "sample string 6",
"UserID": "e30a681a-91d3-4845-acda-a941052cd470",
"CreatedBy": "sample string 8",
"CreatedOn": "2026-09-28T14:00:11.115503+04:00",
"ClientID": "1158d2ad-34b1-4463-a794-6da879b5e05f",
"ClientName": "sample string 11",
"PartnerID": "c6128844-4e60-46e1-ae90-37ac510d5735",
"PartnerName": "sample string 13"
},
"DueDate": "2026-09-28T14:00:11.115503+04:00",
"ExpiryDate": "2026-09-28T14:00:11.115503+04:00",
"RenewalDoneOn": "2026-09-28T14:00:11.115503+04:00",
"IsOverdue": true,
"OverdueReason": "sample string 6",
"UsersToNotify": {
"Users": [
{
"m_Item1": "sample string 1",
"m_Item2": "sample string 2"
},
{
"m_Item1": "sample string 1",
"m_Item2": "sample string 2"
}
],
"BusinessHoursID": "0a85de77-7589-4232-9832-e40709c71615",
"IsNotifyUsingSms": true,
"IsNotifyUsingEmail": true,
"IsNotifyUsingPortal": true,
"IsNotifyUsingMobileApp": true,
"UserEmailIds": [
"sample string 1",
"sample string 2"
],
"IsNotifyDriverUsingSms": true,
"IsNotifyDriverUsingEmail": true,
"IsNotifyDriverUsingMobileApp": true
},
"AmountSpent": 7.0,
"Note": "sample string 8",
"Days": 9,
"ReminderBeforeDays": 10,
"DueDetail": "sample string 11",
"Attachment": {
"AttachmentID": "482e86cb-9aea-49c4-b4fe-24d3670f6ace",
"AttachmentData": "QEA=",
"AttachmentDataBase64": "sample string 2",
"ContentType": "sample string 3",
"FileName": "sample string 4",
"ImageString": "sample string 5",
"IsDeleted": true
},
"Id": "dc35f5e0-85e9-4272-b6d5-a3e5ec0e8503",
"UserName": "sample string 13",
"UserID": "508b5e6e-6b32-4f37-a26f-1efe1809d1e8",
"CreatedBy": "sample string 15",
"CreatedOn": "2026-09-28T14:00:11.115503+04:00",
"ClientID": "8816e0d6-6743-4f75-a70c-0bde7c42a84c",
"ClientName": "sample string 18",
"PartnerID": "05afd0a3-4555-4a60-ab14-c624b415c719",
"PartnerName": "sample string 20"
}
]
application/xml, text/xml
Sample:
<ArrayOfVehicleRenewal xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Fleetroot.Entity">
<VehicleRenewal>
<ClientID>8816e0d6-6743-4f75-a70c-0bde7c42a84c</ClientID>
<ClientName>sample string 18</ClientName>
<CreatedBy>sample string 15</CreatedBy>
<CreatedOn>2026-09-28T14:00:11.115503+04:00</CreatedOn>
<Id>dc35f5e0-85e9-4272-b6d5-a3e5ec0e8503</Id>
<PartnerID>05afd0a3-4555-4a60-ab14-c624b415c719</PartnerID>
<PartnerName>sample string 20</PartnerName>
<UserID>508b5e6e-6b32-4f37-a26f-1efe1809d1e8</UserID>
<UserName>sample string 13</UserName>
<AmountSpent>7</AmountSpent>
<Attachment>
<AttachmentData>QEA=</AttachmentData>
<AttachmentDataBase64>sample string 2</AttachmentDataBase64>
<AttachmentID>482e86cb-9aea-49c4-b4fe-24d3670f6ace</AttachmentID>
<ContentType>sample string 3</ContentType>
<FileName>sample string 4</FileName>
<ImageString>sample string 5</ImageString>
<IsDeleted>true</IsDeleted>
</Attachment>
<Days>9</Days>
<DueDate>2026-09-28T14:00:11.115503+04:00</DueDate>
<DueDetail>sample string 11</DueDetail>
<ExpiryDate>2026-09-28T14:00:11.115503+04:00</ExpiryDate>
<IsOverdue>true</IsOverdue>
<Note>sample string 8</Note>
<OverdueReason>sample string 6</OverdueReason>
<ReminderBeforeDays>10</ReminderBeforeDays>
<RenewalDoneOn>2026-09-28T14:00:11.115503+04:00</RenewalDoneOn>
<RenewalType>
<ClientID>1158d2ad-34b1-4463-a794-6da879b5e05f</ClientID>
<ClientName>sample string 11</ClientName>
<CreatedBy>sample string 8</CreatedBy>
<CreatedOn>2026-09-28T14:00:11.115503+04:00</CreatedOn>
<Id>01e8131a-3246-4dbc-abd3-414f4d7f948f</Id>
<PartnerID>c6128844-4e60-46e1-ae90-37ac510d5735</PartnerID>
<PartnerName>sample string 13</PartnerName>
<UserID>e30a681a-91d3-4845-acda-a941052cd470</UserID>
<UserName>sample string 6</UserName>
<Description>sample string 4</Description>
<FrequencyDays>3</FrequencyDays>
<Name>sample string 2</Name>
<RenewalTypeID>3a3524b1-106f-4723-aa6b-77c6e5175cc2</RenewalTypeID>
</RenewalType>
<UsersToNotify>
<BusinessHoursID>0a85de77-7589-4232-9832-e40709c71615</BusinessHoursID>
<IsNotifyDriverUsingEmail>true</IsNotifyDriverUsingEmail>
<IsNotifyDriverUsingMobileApp>true</IsNotifyDriverUsingMobileApp>
<IsNotifyDriverUsingSms>true</IsNotifyDriverUsingSms>
<IsNotifyUsingEmail>true</IsNotifyUsingEmail>
<IsNotifyUsingMobileApp>true</IsNotifyUsingMobileApp>
<IsNotifyUsingPortal>true</IsNotifyUsingPortal>
<IsNotifyUsingSms>true</IsNotifyUsingSms>
<UserEmailIds xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d4p1:string>sample string 1</d4p1:string>
<d4p1:string>sample string 2</d4p1:string>
</UserEmailIds>
<Users xmlns:d4p1="http://schemas.datacontract.org/2004/07/System">
<d4p1:TupleOfstringstring>
<d4p1:m_Item1>sample string 1</d4p1:m_Item1>
<d4p1:m_Item2>sample string 2</d4p1:m_Item2>
</d4p1:TupleOfstringstring>
<d4p1:TupleOfstringstring>
<d4p1:m_Item1>sample string 1</d4p1:m_Item1>
<d4p1:m_Item2>sample string 2</d4p1:m_Item2>
</d4p1:TupleOfstringstring>
</Users>
</UsersToNotify>
<Vehicle>
<ClientID>80e668ee-2f92-4271-a293-35e91a5164c9</ClientID>
<DriverContactNo>sample string 8</DriverContactNo>
<DriverID>a9ab863f-50dd-4126-84ba-ae799a3e7208</DriverID>
<DriverName>sample string 7</DriverName>
<IMEINo>sample string 9</IMEINo>
<ModelName>sample string 5</ModelName>
<Name>sample string 2</Name>
<Odometer>4</Odometer>
<PartnerID>9b2a33c4-0e06-47d2-8197-80fc6fc4b7ce</PartnerID>
<VehicleID>ace95583-e96e-4505-b143-6e17b92d146c</VehicleID>
<VehicleNo>sample string 3</VehicleNo>
</Vehicle>
<VehicleRenewalID>7ca4e4e7-18fd-4e6d-9bb2-247d44a33b1f</VehicleRenewalID>
</VehicleRenewal>
<VehicleRenewal>
<ClientID>8816e0d6-6743-4f75-a70c-0bde7c42a84c</ClientID>
<ClientName>sample string 18</ClientName>
<CreatedBy>sample string 15</CreatedBy>
<CreatedOn>2026-09-28T14:00:11.115503+04:00</CreatedOn>
<Id>dc35f5e0-85e9-4272-b6d5-a3e5ec0e8503</Id>
<PartnerID>05afd0a3-4555-4a60-ab14-c624b415c719</PartnerID>
<PartnerName>sample string 20</PartnerName>
<UserID>508b5e6e-6b32-4f37-a26f-1efe1809d1e8</UserID>
<UserName>sample string 13</UserName>
<AmountSpent>7</AmountSpent>
<Attachment>
<AttachmentData>QEA=</AttachmentData>
<AttachmentDataBase64>sample string 2</AttachmentDataBase64>
<AttachmentID>482e86cb-9aea-49c4-b4fe-24d3670f6ace</AttachmentID>
<ContentType>sample string 3</ContentType>
<FileName>sample string 4</FileName>
<ImageString>sample string 5</ImageString>
<IsDeleted>true</IsDeleted>
</Attachment>
<Days>9</Days>
<DueDate>2026-09-28T14:00:11.115503+04:00</DueDate>
<DueDetail>sample string 11</DueDetail>
<ExpiryDate>2026-09-28T14:00:11.115503+04:00</ExpiryDate>
<IsOverdue>true</IsOverdue>
<Note>sample string 8</Note>
<OverdueReason>sample string 6</OverdueReason>
<ReminderBeforeDays>10</ReminderBeforeDays>
<RenewalDoneOn>2026-09-28T14:00:11.115503+04:00</RenewalDoneOn>
<RenewalType>
<ClientID>1158d2ad-34b1-4463-a794-6da879b5e05f</ClientID>
<ClientName>sample string 11</ClientName>
<CreatedBy>sample string 8</CreatedBy>
<CreatedOn>2026-09-28T14:00:11.115503+04:00</CreatedOn>
<Id>01e8131a-3246-4dbc-abd3-414f4d7f948f</Id>
<PartnerID>c6128844-4e60-46e1-ae90-37ac510d5735</PartnerID>
<PartnerName>sample string 13</PartnerName>
<UserID>e30a681a-91d3-4845-acda-a941052cd470</UserID>
<UserName>sample string 6</UserName>
<Description>sample string 4</Description>
<FrequencyDays>3</FrequencyDays>
<Name>sample string 2</Name>
<RenewalTypeID>3a3524b1-106f-4723-aa6b-77c6e5175cc2</RenewalTypeID>
</RenewalType>
<UsersToNotify>
<BusinessHoursID>0a85de77-7589-4232-9832-e40709c71615</BusinessHoursID>
<IsNotifyDriverUsingEmail>true</IsNotifyDriverUsingEmail>
<IsNotifyDriverUsingMobileApp>true</IsNotifyDriverUsingMobileApp>
<IsNotifyDriverUsingSms>true</IsNotifyDriverUsingSms>
<IsNotifyUsingEmail>true</IsNotifyUsingEmail>
<IsNotifyUsingMobileApp>true</IsNotifyUsingMobileApp>
<IsNotifyUsingPortal>true</IsNotifyUsingPortal>
<IsNotifyUsingSms>true</IsNotifyUsingSms>
<UserEmailIds xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d4p1:string>sample string 1</d4p1:string>
<d4p1:string>sample string 2</d4p1:string>
</UserEmailIds>
<Users xmlns:d4p1="http://schemas.datacontract.org/2004/07/System">
<d4p1:TupleOfstringstring>
<d4p1:m_Item1>sample string 1</d4p1:m_Item1>
<d4p1:m_Item2>sample string 2</d4p1:m_Item2>
</d4p1:TupleOfstringstring>
<d4p1:TupleOfstringstring>
<d4p1:m_Item1>sample string 1</d4p1:m_Item1>
<d4p1:m_Item2>sample string 2</d4p1:m_Item2>
</d4p1:TupleOfstringstring>
</Users>
</UsersToNotify>
<Vehicle>
<ClientID>80e668ee-2f92-4271-a293-35e91a5164c9</ClientID>
<DriverContactNo>sample string 8</DriverContactNo>
<DriverID>a9ab863f-50dd-4126-84ba-ae799a3e7208</DriverID>
<DriverName>sample string 7</DriverName>
<IMEINo>sample string 9</IMEINo>
<ModelName>sample string 5</ModelName>
<Name>sample string 2</Name>
<Odometer>4</Odometer>
<PartnerID>9b2a33c4-0e06-47d2-8197-80fc6fc4b7ce</PartnerID>
<VehicleID>ace95583-e96e-4505-b143-6e17b92d146c</VehicleID>
<VehicleNo>sample string 3</VehicleNo>
</Vehicle>
<VehicleRenewalID>7ca4e4e7-18fd-4e6d-9bb2-247d44a33b1f</VehicleRenewalID>
</VehicleRenewal>
</ArrayOfVehicleRenewal>