GET api/Courier/GetPagedCouriers?Page={Page}&ItemsPerPage={ItemsPerPage}&SortBy={SortBy}&Reverse={Reverse}&JobId={JobId}&DiomNr={DiomNr}

Request Information

URI Parameters

Name Description Type Additional information
Page

integer

None.

ItemsPerPage

integer

None.

SortBy

string

None.

Reverse

boolean

None.

JobId

integer

None.

DiomNr

integer

None.

Body Parameters

None.

Response Information

Resource Description

CourierGridModel
Name Description Type Additional information
Couriers

Collection of EmployeeModel

None.

TotalRecords

integer

None.

Response Formats

application/json, text/json

Sample:
{
  "Couriers": [
    {
      "Id": 1,
      "SourceId": "sample string 2",
      "FullName": "sample string 3",
      "ServiceProviderId": 4,
      "UserId": "sample string 5",
      "StatusId": 64,
      "IsDeleted": true,
      "CreatedBy": "sample string 8",
      "DeviceId": 1,
      "LastActive": "2025-05-17T00:32:20.6778724Z",
      "Progress": {
        "TotalAssignJobs": 1,
        "TotalCompletedJobs": 1
      },
      "PickupPoint": "sample string 9",
      "DistributorLocationId": 10,
      "BatteryStatus": "sample string 11",
      "StorageStatus": "sample string 12",
      "PhoneNo": "sample string 13",
      "LastActiveMin": 14.1,
      "JobIds": "sample string 15",
      "DisplayName": "sample string 16",
      "IsFutureStart": true,
      "StartTime": "2025-05-17T00:32:20.6778724Z",
      "EndTime": "2025-05-17T00:32:20.6778724Z",
      "TrackingStatusId": 64,
      "TrackingActiveStatus": true,
      "IsTimeDifference": 1
    },
    {
      "Id": 1,
      "SourceId": "sample string 2",
      "FullName": "sample string 3",
      "ServiceProviderId": 4,
      "UserId": "sample string 5",
      "StatusId": 64,
      "IsDeleted": true,
      "CreatedBy": "sample string 8",
      "DeviceId": 1,
      "LastActive": "2025-05-17T00:32:20.6778724Z",
      "Progress": {
        "TotalAssignJobs": 1,
        "TotalCompletedJobs": 1
      },
      "PickupPoint": "sample string 9",
      "DistributorLocationId": 10,
      "BatteryStatus": "sample string 11",
      "StorageStatus": "sample string 12",
      "PhoneNo": "sample string 13",
      "LastActiveMin": 14.1,
      "JobIds": "sample string 15",
      "DisplayName": "sample string 16",
      "IsFutureStart": true,
      "StartTime": "2025-05-17T00:32:20.6778724Z",
      "EndTime": "2025-05-17T00:32:20.6778724Z",
      "TrackingStatusId": 64,
      "TrackingActiveStatus": true,
      "IsTimeDifference": 1
    }
  ],
  "TotalRecords": 1
}

text/html

Sample:
{"Couriers":[{"Id":1,"SourceId":"sample string 2","FullName":"sample string 3","ServiceProviderId":4,"UserId":"sample string 5","StatusId":64,"IsDeleted":true,"CreatedBy":"sample string 8","DeviceId":1,"LastActive":"2025-05-17T00:32:20.6778724Z","Progress":{"TotalAssignJobs":1,"TotalCompletedJobs":1},"PickupPoint":"sample string 9","DistributorLocationId":10,"BatteryStatus":"sample string 11","StorageStatus":"sample string 12","PhoneNo":"sample string 13","LastActiveMin":14.1,"JobIds":"sample string 15","DisplayName":"sample string 16","IsFutureStart":true,"StartTime":"2025-05-17T00:32:20.6778724Z","EndTime":"2025-05-17T00:32:20.6778724Z","TrackingStatusId":64,"TrackingActiveStatus":true,"IsTimeDifference":1},{"Id":1,"SourceId":"sample string 2","FullName":"sample string 3","ServiceProviderId":4,"UserId":"sample string 5","StatusId":64,"IsDeleted":true,"CreatedBy":"sample string 8","DeviceId":1,"LastActive":"2025-05-17T00:32:20.6778724Z","Progress":{"TotalAssignJobs":1,"TotalCompletedJobs":1},"PickupPoint":"sample string 9","DistributorLocationId":10,"BatteryStatus":"sample string 11","StorageStatus":"sample string 12","PhoneNo":"sample string 13","LastActiveMin":14.1,"JobIds":"sample string 15","DisplayName":"sample string 16","IsFutureStart":true,"StartTime":"2025-05-17T00:32:20.6778724Z","EndTime":"2025-05-17T00:32:20.6778724Z","TrackingStatusId":64,"TrackingActiveStatus":true,"IsTimeDifference":1}],"TotalRecords":1}

