GET Api/Renewal?clientID={clientID}&vehicleID={vehicleID}&renewalTypeID={renewalTypeID}

Request Information

URI Parameters

NameDescriptionTypeAdditional 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
NameDescriptionTypeAdditional 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": "f9385590-7cde-4196-9e9f-904a1ea3c001",
    "Vehicle": {
      "VehicleID": "22d72e85-d2c6-495f-bb94-9bd840582b4e",
      "Name": "sample string 2",
      "VehicleNo": "sample string 3",
      "Odometer": 4,
      "ModelName": "sample string 5",
      "DriverID": "33edd5de-8ac3-4fbf-9a6c-cfb516dd8be6",
      "DriverName": "sample string 7",
      "DriverContactNo": "sample string 8",
      "IMEINo": "sample string 9",
      "ClientID": "f453a16a-1d32-4b5c-8489-06290686add0",
      "PartnerID": "f95d17f4-33d1-477f-b9e8-ef20aa171dcc"
    },
    "RenewalType": {
      "RenewalTypeID": "dab741aa-033c-4fb8-920a-6e7a7d3d840b",
      "Name": "sample string 2",
      "FrequencyDays": 3,
      "Description": "sample string 4",
      "Id": "628c9ab4-0c3a-4dc5-b5e7-2d4ae9c3ec9c",
      "UserName": "sample string 6",
      "UserID": "45ea51b2-1c9f-4304-97db-20ce53805034",
      "CreatedBy": "sample string 8",
      "CreatedOn": "2025-07-07T10:48:08.4427066+04:00",
      "ClientID": "1771d0df-54f8-4d2d-a544-1d1332cd7b8f",
      "ClientName": "sample string 11",
      "PartnerID": "5c4bb799-93dc-4e84-8886-ba346a5e5cd0",
      "PartnerName": "sample string 13"
    },
    "DueDate": "2025-07-07T10:48:08.4427066+04:00",
    "ExpiryDate": "2025-07-07T10:48:08.4427066+04:00",
    "RenewalDoneOn": "2025-07-07T10:48:08.4427066+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": "8672ddb7-3a24-4a6a-874b-55edc06bc9a4",
      "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": "2c40c9be-f92e-4aa3-aa26-d52f5519176e",
      "AttachmentData": "QEA=",
      "AttachmentDataBase64": "sample string 2",
      "ContentType": "sample string 3",
      "FileName": "sample string 4",
      "ImageString": "sample string 5",
      "IsDeleted": true
    },
    "Id": "1a8c8962-f2be-4454-8409-6f7c1fe1aee1",
    "UserName": "sample string 13",
    "UserID": "a40f8c61-7243-471d-a03a-91a0506d561b",
    "CreatedBy": "sample string 15",
    "CreatedOn": "2025-07-07T10:48:08.4427066+04:00",
    "ClientID": "019d5925-d4da-45c1-b91e-d92737e9154e",
    "ClientName": "sample string 18",
    "PartnerID": "1138e3ea-3115-4d96-a2eb-082c5be544db",
    "PartnerName": "sample string 20"
  },
  {
    "VehicleRenewalID": "f9385590-7cde-4196-9e9f-904a1ea3c001",
    "Vehicle": {
      "VehicleID": "22d72e85-d2c6-495f-bb94-9bd840582b4e",
      "Name": "sample string 2",
      "VehicleNo": "sample string 3",
      "Odometer": 4,
      "ModelName": "sample string 5",
      "DriverID": "33edd5de-8ac3-4fbf-9a6c-cfb516dd8be6",
      "DriverName": "sample string 7",
      "DriverContactNo": "sample string 8",
      "IMEINo": "sample string 9",
      "ClientID": "f453a16a-1d32-4b5c-8489-06290686add0",
      "PartnerID": "f95d17f4-33d1-477f-b9e8-ef20aa171dcc"
    },
    "RenewalType": {
      "RenewalTypeID": "dab741aa-033c-4fb8-920a-6e7a7d3d840b",
      "Name": "sample string 2",
      "FrequencyDays": 3,
      "Description": "sample string 4",
      "Id": "628c9ab4-0c3a-4dc5-b5e7-2d4ae9c3ec9c",
      "UserName": "sample string 6",
      "UserID": "45ea51b2-1c9f-4304-97db-20ce53805034",
      "CreatedBy": "sample string 8",
      "CreatedOn": "2025-07-07T10:48:08.4427066+04:00",
      "ClientID": "1771d0df-54f8-4d2d-a544-1d1332cd7b8f",
      "ClientName": "sample string 11",
      "PartnerID": "5c4bb799-93dc-4e84-8886-ba346a5e5cd0",
      "PartnerName": "sample string 13"
    },
    "DueDate": "2025-07-07T10:48:08.4427066+04:00",
    "ExpiryDate": "2025-07-07T10:48:08.4427066+04:00",
    "RenewalDoneOn": "2025-07-07T10:48:08.4427066+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": "8672ddb7-3a24-4a6a-874b-55edc06bc9a4",
      "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": "2c40c9be-f92e-4aa3-aa26-d52f5519176e",
      "AttachmentData": "QEA=",
      "AttachmentDataBase64": "sample string 2",
      "ContentType": "sample string 3",
      "FileName": "sample string 4",
      "ImageString": "sample string 5",
      "IsDeleted": true
    },
    "Id": "1a8c8962-f2be-4454-8409-6f7c1fe1aee1",
    "UserName": "sample string 13",
    "UserID": "a40f8c61-7243-471d-a03a-91a0506d561b",
    "CreatedBy": "sample string 15",
    "CreatedOn": "2025-07-07T10:48:08.4427066+04:00",
    "ClientID": "019d5925-d4da-45c1-b91e-d92737e9154e",
    "ClientName": "sample string 18",
    "PartnerID": "1138e3ea-3115-4d96-a2eb-082c5be544db",
    "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>019d5925-d4da-45c1-b91e-d92737e9154e</ClientID>
    <ClientName>sample string 18</ClientName>
    <CreatedBy>sample string 15</CreatedBy>
    <CreatedOn>2025-07-07T10:48:08.4427066+04:00</CreatedOn>
    <Id>1a8c8962-f2be-4454-8409-6f7c1fe1aee1</Id>
    <PartnerID>1138e3ea-3115-4d96-a2eb-082c5be544db</PartnerID>
    <PartnerName>sample string 20</PartnerName>
    <UserID>a40f8c61-7243-471d-a03a-91a0506d561b</UserID>
    <UserName>sample string 13</UserName>
    <AmountSpent>7</AmountSpent>
    <Attachment>
      <AttachmentData>QEA=</AttachmentData>
      <AttachmentDataBase64>sample string 2</AttachmentDataBase64>
      <AttachmentID>2c40c9be-f92e-4aa3-aa26-d52f5519176e</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-07-07T10:48:08.4427066+04:00</DueDate>
    <DueDetail>sample string 11</DueDetail>
    <ExpiryDate>2025-07-07T10:48:08.4427066+04:00</ExpiryDate>
    <IsOverdue>true</IsOverdue>
    <Note>sample string 8</Note>
    <OverdueReason>sample string 6</OverdueReason>
    <ReminderBeforeDays>10</ReminderBeforeDays>
    <RenewalDoneOn>2025-07-07T10:48:08.4427066+04:00</RenewalDoneOn>
    <RenewalType>
      <ClientID>1771d0df-54f8-4d2d-a544-1d1332cd7b8f</ClientID>
      <ClientName>sample string 11</ClientName>
      <CreatedBy>sample string 8</CreatedBy>
      <CreatedOn>2025-07-07T10:48:08.4427066+04:00</CreatedOn>
      <Id>628c9ab4-0c3a-4dc5-b5e7-2d4ae9c3ec9c</Id>
      <PartnerID>5c4bb799-93dc-4e84-8886-ba346a5e5cd0</PartnerID>
      <PartnerName>sample string 13</PartnerName>
      <UserID>45ea51b2-1c9f-4304-97db-20ce53805034</UserID>
      <UserName>sample string 6</UserName>
      <Description>sample string 4</Description>
      <FrequencyDays>3</FrequencyDays>
      <Name>sample string 2</Name>
      <RenewalTypeID>dab741aa-033c-4fb8-920a-6e7a7d3d840b</RenewalTypeID>
    </RenewalType>
    <UsersToNotify>
      <BusinessHoursID>8672ddb7-3a24-4a6a-874b-55edc06bc9a4</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>f453a16a-1d32-4b5c-8489-06290686add0</ClientID>
      <DriverContactNo>sample string 8</DriverContactNo>
      <DriverID>33edd5de-8ac3-4fbf-9a6c-cfb516dd8be6</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>f95d17f4-33d1-477f-b9e8-ef20aa171dcc</PartnerID>
      <VehicleID>22d72e85-d2c6-495f-bb94-9bd840582b4e</VehicleID>
      <VehicleNo>sample string 3</VehicleNo>
    </Vehicle>
    <VehicleRenewalID>f9385590-7cde-4196-9e9f-904a1ea3c001</VehicleRenewalID>
  </VehicleRenewal>
  <VehicleRenewal>
    <ClientID>019d5925-d4da-45c1-b91e-d92737e9154e</ClientID>
    <ClientName>sample string 18</ClientName>
    <CreatedBy>sample string 15</CreatedBy>
    <CreatedOn>2025-07-07T10:48:08.4427066+04:00</CreatedOn>
    <Id>1a8c8962-f2be-4454-8409-6f7c1fe1aee1</Id>
    <PartnerID>1138e3ea-3115-4d96-a2eb-082c5be544db</PartnerID>
    <PartnerName>sample string 20</PartnerName>
    <UserID>a40f8c61-7243-471d-a03a-91a0506d561b</UserID>
    <UserName>sample string 13</UserName>
    <AmountSpent>7</AmountSpent>
    <Attachment>
      <AttachmentData>QEA=</AttachmentData>
      <AttachmentDataBase64>sample string 2</AttachmentDataBase64>
      <AttachmentID>2c40c9be-f92e-4aa3-aa26-d52f5519176e</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-07-07T10:48:08.4427066+04:00</DueDate>
    <DueDetail>sample string 11</DueDetail>
    <ExpiryDate>2025-07-07T10:48:08.4427066+04:00</ExpiryDate>
    <IsOverdue>true</IsOverdue>
    <Note>sample string 8</Note>
    <OverdueReason>sample string 6</OverdueReason>
    <ReminderBeforeDays>10</ReminderBeforeDays>
    <RenewalDoneOn>2025-07-07T10:48:08.4427066+04:00</RenewalDoneOn>
    <RenewalType>
      <ClientID>1771d0df-54f8-4d2d-a544-1d1332cd7b8f</ClientID>
      <ClientName>sample string 11</ClientName>
      <CreatedBy>sample string 8</CreatedBy>
      <CreatedOn>2025-07-07T10:48:08.4427066+04:00</CreatedOn>
      <Id>628c9ab4-0c3a-4dc5-b5e7-2d4ae9c3ec9c</Id>
      <PartnerID>5c4bb799-93dc-4e84-8886-ba346a5e5cd0</PartnerID>
      <PartnerName>sample string 13</PartnerName>
      <UserID>45ea51b2-1c9f-4304-97db-20ce53805034</UserID>
      <UserName>sample string 6</UserName>
      <Description>sample string 4</Description>
      <FrequencyDays>3</FrequencyDays>
      <Name>sample string 2</Name>
      <RenewalTypeID>dab741aa-033c-4fb8-920a-6e7a7d3d840b</RenewalTypeID>
    </RenewalType>
    <UsersToNotify>
      <BusinessHoursID>8672ddb7-3a24-4a6a-874b-55edc06bc9a4</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>f453a16a-1d32-4b5c-8489-06290686add0</ClientID>
      <DriverContactNo>sample string 8</DriverContactNo>
      <DriverID>33edd5de-8ac3-4fbf-9a6c-cfb516dd8be6</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>f95d17f4-33d1-477f-b9e8-ef20aa171dcc</PartnerID>
      <VehicleID>22d72e85-d2c6-495f-bb94-9bd840582b4e</VehicleID>
      <VehicleNo>sample string 3</VehicleNo>
    </Vehicle>
    <VehicleRenewalID>f9385590-7cde-4196-9e9f-904a1ea3c001</VehicleRenewalID>
  </VehicleRenewal>
</ArrayOfVehicleRenewal>