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	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": "7c46ffe2-610b-4b60-aeb9-32c1af4a54c9",
    "Vehicle": {
      "VehicleID": "0e0db3f6-5e85-4e83-be01-b07ba077a4f8",
      "Name": "sample string 2",
      "VehicleNo": "sample string 3",
      "Odometer": 4,
      "ModelName": "sample string 5",
      "DriverID": "cc446d37-d27c-4477-8197-8278138719c9",
      "DriverName": "sample string 7",
      "DriverContactNo": "sample string 8",
      "IMEINo": "sample string 9",
      "ClientID": "01b95c2d-b5e5-4d33-8683-bbfe869d5d1d",
      "PartnerID": "cba97f90-023d-40c7-b055-845b98fc2e20"
    },
    "RenewalType": {
      "RenewalTypeID": "a4f2e663-42fb-4439-ae04-bb24028c74a0",
      "Name": "sample string 2",
      "FrequencyDays": 3,
      "Description": "sample string 4",
      "Id": "68312a19-0a92-4f2a-bac3-92f2e30bf5a2",
      "UserName": "sample string 6",
      "UserID": "24e16243-9aae-44d5-bb1c-ca4fa98c3800",
      "CreatedBy": "sample string 8",
      "CreatedOn": "2025-05-20T22:27:35.875638+04:00",
      "ClientID": "320c74ab-9d8a-471a-bd97-be2d7d075735",
      "ClientName": "sample string 11",
      "PartnerID": "c45dcd03-9b01-44d5-942d-3b2fa05e45cd",
      "PartnerName": "sample string 13"
    },
    "DueDate": "2025-05-20T22:27:35.875638+04:00",
    "ExpiryDate": "2025-05-20T22:27:35.875638+04:00",
    "RenewalDoneOn": "2025-05-20T22:27:35.875638+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": "f07de4ba-d6e0-4503-a74a-3edf13805a2d",
      "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": "62ff2079-5f64-458f-b8e7-0432c7b72c58",
      "AttachmentData": "QEA=",
      "AttachmentDataBase64": "sample string 2",
      "ContentType": "sample string 3",
      "FileName": "sample string 4",
      "ImageString": "sample string 5",
      "IsDeleted": true
    },
    "Id": "0a60e2e1-8dcb-4398-be78-d53c001ef029",
    "UserName": "sample string 13",
    "UserID": "0b6ea781-81ce-44ff-ac5d-25c5f93c97a9",
    "CreatedBy": "sample string 15",
    "CreatedOn": "2025-05-20T22:27:35.875638+04:00",
    "ClientID": "28addcf8-11d1-46bd-b001-798b0e3691dd",
    "ClientName": "sample string 18",
    "PartnerID": "72b3bbba-5c94-47f9-90f6-40ae38876a1c",
    "PartnerName": "sample string 20"
  },
  {
    "VehicleRenewalID": "7c46ffe2-610b-4b60-aeb9-32c1af4a54c9",
    "Vehicle": {
      "VehicleID": "0e0db3f6-5e85-4e83-be01-b07ba077a4f8",
      "Name": "sample string 2",
      "VehicleNo": "sample string 3",
      "Odometer": 4,
      "ModelName": "sample string 5",
      "DriverID": "cc446d37-d27c-4477-8197-8278138719c9",
      "DriverName": "sample string 7",
      "DriverContactNo": "sample string 8",
      "IMEINo": "sample string 9",
      "ClientID": "01b95c2d-b5e5-4d33-8683-bbfe869d5d1d",
      "PartnerID": "cba97f90-023d-40c7-b055-845b98fc2e20"
    },
    "RenewalType": {
      "RenewalTypeID": "a4f2e663-42fb-4439-ae04-bb24028c74a0",
      "Name": "sample string 2",
      "FrequencyDays": 3,
      "Description": "sample string 4",
      "Id": "68312a19-0a92-4f2a-bac3-92f2e30bf5a2",
      "UserName": "sample string 6",
      "UserID": "24e16243-9aae-44d5-bb1c-ca4fa98c3800",
      "CreatedBy": "sample string 8",
      "CreatedOn": "2025-05-20T22:27:35.875638+04:00",
      "ClientID": "320c74ab-9d8a-471a-bd97-be2d7d075735",
      "ClientName": "sample string 11",
      "PartnerID": "c45dcd03-9b01-44d5-942d-3b2fa05e45cd",
      "PartnerName": "sample string 13"
    },
    "DueDate": "2025-05-20T22:27:35.875638+04:00",
    "ExpiryDate": "2025-05-20T22:27:35.875638+04:00",
    "RenewalDoneOn": "2025-05-20T22:27:35.875638+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": "f07de4ba-d6e0-4503-a74a-3edf13805a2d",
      "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": "62ff2079-5f64-458f-b8e7-0432c7b72c58",
      "AttachmentData": "QEA=",
      "AttachmentDataBase64": "sample string 2",
      "ContentType": "sample string 3",
      "FileName": "sample string 4",
      "ImageString": "sample string 5",
      "IsDeleted": true
    },
    "Id": "0a60e2e1-8dcb-4398-be78-d53c001ef029",
    "UserName": "sample string 13",
    "UserID": "0b6ea781-81ce-44ff-ac5d-25c5f93c97a9",
    "CreatedBy": "sample string 15",
    "CreatedOn": "2025-05-20T22:27:35.875638+04:00",
    "ClientID": "28addcf8-11d1-46bd-b001-798b0e3691dd",
    "ClientName": "sample string 18",
    "PartnerID": "72b3bbba-5c94-47f9-90f6-40ae38876a1c",
    "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>28addcf8-11d1-46bd-b001-798b0e3691dd</ClientID>
    <ClientName>sample string 18</ClientName>
    <CreatedBy>sample string 15</CreatedBy>
    <CreatedOn>2025-05-20T22:27:35.875638+04:00</CreatedOn>
    <Id>0a60e2e1-8dcb-4398-be78-d53c001ef029</Id>
    <PartnerID>72b3bbba-5c94-47f9-90f6-40ae38876a1c</PartnerID>
    <PartnerName>sample string 20</PartnerName>
    <UserID>0b6ea781-81ce-44ff-ac5d-25c5f93c97a9</UserID>
    <UserName>sample string 13</UserName>
    <AmountSpent>7</AmountSpent>
    <Attachment>
      <AttachmentData>QEA=</AttachmentData>
      <AttachmentDataBase64>sample string 2</AttachmentDataBase64>
      <AttachmentID>62ff2079-5f64-458f-b8e7-0432c7b72c58</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-05-20T22:27:35.875638+04:00</DueDate>
    <DueDetail>sample string 11</DueDetail>
    <ExpiryDate>2025-05-20T22:27:35.875638+04:00</ExpiryDate>
    <IsOverdue>true</IsOverdue>
    <Note>sample string 8</Note>
    <OverdueReason>sample string 6</OverdueReason>
    <ReminderBeforeDays>10</ReminderBeforeDays>
    <RenewalDoneOn>2025-05-20T22:27:35.875638+04:00</RenewalDoneOn>
    <RenewalType>
      <ClientID>320c74ab-9d8a-471a-bd97-be2d7d075735</ClientID>
      <ClientName>sample string 11</ClientName>
      <CreatedBy>sample string 8</CreatedBy>
      <CreatedOn>2025-05-20T22:27:35.875638+04:00</CreatedOn>
      <Id>68312a19-0a92-4f2a-bac3-92f2e30bf5a2</Id>
      <PartnerID>c45dcd03-9b01-44d5-942d-3b2fa05e45cd</PartnerID>
      <PartnerName>sample string 13</PartnerName>
      <UserID>24e16243-9aae-44d5-bb1c-ca4fa98c3800</UserID>
      <UserName>sample string 6</UserName>
      <Description>sample string 4</Description>
      <FrequencyDays>3</FrequencyDays>
      <Name>sample string 2</Name>
      <RenewalTypeID>a4f2e663-42fb-4439-ae04-bb24028c74a0</RenewalTypeID>
    </RenewalType>
    <UsersToNotify>
      <BusinessHoursID>f07de4ba-d6e0-4503-a74a-3edf13805a2d</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>01b95c2d-b5e5-4d33-8683-bbfe869d5d1d</ClientID>
      <DriverContactNo>sample string 8</DriverContactNo>
      <DriverID>cc446d37-d27c-4477-8197-8278138719c9</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>cba97f90-023d-40c7-b055-845b98fc2e20</PartnerID>
      <VehicleID>0e0db3f6-5e85-4e83-be01-b07ba077a4f8</VehicleID>
      <VehicleNo>sample string 3</VehicleNo>
    </Vehicle>
    <VehicleRenewalID>7c46ffe2-610b-4b60-aeb9-32c1af4a54c9</VehicleRenewalID>
  </VehicleRenewal>
  <VehicleRenewal>
    <ClientID>28addcf8-11d1-46bd-b001-798b0e3691dd</ClientID>
    <ClientName>sample string 18</ClientName>
    <CreatedBy>sample string 15</CreatedBy>
    <CreatedOn>2025-05-20T22:27:35.875638+04:00</CreatedOn>
    <Id>0a60e2e1-8dcb-4398-be78-d53c001ef029</Id>
    <PartnerID>72b3bbba-5c94-47f9-90f6-40ae38876a1c</PartnerID>
    <PartnerName>sample string 20</PartnerName>
    <UserID>0b6ea781-81ce-44ff-ac5d-25c5f93c97a9</UserID>
    <UserName>sample string 13</UserName>
    <AmountSpent>7</AmountSpent>
    <Attachment>
      <AttachmentData>QEA=</AttachmentData>
      <AttachmentDataBase64>sample string 2</AttachmentDataBase64>
      <AttachmentID>62ff2079-5f64-458f-b8e7-0432c7b72c58</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-05-20T22:27:35.875638+04:00</DueDate>
    <DueDetail>sample string 11</DueDetail>
    <ExpiryDate>2025-05-20T22:27:35.875638+04:00</ExpiryDate>
    <IsOverdue>true</IsOverdue>
    <Note>sample string 8</Note>
    <OverdueReason>sample string 6</OverdueReason>
    <ReminderBeforeDays>10</ReminderBeforeDays>
    <RenewalDoneOn>2025-05-20T22:27:35.875638+04:00</RenewalDoneOn>
    <RenewalType>
      <ClientID>320c74ab-9d8a-471a-bd97-be2d7d075735</ClientID>
      <ClientName>sample string 11</ClientName>
      <CreatedBy>sample string 8</CreatedBy>
      <CreatedOn>2025-05-20T22:27:35.875638+04:00</CreatedOn>
      <Id>68312a19-0a92-4f2a-bac3-92f2e30bf5a2</Id>
      <PartnerID>c45dcd03-9b01-44d5-942d-3b2fa05e45cd</PartnerID>
      <PartnerName>sample string 13</PartnerName>
      <UserID>24e16243-9aae-44d5-bb1c-ca4fa98c3800</UserID>
      <UserName>sample string 6</UserName>
      <Description>sample string 4</Description>
      <FrequencyDays>3</FrequencyDays>
      <Name>sample string 2</Name>
      <RenewalTypeID>a4f2e663-42fb-4439-ae04-bb24028c74a0</RenewalTypeID>
    </RenewalType>
    <UsersToNotify>
      <BusinessHoursID>f07de4ba-d6e0-4503-a74a-3edf13805a2d</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>01b95c2d-b5e5-4d33-8683-bbfe869d5d1d</ClientID>
      <DriverContactNo>sample string 8</DriverContactNo>
      <DriverID>cc446d37-d27c-4477-8197-8278138719c9</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>cba97f90-023d-40c7-b055-845b98fc2e20</PartnerID>
      <VehicleID>0e0db3f6-5e85-4e83-be01-b07ba077a4f8</VehicleID>
      <VehicleNo>sample string 3</VehicleNo>
    </Vehicle>
    <VehicleRenewalID>7c46ffe2-610b-4b60-aeb9-32c1af4a54c9</VehicleRenewalID>
  </VehicleRenewal>
</ArrayOfVehicleRenewal>

Api Documentation

GET Api/Renewal?param={param}

Request Information

URI Parameters

Body Parameters

Response Information

Resource Description

Response Formats

application/json, text/json

application/xml, text/xml