GET api/v0/Route/GetUserRoute

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

Name	Type	Additional information
RouteStatus	RoutesStatus	None.
RouteId	string	None.
VehicleId	integer	None.
RouteDate	date	None.
Status	integer	None.
isClosed	boolean	None.
AssignationStatus	RouteAssignationStatus	None.
AssignedDate	date	None.
InProgressDate	date	None.
ValidationDate	date	None.
ConsolidationDate	date	None.
AlertLevel	integer	None.
Deliveries	Collection of DeliveryNoteContract	None.
DriverId	integer	None.

Response Formats

application/json, text/json

Sample:

{
  "RouteStatus": 0,
  "RouteId": "sample string 1",
  "VehicleId": 1,
  "RouteDate": "2026-09-22T08:22:48.1147906+00:00",
  "Status": 1,
  "isClosed": true,
  "AssignationStatus": 0,
  "AssignedDate": "2026-09-22T08:22:48.1147906+00:00",
  "InProgressDate": "2026-09-22T08:22:48.1147906+00:00",
  "ValidationDate": "2026-09-22T08:22:48.1147906+00:00",
  "ConsolidationDate": "2026-09-22T08:22:48.1147906+00:00",
  "AlertLevel": 3,
  "Deliveries": [
    {
      "DeliveryNoteId": "sample string 1",
      "FarmId": 2,
      "OrderId": "sample string 3",
      "RouteId": "sample string 4",
      "IsClosed": true,
      "DeliveryNoteDate": "2026-09-22T08:22:48.1147906+00:00",
      "AlertLevel": 7,
      "DeliveriesDetails": [
        {
          "AlertDescription": 0,
          "DeliveryNoteId": "sample string 1",
          "DeliveryNoteDetailId": "sample string 2",
          "articleCode": "sample string 3",
          "articleDescription": "sample string 4",
          "AmountKgs": 1.0,
          "StoragePointNotes": "sample string 5",
          "VehicleNotes": "sample string 6",
          "StoragePointId": 7,
          "AlertLevel": 8
        },
        {
          "AlertDescription": 0,
          "DeliveryNoteId": "sample string 1",
          "DeliveryNoteDetailId": "sample string 2",
          "articleCode": "sample string 3",
          "articleDescription": "sample string 4",
          "AmountKgs": 1.0,
          "StoragePointNotes": "sample string 5",
          "VehicleNotes": "sample string 6",
          "StoragePointId": 7,
          "AlertLevel": 8
        }
      ]
    },
    {
      "DeliveryNoteId": "sample string 1",
      "FarmId": 2,
      "OrderId": "sample string 3",
      "RouteId": "sample string 4",
      "IsClosed": true,
      "DeliveryNoteDate": "2026-09-22T08:22:48.1147906+00:00",
      "AlertLevel": 7,
      "DeliveriesDetails": [
        {
          "AlertDescription": 0,
          "DeliveryNoteId": "sample string 1",
          "DeliveryNoteDetailId": "sample string 2",
          "articleCode": "sample string 3",
          "articleDescription": "sample string 4",
          "AmountKgs": 1.0,
          "StoragePointNotes": "sample string 5",
          "VehicleNotes": "sample string 6",
          "StoragePointId": 7,
          "AlertLevel": 8
        },
        {
          "AlertDescription": 0,
          "DeliveryNoteId": "sample string 1",
          "DeliveryNoteDetailId": "sample string 2",
          "articleCode": "sample string 3",
          "articleDescription": "sample string 4",
          "AmountKgs": 1.0,
          "StoragePointNotes": "sample string 5",
          "VehicleNotes": "sample string 6",
          "StoragePointId": 7,
          "AlertLevel": 8
        }
      ]
    }
  ],
  "DriverId": 1
}

application/xml, text/xml

Sample:

