GET users/courierlocations?companyId={companyId}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
companyId

integer

Required

Body Parameters

None.

Response Information

Resource Description

CourierLocationViewModel
NameDescriptionTypeAdditional information
CourierId

integer

None.

Latitude

decimal number

None.

Longitude

decimal number

None.

Date

date

None.

Courier

UserViewModel

None.

Response Formats

application/json, text/json

Sample:
{
  "courier": {
    "id": 1,
    "firstName": "sample string 1",
    "lastName": "sample string 2",
    "fullName": "sample string 3",
    "loginName": "sample string 4",
    "email": "sample string 5",
    "password": "sample string 6",
    "uniqueString": "sample string 7",
    "role": 8,
    "dateCreated": "2025-12-06T03:34:22.7867249+00:00",
    "isDeleted": true,
    "phone": "sample string 9",
    "isActive": true,
    "description": "sample string 10",
    "website": "sample string 11",
    "contactPerson": "sample string 12",
    "photo": "sample string 13",
    "title": "sample string 14",
    "language": "sample string 15",
    "direction": "sample string 16",
    "oneSignalId": "sample string 17",
    "companyNumber": "sample string 18",
    "firstDayOfWeek": 64,
    "cookingTime": 1,
    "vendorId": 1,
    "address": {
      "id": 1,
      "name": "sample string 2",
      "userId": 3,
      "fullAddress": "sample string 4",
      "created": "2025-12-06T03:34:22.7867249+00:00",
      "isActive": true,
      "city": "sample string 5",
      "street": "sample string 6",
      "phoneNumber": "sample string 7",
      "countryId": 1,
      "areaId": 1,
      "number": "sample string 8",
      "isPrimary": true,
      "notificationEmail": "sample string 9"
    },
    "userCompanyId": 1,
    "isHeadCourier": true,
    "isReceivePushNotification": true,
    "deviceId": "sample string 19",
    "sendToHeadCourier": true,
    "vatPercent": 1.0,
    "currencySymbol": "sample string 20"
  },
  "courierId": 1,
  "latitude": 2.1,
  "longitude": 3.1,
  "date": "2025-12-06T03:34:22.7867249+00:00"
}

application/xml, text/xml

Sample:
<CourierLocationViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Clickoapp2.Domain.Models">
  <Courier>
    <Address>
      <AreaId>1</AreaId>
      <City>sample string 5</City>
      <CountryId>1</CountryId>
      <Created>2025-12-06T03:34:22.7867249+00:00</Created>
      <FullAddress>sample string 4</FullAddress>
      <Id>1</Id>
      <IsActive>true</IsActive>
      <IsPrimary>true</IsPrimary>
      <Name>sample string 2</Name>
      <NotificationEmail>sample string 9</NotificationEmail>
      <Number>sample string 8</Number>
      <PhoneNumber>sample string 7</PhoneNumber>
      <Street>sample string 6</Street>
      <UserId>3</UserId>
    </Address>
    <CompanyNumber>sample string 18</CompanyNumber>
    <ContactPerson>sample string 12</ContactPerson>
    <CookingTime>1</CookingTime>
    <CurrencySymbol>sample string 20</CurrencySymbol>
    <DateCreated>2025-12-06T03:34:22.7867249+00:00</DateCreated>
    <Description>sample string 10</Description>
    <DeviceId>sample string 19</DeviceId>
    <Direction>sample string 16</Direction>
    <Email>sample string 5</Email>
    <FirstDayOfWeek>64</FirstDayOfWeek>
    <FirstName>sample string 1</FirstName>
    <FullName>sample string 3</FullName>
    <Id>1</Id>
    <IsActive>true</IsActive>
    <IsDeleted>true</IsDeleted>
    <IsHeadCourier>true</IsHeadCourier>
    <IsReceivePushNotification>true</IsReceivePushNotification>
    <Language>sample string 15</Language>
    <LastName>sample string 2</LastName>
    <LoginName>sample string 4</LoginName>
    <OneSignalId>sample string 17</OneSignalId>
    <Password>sample string 6</Password>
    <Phone>sample string 9</Phone>
    <Photo>sample string 13</Photo>
    <Role>8</Role>
    <SendToHeadCourier>true</SendToHeadCourier>
    <Title>sample string 14</Title>
    <UniqueString>sample string 7</UniqueString>
    <UserCompanyId>1</UserCompanyId>
    <VatPercent>1</VatPercent>
    <VendorId>1</VendorId>
    <Website>sample string 11</Website>
  </Courier>
  <CourierId>1</CourierId>
  <Date>2025-12-06T03:34:22.7867249+00:00</Date>
  <Latitude>2.1</Latitude>
  <Longitude>3.1</Longitude>
</CourierLocationViewModel>