GET api/DeliveryAgent/Agents/GetToBeVerifiedAgents?PageNo={PageNo}&PageSize={PageSize}&SearchTerm={SearchTerm}

Request Information

URI Parameters

Name	Type	Additional information
PageNo	integer	Required
PageSize	integer	Required
SearchTerm	string	Required

Body Parameters

None.

Response Information

Resource Description

DeliveryAgentAPIVM

Name	Description	Type	Additional information
AgentList		Collection of utblDeliveryAgentInfoKey	None.
TotalRecords		integer	None.

Response Formats

application/json, text/json

Sample:

{
  "AgentList": [
    {
      "DeliveryAgentID": "sample string 1",
      "DeliveryAgentName": "sample string 2",
      "ProfilePicture": "sample string 3",
      "DOB": "2025-12-07T09:58:50.6183163+05:30",
      "Gender": "sample string 4",
      "Address": "sample string 5",
      "ReferralCode": "sample string 6",
      "RefereeReferralCode": "sample string 7",
      "IsCooperativeMember": true,
      "PreferredDeliveryZoneID": 9,
      "MobileNo": "sample string 10",
      "AccountEmailID": "sample string 11",
      "IsEmailConfirmed": true,
      "AlternativeEmailID": "sample string 13",
      "AccountUserID": "sample string 14",
      "IsActive": true,
      "IsApproved": true,
      "ApprovedBy": "sample string 17",
      "ApprovedTimeStamp": "2025-12-07T09:58:50.6183163+05:30",
      "IsRejected": true,
      "RejectedBy": "sample string 19",
      "RejectedTimeStamp": "2025-12-07T09:58:50.6183163+05:30",
      "IsVerificationOnProcess": true,
      "VerificationStatus": "sample string 21",
      "VerificationRequestRaisedOn": "2025-12-07T09:58:50.6183163+05:30",
      "IsInInduction": true,
      "InductionStartTimeStamp": "2025-12-07T09:58:50.6183163+05:30",
      "InductionEndTimeStamp": "2025-12-07T09:58:50.6183163+05:30",
      "DeliveryZoneID": 23,
      "DeliveryZoneName": "sample string 24",
      "DeliveryServicePreferences": [
        "sample string 1",
        "sample string 2"
      ],
      "IsDisabledByAdmin": true,
      "AddedByAdmin": true,
      "ChangeRequestMessage": "sample string 27",
      "WorkingForRestaurant": true,
      "RestaurantID": "sample string 29"
    },
    {
      "DeliveryAgentID": "sample string 1",
      "DeliveryAgentName": "sample string 2",
      "ProfilePicture": "sample string 3",
      "DOB": "2025-12-07T09:58:50.6183163+05:30",
      "Gender": "sample string 4",
      "Address": "sample string 5",
      "ReferralCode": "sample string 6",
      "RefereeReferralCode": "sample string 7",
      "IsCooperativeMember": true,
      "PreferredDeliveryZoneID": 9,
      "MobileNo": "sample string 10",
      "AccountEmailID": "sample string 11",
      "IsEmailConfirmed": true,
      "AlternativeEmailID": "sample string 13",
      "AccountUserID": "sample string 14",
      "IsActive": true,
      "IsApproved": true,
      "ApprovedBy": "sample string 17",
      "ApprovedTimeStamp": "2025-12-07T09:58:50.6183163+05:30",
      "IsRejected": true,
      "RejectedBy": "sample string 19",
      "RejectedTimeStamp": "2025-12-07T09:58:50.6183163+05:30",
      "IsVerificationOnProcess": true,
      "VerificationStatus": "sample string 21",
      "VerificationRequestRaisedOn": "2025-12-07T09:58:50.6183163+05:30",
      "IsInInduction": true,
      "InductionStartTimeStamp": "2025-12-07T09:58:50.6183163+05:30",
      "InductionEndTimeStamp": "2025-12-07T09:58:50.6183163+05:30",
      "DeliveryZoneID": 23,
      "DeliveryZoneName": "sample string 24",
      "DeliveryServicePreferences": [
        "sample string 1",
        "sample string 2"
      ],
      "IsDisabledByAdmin": true,
      "AddedByAdmin": true,
      "ChangeRequestMessage": "sample string 27",
      "WorkingForRestaurant": true,
      "RestaurantID": "sample string 29"
    }
  ],
  "TotalRecords": 1
}