application/xml, text/xml

Sample:
<CourierGridModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DAO.Models.Employee">
  <Couriers>
    <EmployeeModel>
      <BatteryStatus>sample string 11</BatteryStatus>
      <CreatedBy>sample string 8</CreatedBy>
      <DeviceId>1</DeviceId>
      <DisplayName>sample string 16</DisplayName>
      <DistributorLocationId>10</DistributorLocationId>
      <EndTime>2025-05-17T00:32:20.6778724Z</EndTime>
      <FullName>sample string 3</FullName>
      <Id>1</Id>
      <IsDeleted>true</IsDeleted>
      <IsFutureStart>true</IsFutureStart>
      <IsTimeDifference>1</IsTimeDifference>
      <JobIds>sample string 15</JobIds>
      <LastActive>2025-05-17T00:32:20.6778724Z</LastActive>
      <LastActiveMin>14.1</LastActiveMin>
      <PhoneNo>sample string 13</PhoneNo>
      <PickupPoint>sample string 9</PickupPoint>
      <Progress>
        <TotalAssignJobs>1</TotalAssignJobs>
        <TotalCompletedJobs>1</TotalCompletedJobs>
      </Progress>
      <ServiceProviderId>4</ServiceProviderId>
      <SourceId>sample string 2</SourceId>
      <StartTime>2025-05-17T00:32:20.6778724Z</StartTime>
      <StatusId>64</StatusId>
      <StorageStatus>sample string 12</StorageStatus>
      <TrackingActiveStatus>true</TrackingActiveStatus>
      <TrackingStatusId>64</TrackingStatusId>
      <UserId>sample string 5</UserId>
    </EmployeeModel>
    <EmployeeModel>
      <BatteryStatus>sample string 11</BatteryStatus>
      <CreatedBy>sample string 8</CreatedBy>
      <DeviceId>1</DeviceId>
      <DisplayName>sample string 16</DisplayName>
      <DistributorLocationId>10</DistributorLocationId>
      <EndTime>2025-05-17T00:32:20.6778724Z</EndTime>
      <FullName>sample string 3</FullName>
      <Id>1</Id>
      <IsDeleted>true</IsDeleted>
      <IsFutureStart>true</IsFutureStart>
      <IsTimeDifference>1</IsTimeDifference>
      <JobIds>sample string 15</JobIds>
      <LastActive>2025-05-17T00:32:20.6778724Z</LastActive>
      <LastActiveMin>14.1</LastActiveMin>
      <PhoneNo>sample string 13</PhoneNo>
      <PickupPoint>sample string 9</PickupPoint>
      <Progress>
        <TotalAssignJobs>1</TotalAssignJobs>
        <TotalCompletedJobs>1</TotalCompletedJobs>
      </Progress>
      <ServiceProviderId>4</ServiceProviderId>
      <SourceId>sample string 2</SourceId>
      <StartTime>2025-05-17T00:32:20.6778724Z</StartTime>
      <StatusId>64</StatusId>
      <StorageStatus>sample string 12</StorageStatus>
      <TrackingActiveStatus>true</TrackingActiveStatus>
      <TrackingStatusId>64</TrackingStatusId>
      <UserId>sample string 5</UserId>
    </EmployeeModel>
  </Couriers>
  <TotalRecords>1</TotalRecords>
</CourierGridModel>