<myRouteContract xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.agrifoodatsolutions.com/FDService/v0/contracts/2017/01">
  <AlertLevel>3</AlertLevel>
  <AssignationStatus>Valid</AssignationStatus>
  <AssignedDate>2026-09-22T08:22:48.1147906+00:00</AssignedDate>
  <ConsolidationDate>2026-09-22T08:22:48.1147906+00:00</ConsolidationDate>
  <Deliveries>
    <DeliveryNoteContract>
      <AlertLevel>7</AlertLevel>
      <DeliveriesDetails>
        <DeliveryNoteDetailContract>
          <AlertDescription>Unknown</AlertDescription>
          <AlertLevel>8</AlertLevel>
          <AmountKgs>1</AmountKgs>
          <DeliveryNoteDetailId>sample string 2</DeliveryNoteDetailId>
          <DeliveryNoteId>sample string 1</DeliveryNoteId>
          <StoragePointId>7</StoragePointId>
          <StoragePointNotes>sample string 5</StoragePointNotes>
          <VehicleNotes>sample string 6</VehicleNotes>
          <articleCode>sample string 3</articleCode>
          <articleDescription>sample string 4</articleDescription>
        </DeliveryNoteDetailContract>
        <DeliveryNoteDetailContract>
          <AlertDescription>Unknown</AlertDescription>
          <AlertLevel>8</AlertLevel>
          <AmountKgs>1</AmountKgs>
          <DeliveryNoteDetailId>sample string 2</DeliveryNoteDetailId>
          <DeliveryNoteId>sample string 1</DeliveryNoteId>
          <StoragePointId>7</StoragePointId>
          <StoragePointNotes>sample string 5</StoragePointNotes>
          <VehicleNotes>sample string 6</VehicleNotes>
          <articleCode>sample string 3</articleCode>
          <articleDescription>sample string 4</articleDescription>
        </DeliveryNoteDetailContract>
      </DeliveriesDetails>
      <DeliveryNoteDate>2026-09-22T08:22:48.1147906+00:00</DeliveryNoteDate>
      <DeliveryNoteId>sample string 1</DeliveryNoteId>
      <FarmId>2</FarmId>
      <IsClosed>true</IsClosed>
      <OrderId>sample string 3</OrderId>
      <RouteId>sample string 4</RouteId>
    </DeliveryNoteContract>
    <DeliveryNoteContract>
      <AlertLevel>7</AlertLevel>
      <DeliveriesDetails>
        <DeliveryNoteDetailContract>
          <AlertDescription>Unknown</AlertDescription>
          <AlertLevel>8</AlertLevel>
          <AmountKgs>1</AmountKgs>
          <DeliveryNoteDetailId>sample string 2</DeliveryNoteDetailId>
          <DeliveryNoteId>sample string 1</DeliveryNoteId>
          <StoragePointId>7</StoragePointId>
          <StoragePointNotes>sample string 5</StoragePointNotes>
          <VehicleNotes>sample string 6</VehicleNotes>
          <articleCode>sample string 3</articleCode>
          <articleDescription>sample string 4</articleDescription>
        </DeliveryNoteDetailContract>
        <DeliveryNoteDetailContract>
          <AlertDescription>Unknown</AlertDescription>
          <AlertLevel>8</AlertLevel>
          <AmountKgs>1</AmountKgs>
          <DeliveryNoteDetailId>sample string 2</DeliveryNoteDetailId>
          <DeliveryNoteId>sample string 1</DeliveryNoteId>
          <StoragePointId>7</StoragePointId>
          <StoragePointNotes>sample string 5</StoragePointNotes>
          <VehicleNotes>sample string 6</VehicleNotes>
          <articleCode>sample string 3</articleCode>
          <articleDescription>sample string 4</articleDescription>
        </DeliveryNoteDetailContract>
      </DeliveriesDetails>
      <DeliveryNoteDate>2026-09-22T08:22:48.1147906+00:00</DeliveryNoteDate>
      <DeliveryNoteId>sample string 1</DeliveryNoteId>
      <FarmId>2</FarmId>
      <IsClosed>true</IsClosed>
      <OrderId>sample string 3</OrderId>
      <RouteId>sample string 4</RouteId>
    </DeliveryNoteContract>
  </Deliveries>
  <DriverId>1</DriverId>
  <InProgressDate>2026-09-22T08:22:48.1147906+00:00</InProgressDate>
  <RouteDate>2026-09-22T08:22:48.1147906+00:00</RouteDate>
  <RouteId>sample string 1</RouteId>
  <RouteStatus>Initial</RouteStatus>
  <Status>1</Status>
  <ValidationDate>2026-09-22T08:22:48.1147906+00:00</ValidationDate>
  <VehicleId>1</VehicleId>
  <isClosed>true</isClosed>
</myRouteContract>