application/xml, text/xml

Sample:

<DeliveryAgentAPIVM xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DeliveryAgent.Operations.CustomModels">
  <AgentList xmlns:d2p1="http://schemas.datacontract.org/2004/07/DeliveryAgent.Operations.Models">
    <d2p1:utblDeliveryAgentInfoKey>
      <d2p1:AccountEmailID>sample string 11</d2p1:AccountEmailID>
      <d2p1:AccountUserID>sample string 14</d2p1:AccountUserID>
      <d2p1:AddedByAdmin>true</d2p1:AddedByAdmin>
      <d2p1:Address>sample string 5</d2p1:Address>
      <d2p1:AlternativeEmailID>sample string 13</d2p1:AlternativeEmailID>
      <d2p1:ApprovedBy>sample string 17</d2p1:ApprovedBy>
      <d2p1:ApprovedTimeStamp>2025-12-07T09:58:50.6183163+05:30</d2p1:ApprovedTimeStamp>
      <d2p1:ChangeRequestMessage>sample string 27</d2p1:ChangeRequestMessage>
      <d2p1:DOB>2025-12-07T09:58:50.6183163+05:30</d2p1:DOB>
      <d2p1:DeliveryAgentID>sample string 1</d2p1:DeliveryAgentID>
      <d2p1:DeliveryAgentName>sample string 2</d2p1:DeliveryAgentName>
      <d2p1:DeliveryServicePreferences xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </d2p1:DeliveryServicePreferences>
      <d2p1:DeliveryZoneID>23</d2p1:DeliveryZoneID>
      <d2p1:DeliveryZoneName>sample string 24</d2p1:DeliveryZoneName>
      <d2p1:Gender>sample string 4</d2p1:Gender>
      <d2p1:InductionEndTimeStamp>2025-12-07T09:58:50.6183163+05:30</d2p1:InductionEndTimeStamp>
      <d2p1:InductionStartTimeStamp>2025-12-07T09:58:50.6183163+05:30</d2p1:InductionStartTimeStamp>
      <d2p1:IsActive>true</d2p1:IsActive>
      <d2p1:IsApproved>true</d2p1:IsApproved>
      <d2p1:IsCooperativeMember>true</d2p1:IsCooperativeMember>
      <d2p1:IsDisabledByAdmin>true</d2p1:IsDisabledByAdmin>
      <d2p1:IsEmailConfirmed>true</d2p1:IsEmailConfirmed>
      <d2p1:IsInInduction>true</d2p1:IsInInduction>
      <d2p1:IsRejected>true</d2p1:IsRejected>
      <d2p1:IsVerificationOnProcess>true</d2p1:IsVerificationOnProcess>
      <d2p1:MobileNo>sample string 10</d2p1:MobileNo>
      <d2p1:PreferredDeliveryZoneID>9</d2p1:PreferredDeliveryZoneID>
      <d2p1:ProfilePicture>sample string 3</d2p1:ProfilePicture>
      <d2p1:RefereeReferralCode>sample string 7</d2p1:RefereeReferralCode>
      <d2p1:ReferralCode>sample string 6</d2p1:ReferralCode>
      <d2p1:RejectedBy>sample string 19</d2p1:RejectedBy>
      <d2p1:RejectedTimeStamp>2025-12-07T09:58:50.6183163+05:30</d2p1:RejectedTimeStamp>
      <d2p1:RestaurantID>sample string 29</d2p1:RestaurantID>
      <d2p1:VerificationRequestRaisedOn>2025-12-07T09:58:50.6183163+05:30</d2p1:VerificationRequestRaisedOn>
      <d2p1:VerificationStatus>sample string 21</d2p1:VerificationStatus>
      <d2p1:WorkingForRestaurant>true</d2p1:WorkingForRestaurant>
    </d2p1:utblDeliveryAgentInfoKey>
    <d2p1:utblDeliveryAgentInfoKey>
      <d2p1:AccountEmailID>sample string 11</d2p1:AccountEmailID>
      <d2p1:AccountUserID>sample string 14</d2p1:AccountUserID>
      <d2p1:AddedByAdmin>true</d2p1:AddedByAdmin>
      <d2p1:Address>sample string 5</d2p1:Address>
      <d2p1:AlternativeEmailID>sample string 13</d2p1:AlternativeEmailID>
      <d2p1:ApprovedBy>sample string 17</d2p1:ApprovedBy>
      <d2p1:ApprovedTimeStamp>2025-12-07T09:58:50.6183163+05:30</d2p1:ApprovedTimeStamp>
      <d2p1:ChangeRequestMessage>sample string 27</d2p1:ChangeRequestMessage>
      <d2p1:DOB>2025-12-07T09:58:50.6183163+05:30</d2p1:DOB>
      <d2p1:DeliveryAgentID>sample string 1</d2p1:DeliveryAgentID>
      <d2p1:DeliveryAgentName>sample string 2</d2p1:DeliveryAgentName>
      <d2p1:DeliveryServicePreferences xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </d2p1:DeliveryServicePreferences>
      <d2p1:DeliveryZoneID>23</d2p1:DeliveryZoneID>
      <d2p1:DeliveryZoneName>sample string 24</d2p1:DeliveryZoneName>
      <d2p1:Gender>sample string 4</d2p1:Gender>
      <d2p1:InductionEndTimeStamp>2025-12-07T09:58:50.6183163+05:30</d2p1:InductionEndTimeStamp>
      <d2p1:InductionStartTimeStamp>2025-12-07T09:58:50.6183163+05:30</d2p1:InductionStartTimeStamp>
      <d2p1:IsActive>true</d2p1:IsActive>
      <d2p1:IsApproved>true</d2p1:IsApproved>
      <d2p1:IsCooperativeMember>true</d2p1:IsCooperativeMember>
      <d2p1:IsDisabledByAdmin>true</d2p1:IsDisabledByAdmin>
      <d2p1:IsEmailConfirmed>true</d2p1:IsEmailConfirmed>
      <d2p1:IsInInduction>true</d2p1:IsInInduction>
      <d2p1:IsRejected>true</d2p1:IsRejected>
      <d2p1:IsVerificationOnProcess>true</d2p1:IsVerificationOnProcess>
      <d2p1:MobileNo>sample string 10</d2p1:MobileNo>
      <d2p1:PreferredDeliveryZoneID>9</d2p1:PreferredDeliveryZoneID>
      <d2p1:ProfilePicture>sample string 3</d2p1:ProfilePicture>
      <d2p1:RefereeReferralCode>sample string 7</d2p1:RefereeReferralCode>
      <d2p1:ReferralCode>sample string 6</d2p1:ReferralCode>
      <d2p1:RejectedBy>sample string 19</d2p1:RejectedBy>
      <d2p1:RejectedTimeStamp>2025-12-07T09:58:50.6183163+05:30</d2p1:RejectedTimeStamp>
      <d2p1:RestaurantID>sample string 29</d2p1:RestaurantID>
      <d2p1:VerificationRequestRaisedOn>2025-12-07T09:58:50.6183163+05:30</d2p1:VerificationRequestRaisedOn>
      <d2p1:VerificationStatus>sample string 21</d2p1:VerificationStatus>
      <d2p1:WorkingForRestaurant>true</d2p1:WorkingForRestaurant>
    </d2p1:utblDeliveryAgentInfoKey>
  </AgentList>
  <TotalRecords>1</TotalRecords>
</DeliveryAgentAPIVM>