GET Api/Renewal?param={param}
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| param | string |
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": "583dbec3-e49d-427d-bfe7-714deb1a3815",
"Vehicle": {
"VehicleID": "26654607-609c-4030-a4f2-ad63675e2275",
"Name": "sample string 2",
"VehicleNo": "sample string 3",
"Odometer": 4,
"ModelName": "sample string 5",
"DriverID": "cae9ba4e-b634-4cd5-9e2b-a73d0e0a69af",
"DriverName": "sample string 7",
"DriverContactNo": "sample string 8",
"IMEINo": "sample string 9",
"ClientID": "5fa04579-8631-4a27-a463-20782b9b20fd",
"PartnerID": "4abed76d-242f-4106-9e83-31a342cd02a3"
},
"RenewalType": {
"RenewalTypeID": "899acc22-875e-41e0-ab3e-a5d3d8deea6e",
"Name": "sample string 2",
"FrequencyDays": 3,
"Description": "sample string 4",
"Id": "2af8584f-c0f7-4056-8835-61814817fff7",
"UserName": "sample string 6",
"UserID": "06faf11b-e2f1-4dc2-b8dd-062bbe80f919",
"CreatedBy": "sample string 8",
"CreatedOn": "2025-11-09T00:49:16.7545344+04:00",
"ClientID": "a35c7cf6-8e22-4894-a392-fd2302e64f41",
"ClientName": "sample string 11",
"PartnerID": "2fbb90a9-e9e8-4ec3-8607-87c54594ff47",
"PartnerName": "sample string 13"
},
"DueDate": "2025-11-09T00:49:16.7545344+04:00",
"ExpiryDate": "2025-11-09T00:49:16.7545344+04:00",
"RenewalDoneOn": "2025-11-09T00:49:16.7545344+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": "121c4da7-97f7-4eb5-b205-fed88eb7f8bc",
"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": "dc9f7492-a0a5-48a7-b828-d978b940bcc9",
"AttachmentData": "QEA=",
"AttachmentDataBase64": "sample string 2",
"ContentType": "sample string 3",
"FileName": "sample string 4",
"ImageString": "sample string 5",
"IsDeleted": true
},
"Id": "fe512a7a-485f-48d2-88b0-1aed5839b7ff",
"UserName": "sample string 13",
"UserID": "fd02f669-943c-4b98-897d-888a8deebab8",
"CreatedBy": "sample string 15",
"CreatedOn": "2025-11-09T00:49:16.7545344+04:00",
"ClientID": "0d972708-718c-4710-84e1-ca74c1c31eda",
"ClientName": "sample string 18",
"PartnerID": "4ecd4baf-51e7-426d-9ac7-7d2043f43a81",
"PartnerName": "sample string 20"
},
{
"VehicleRenewalID": "583dbec3-e49d-427d-bfe7-714deb1a3815",
"Vehicle": {
"VehicleID": "26654607-609c-4030-a4f2-ad63675e2275",
"Name": "sample string 2",
"VehicleNo": "sample string 3",
"Odometer": 4,
"ModelName": "sample string 5",
"DriverID": "cae9ba4e-b634-4cd5-9e2b-a73d0e0a69af",
"DriverName": "sample string 7",
"DriverContactNo": "sample string 8",
"IMEINo": "sample string 9",
"ClientID": "5fa04579-8631-4a27-a463-20782b9b20fd",
"PartnerID": "4abed76d-242f-4106-9e83-31a342cd02a3"
},
"RenewalType": {
"RenewalTypeID": "899acc22-875e-41e0-ab3e-a5d3d8deea6e",
"Name": "sample string 2",
"FrequencyDays": 3,
"Description": "sample string 4",
"Id": "2af8584f-c0f7-4056-8835-61814817fff7",
"UserName": "sample string 6",
"UserID": "06faf11b-e2f1-4dc2-b8dd-062bbe80f919",
"CreatedBy": "sample string 8",
"CreatedOn": "2025-11-09T00:49:16.7545344+04:00",
"ClientID": "a35c7cf6-8e22-4894-a392-fd2302e64f41",
"ClientName": "sample string 11",
"PartnerID": "2fbb90a9-e9e8-4ec3-8607-87c54594ff47",
"PartnerName": "sample string 13"
},
"DueDate": "2025-11-09T00:49:16.7545344+04:00",
"ExpiryDate": "2025-11-09T00:49:16.7545344+04:00",
"RenewalDoneOn": "2025-11-09T00:49:16.7545344+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": "121c4da7-97f7-4eb5-b205-fed88eb7f8bc",
"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": "dc9f7492-a0a5-48a7-b828-d978b940bcc9",
"AttachmentData": "QEA=",
"AttachmentDataBase64": "sample string 2",
"ContentType": "sample string 3",
"FileName": "sample string 4",
"ImageString": "sample string 5",
"IsDeleted": true
},
"Id": "fe512a7a-485f-48d2-88b0-1aed5839b7ff",
"UserName": "sample string 13",
"UserID": "fd02f669-943c-4b98-897d-888a8deebab8",
"CreatedBy": "sample string 15",
"CreatedOn": "2025-11-09T00:49:16.7545344+04:00",
"ClientID": "0d972708-718c-4710-84e1-ca74c1c31eda",
"ClientName": "sample string 18",
"PartnerID": "4ecd4baf-51e7-426d-9ac7-7d2043f43a81",
"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>0d972708-718c-4710-84e1-ca74c1c31eda</ClientID>
<ClientName>sample string 18</ClientName>
<CreatedBy>sample string 15</CreatedBy>
<CreatedOn>2025-11-09T00:49:16.7545344+04:00</CreatedOn>
<Id>fe512a7a-485f-48d2-88b0-1aed5839b7ff</Id>
<PartnerID>4ecd4baf-51e7-426d-9ac7-7d2043f43a81</PartnerID>
<PartnerName>sample string 20</PartnerName>
<UserID>fd02f669-943c-4b98-897d-888a8deebab8</UserID>
<UserName>sample string 13</UserName>
<AmountSpent>7</AmountSpent>
<Attachment>
<AttachmentData>QEA=</AttachmentData>
<AttachmentDataBase64>sample string 2</AttachmentDataBase64>
<AttachmentID>dc9f7492-a0a5-48a7-b828-d978b940bcc9</AttachmentID>
<ContentType>sample string 3</ContentType>
<FileName>sample string 4</FileName>
<ImageString>sample string 5</ImageString>
<IsDeleted>true</IsDeleted>
</Attachment>
<Days>9</Days>
<DueDate>2025-11-09T00:49:16.7545344+04:00</DueDate>
<DueDetail>sample string 11</DueDetail>
<ExpiryDate>2025-11-09T00:49:16.7545344+04:00</ExpiryDate>
<IsOverdue>true</IsOverdue>
<Note>sample string 8</Note>
<OverdueReason>sample string 6</OverdueReason>
<ReminderBeforeDays>10</ReminderBeforeDays>
<RenewalDoneOn>2025-11-09T00:49:16.7545344+04:00</RenewalDoneOn>
<RenewalType>
<ClientID>a35c7cf6-8e22-4894-a392-fd2302e64f41</ClientID>
<ClientName>sample string 11</ClientName>
<CreatedBy>sample string 8</CreatedBy>
<CreatedOn>2025-11-09T00:49:16.7545344+04:00</CreatedOn>
<Id>2af8584f-c0f7-4056-8835-61814817fff7</Id>
<PartnerID>2fbb90a9-e9e8-4ec3-8607-87c54594ff47</PartnerID>
<PartnerName>sample string 13</PartnerName>
<UserID>06faf11b-e2f1-4dc2-b8dd-062bbe80f919</UserID>
<UserName>sample string 6</UserName>
<Description>sample string 4</Description>
<FrequencyDays>3</FrequencyDays>
<Name>sample string 2</Name>
<RenewalTypeID>899acc22-875e-41e0-ab3e-a5d3d8deea6e</RenewalTypeID>
</RenewalType>
<UsersToNotify>
<BusinessHoursID>121c4da7-97f7-4eb5-b205-fed88eb7f8bc</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>5fa04579-8631-4a27-a463-20782b9b20fd</ClientID>
<DriverContactNo>sample string 8</DriverContactNo>
<DriverID>cae9ba4e-b634-4cd5-9e2b-a73d0e0a69af</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>4abed76d-242f-4106-9e83-31a342cd02a3</PartnerID>
<VehicleID>26654607-609c-4030-a4f2-ad63675e2275</VehicleID>
<VehicleNo>sample string 3</VehicleNo>
</Vehicle>
<VehicleRenewalID>583dbec3-e49d-427d-bfe7-714deb1a3815</VehicleRenewalID>
</VehicleRenewal>
<VehicleRenewal>
<ClientID>0d972708-718c-4710-84e1-ca74c1c31eda</ClientID>
<ClientName>sample string 18</ClientName>
<CreatedBy>sample string 15</CreatedBy>
<CreatedOn>2025-11-09T00:49:16.7545344+04:00</CreatedOn>
<Id>fe512a7a-485f-48d2-88b0-1aed5839b7ff</Id>
<PartnerID>4ecd4baf-51e7-426d-9ac7-7d2043f43a81</PartnerID>
<PartnerName>sample string 20</PartnerName>
<UserID>fd02f669-943c-4b98-897d-888a8deebab8</UserID>
<UserName>sample string 13</UserName>
<AmountSpent>7</AmountSpent>
<Attachment>
<AttachmentData>QEA=</AttachmentData>
<AttachmentDataBase64>sample string 2</AttachmentDataBase64>
<AttachmentID>dc9f7492-a0a5-48a7-b828-d978b940bcc9</AttachmentID>
<ContentType>sample string 3</ContentType>
<FileName>sample string 4</FileName>
<ImageString>sample string 5</ImageString>
<IsDeleted>true</IsDeleted>
</Attachment>
<Days>9</Days>
<DueDate>2025-11-09T00:49:16.7545344+04:00</DueDate>
<DueDetail>sample string 11</DueDetail>
<ExpiryDate>2025-11-09T00:49:16.7545344+04:00</ExpiryDate>
<IsOverdue>true</IsOverdue>
<Note>sample string 8</Note>
<OverdueReason>sample string 6</OverdueReason>
<ReminderBeforeDays>10</ReminderBeforeDays>
<RenewalDoneOn>2025-11-09T00:49:16.7545344+04:00</RenewalDoneOn>
<RenewalType>
<ClientID>a35c7cf6-8e22-4894-a392-fd2302e64f41</ClientID>
<ClientName>sample string 11</ClientName>
<CreatedBy>sample string 8</CreatedBy>
<CreatedOn>2025-11-09T00:49:16.7545344+04:00</CreatedOn>
<Id>2af8584f-c0f7-4056-8835-61814817fff7</Id>
<PartnerID>2fbb90a9-e9e8-4ec3-8607-87c54594ff47</PartnerID>
<PartnerName>sample string 13</PartnerName>
<UserID>06faf11b-e2f1-4dc2-b8dd-062bbe80f919</UserID>
<UserName>sample string 6</UserName>
<Description>sample string 4</Description>
<FrequencyDays>3</FrequencyDays>
<Name>sample string 2</Name>
<RenewalTypeID>899acc22-875e-41e0-ab3e-a5d3d8deea6e</RenewalTypeID>
</RenewalType>
<UsersToNotify>
<BusinessHoursID>121c4da7-97f7-4eb5-b205-fed88eb7f8bc</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>5fa04579-8631-4a27-a463-20782b9b20fd</ClientID>
<DriverContactNo>sample string 8</DriverContactNo>
<DriverID>cae9ba4e-b634-4cd5-9e2b-a73d0e0a69af</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>4abed76d-242f-4106-9e83-31a342cd02a3</PartnerID>
<VehicleID>26654607-609c-4030-a4f2-ad63675e2275</VehicleID>
<VehicleNo>sample string 3</VehicleNo>
</Vehicle>
<VehicleRenewalID>583dbec3-e49d-427d-bfe7-714deb1a3815</VehicleRenewalID>
</VehicleRenewal>
</ArrayOfVehicleRenewal>