POST breeze/RouteApi/SendOrder

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

RouteItem
NameDescriptionTypeAdditional information
ConsignmentUnits

integer

None.

LegUnits

integer

None.

Address

Address

None.

Id

integer

None.

Order

integer

None.

Duration

integer

None.

Waiting

decimal number

None.

Date

date

None.

Depart

date

None.

Distance

decimal number

None.

IsCollection

boolean

None.

Depot

RouteDepot

None.

DepotId

integer

None.

Route

Route

None.

RouteId

integer

None.

Legs

Collection of Leg

None.

Response Formats

application/json, text/json

Sample:
{
  "ConsignmentUnits": 4,
  "LegUnits": 4,
  "Address": {
    "$type": "EosWeb.Models.Address, EosWeb",
    "Id": 1,
    "Street": "sample string 2",
    "Town": "sample string 3",
    "Postcode": "sample string 4",
    "Country": "sample string 5",
    "Phone": "sample string 6",
    "Email": "sample string 7",
    "Code": "sample string 8",
    "ContactName": "sample string 9",
    "Lookups": [
      {
        "$id": "2",
        "$type": "EosWeb.Models.Lookup, EosWeb",
        "Id": 1,
        "Data": "sample string 2",
        "Type": "ROUNDING"
      },
      {
        "$ref": "2"
      }
    ],
    "StreetFormat": "sample string 2;",
    "FullAddress": "sample string 2\r\nsample string 3\r\nsample string 5\r\nsample string 4",
    "LongAddress": "sample string 2, sample string 3, sample string 5, sample string 4"
  },
  "Id": 1,
  "Order": 2,
  "Duration": 1,
  "Waiting": 1.0,
  "Date": "2017-12-14T20:55:54.644+00:00",
  "Depart": "2017-12-14T20:55:54.644+00:00",
  "Distance": 1.0,
  "IsCollection": true,
  "Depot": {
    "$id": "3",
    "$type": "EosWeb.Models.RouteDepot, EosWeb",
    "Id": 1,
    "Closed": "2017-12-14T20:55:54.644+00:00",
    "Legs": [
      {
        "$id": "4",
        "$type": "EosWeb.Models.Booking.Leg, EosWeb",
        "Id": 1,
        "From": "2017-12-14T20:55:54.644+00:00",
        "To": "2017-12-14T20:55:54.644+00:00",
        "Reference": "sample string 2",
        "DateType": "On",
        "LegUnits": [
          {
            "$id": "5",
            "$type": "EosWeb.Models.LegUnit, EosWeb",
            "Id": 1,
            "Created": "2017-12-14T20:55:54.644+00:00",
            "ConsignmentUnit": {
              "$id": "6",
              "$type": "EosWeb.Models.ConsignmentUnit, EosWeb",
              "Id": 1,
              "Cube": 2.0,
              "Weight": 3.0,
              "UnitType": {
                "$id": "7",
                "$type": "EosWeb.Models.UnitType, EosWeb",
                "Id": 1,
                "Order": 2,
                "Name": "sample string 3",
                "ImportValue": "sample string 4",
                "Cube": 5.0,
                "Weight": 6.0
              },
              "ExternalBarcode": "sample string 4",
              "Order": {
                "$id": "8",
                "$type": "EosWeb.Models.Booking.Order, EosWeb",
                "Id": 1,
                "Created": "2017-12-14T20:55:54.644+00:00",
                "OrderNumber": "sample string 2",
                "OrderType": "Collection",
                "CompanyOrders": [
                  {
                    "$id": "9",
                    "$type": "EosWeb.Models.Companies.CompanyOrder, EosWeb",
                    "Id": 1,
                    "Created": "2017-12-14T20:55:54.644+00:00",
                    "Service": {
                      "$id": "10",
                      "$type": "EosWeb.Models.ServiceType, EosWeb",
                      "Id": 1,
                      "Name": "sample string 2",
                      "ImportValue": "sample string 3",
                      "Start": "2017-12-14T20:55:54.644+00:00",
                      "End": "2017-12-14T20:55:54.644+00:00",
                      "ChargeBy": "None",
                      "Cost": 4.0
                    },
                    "ServiceId": 1,
                    "Costs": [
                      {
                        "$id": "11",
                        "$type": "EosWeb.Models.Companies.Cost, EosWeb",
                        "Id": 1,
                        "UnitCost": 2.0,
                        "Units": 3.0,
                        "Description": "sample string 4",
                        "CostType": "None"
                      },
                      {
                        "$ref": "11"
                      }
                    ],
                    "Order": {
                      "$ref": "8"
                    },
                    "OrderId": 2,
                    "Company": {
                      "$id": "12",
                      "$type": "EosWeb.Models.Companies.Company, EosWeb",
                      "Id": 1,
                      "CompanyName": "sample string 2",
                      "Address": {
                        "$type": "EosWeb.Models.Address, EosWeb",
                        "Id": 1,
                        "Street": "sample string 2",
                        "Town": "sample string 3",
                        "Postcode": "sample string 4",
                        "Country": "sample string 5",
                        "Phone": "sample string 6",
                        "Email": "sample string 7",
                        "Code": "sample string 8",
                        "ContactName": "sample string 9",
                        "Lookups": [
                          {
                            "$ref": "2"
                          },
                          {
                            "$ref": "2"
                          }
                        ],
                        "StreetFormat": "sample string 2;",
                        "FullAddress": "sample string 2\r\nsample string 3\r\nsample string 5\r\nsample string 4",
                        "LongAddress": "sample string 2, sample string 3, sample string 5, sample string 4"
                      },
                      "AddressId": 3,
                      "Logo": {
                        "$type": "System.Byte[], mscorlib",
                        "$value": "QEA="
                      },
                      "CompanyTypes": "Consigner",
                      "LinkedCompanys": [
                        {
                          "$id": "13",
                          "$type": "EosWeb.Models.LinkedCompany, EosWeb",
                          "Id": 1,
                          "CompanyRef": "sample string 2",
                          "Link": {
                            "$ref": "12"
                          },
                          "LinkId": 1,
                          "Company": {
                            "$ref": "12"
                          },
                          "CompanyId": 3,
                          "Services": [
                            {
                              "$ref": "10"
                            },
                            {
                              "$ref": "10"
                            }
                          ],
                          "CompanyMemberType": "Consigner"
                        },
                        {
                          "$ref": "13"
                        }
                      ],
                      "UnitTypes": [
                        {
                          "$ref": "7"
                        },
                        {
                          "$ref": "7"
                        }
                      ],
                      "ServiceTypes": [
                        {
                          "$ref": "10"
                        },
                        {
                          "$ref": "10"
                        }
                      ],
                      "Users": [
                        {
                          "$id": "14",
                          "$type": "EosWeb.Models.ApplicationUser, EosWeb",
                          "Imports": [
                            {
                              "$id": "15",
                              "$type": "EosWeb.Models.Import, EosWeb",
                              "Id": 1,
                              "ImportType": "Order",
                              "Columns": [
                                {
                                  "$id": "16",
                                  "$type": "EosWeb.Models.ImportColumn, EosWeb",
                                  "Id": 1,
                                  "ColumnOrder": 2,
                                  "ColumnProperty": "sample string 3"
                                },
                                {
                                  "$ref": "16"
                                }
                              ]
                            },
                            {
                              "$ref": "15"
                            }
                          ],
                          "Company": {
                            "$ref": "12"
                          },
                          "CompanyId": 1,
                          "Address": {
                            "$type": "EosWeb.Models.Address, EosWeb",
                            "Id": 1,
                            "Street": "sample string 2",
                            "Town": "sample string 3",
                            "Postcode": "sample string 4",
                            "Country": "sample string 5",
                            "Phone": "sample string 6",
                            "Email": "sample string 7",
                            "Code": "sample string 8",
                            "ContactName": "sample string 9",
                            "Lookups": [
                              {
                                "$ref": "2"
                              },
                              {
                                "$ref": "2"
                              }
                            ],
                            "StreetFormat": "sample string 2;",
                            "FullAddress": "sample string 2\r\nsample string 3\r\nsample string 5\r\nsample string 4",
                            "LongAddress": "sample string 2, sample string 3, sample string 5, sample string 4"
                          },
                          "AddressId": 1,
                          "Email": "sample string 2",
                          "EmailConfirmed": true,
                          "PasswordHash": "sample string 4",
                          "SecurityStamp": "sample string 5",
                          "PhoneNumber": "sample string 6",
                          "PhoneNumberConfirmed": true,
                          "TwoFactorEnabled": true,
                          "LockoutEndDateUtc": "2017-12-14T20:55:54.644+00:00",
                          "LockoutEnabled": true,
                          "AccessFailedCount": 10,
                          "Roles": [],
                          "Claims": [],
                          "Logins": [],
                          "Id": "sample string 11",
                          "UserName": "sample string 12"
                        },
                        {
                          "$ref": "14"
                        }
                      ],
                      "Depots": [
                        {
                          "$id": "17",
                          "$type": "EosWeb.Models.Depot, EosWeb",
                          "Id": 1,
                          "Name": "sample string 2",
                          "Address": {
                            "$type": "EosWeb.Models.Address, EosWeb",
                            "Id": 1,
                            "Street": "sample string 2",
                            "Town": "sample string 3",
                            "Postcode": "sample string 4",
                            "Country": "sample string 5",
                            "Phone": "sample string 6",
                            "Email": "sample string 7",
                            "Code": "sample string 8",
                            "ContactName": "sample string 9",
                            "Lookups": [
                              {
                                "$ref": "2"
                              },
                              {
                                "$ref": "2"
                              }
                            ],
                            "StreetFormat": "sample string 2;",
                            "FullAddress": "sample string 2\r\nsample string 3\r\nsample string 5\r\nsample string 4",
                            "LongAddress": "sample string 2, sample string 3, sample string 5, sample string 4"
                          },
                          "AddressId": 3,
                          "Company": {
                            "$ref": "12"
                          },
                          "CompanyId": 1,
                          "Locations": [
                            {
                              "$id": "18",
                              "$type": "EosWeb.Models.DepotLocation, EosWeb",
                              "Id": 1,
                              "Name": "sample string 2",
                              "Barcode": "sample string 3",
                              "Master": 4,
                              "Counts": [
                                {
                                  "$id": "19",
                                  "$type": "EosWeb.Models.LocationCount, EosWeb",
                                  "Id": 1,
                                  "Location": {
                                    "$ref": "18"
                                  },
                                  "Date": "2017-12-14T20:55:54.644+00:00",
                                  "Products": [
                                    {
                                      "$id": "20",
                                      "$type": "EosWeb.Models.ProductLocationCount, EosWeb",
                                      "Id": 1,
                                      "Product": {
                                        "$id": "21",
                                        "$type": "EosWeb.Models.Product, EosWeb",
                                        "Id": 1,
                                        "Name": "sample string 2",
                                        "Code": "sample string 3",
                                        "ABC": "sample string 4",
                                        "Description": "sample string 5",
                                        "Height": 6.0,
                                        "Length": 7.0,
                                        "Width": 8.0,
                                        "Weight": 9.0,
                                        "Cube": 10.0,
                                        "StockCount": 11.0,
                                        "Cycle": 12,
                                        "Unit": {
                                          "$ref": "7"
                                        },
                                        "Deliveries": [
                                          {
                                            "$id": "22",
                                            "$type": "EosWeb.Models.ProductDelivery, EosWeb",
                                            "Id": 1,
                                            "Product": {
                                              "$ref": "21"
                                            },
                                            "Booking": {
                                              "$ref": "8"
                                            },
                                            "Stock": {
                                              "$ref": "5"
                                            },
                                            "Error": {
                                              "$id": "23",
                                              "$type": "EosWeb.Models.LegStockError, EosWeb",
                                              "Id": 1,
                                              "Message": "sample string 2",
                                              "Code": "sample string 3"
                                            },
                                            "Locations": [
                                              {
                                                "$id": "24",
                                                "$type": "EosWeb.Models.ProductDeliveryLocation, EosWeb",
                                                "Id": 1,
                                                "Location": {
                                                  "$ref": "18"
                                                },
                                                "Product": {
                                                  "$ref": "21"
                                                },
                                                "ProductDelivery": {
                                                  "$ref": "22"
                                                },
                                                "ScannedBy": {
                                                  "$ref": "14"
                                                },
                                                "Date": "2017-12-14T20:55:54.644+00:00",
                                                "Count": 3,
                                                "Error": {
                                                  "$ref": "23"
                                                }
                                              },
                                              {
                                                "$ref": "24"
                                              }
                                            ],
                                            "Count": 2
                                          },
                                          {
                                            "$ref": "22"
                                          }
                                        ],
                                        "Counts": [
                                          {
                                            "$ref": "19"
                                          },
                                          {
                                            "$ref": "19"
                                          }
                                        ]
                                      },
                                      "Location": {
                                        "$ref": "18"
                                      },
                                      "Errors": [
                                        {
                                          "$id": "25",
                                          "$type": "EosWeb.Models.ProductLocationCountError, EosWeb",
                                          "Id": 1,
                                          "Products": 2,
                                          "Error": {
                                            "$ref": "23"
                                          }
                                        },
                                        {
                                          "$ref": "25"
                                        }
                                      ],
                                      "ScannedBy": {
                                        "$ref": "14"
                                      },
                                      "Date": "2017-12-14T20:55:54.644+00:00",
                                      "Counted": 2,
                                      "Expected": 3
                                    },
                                    {
                                      "$ref": "20"
                                    }
                                  ]
                                },
                                {
                                  "$ref": "19"
                                }
                              ],
                              "Movements": [
                                {
                                  "$ref": "24"
                                },
                                {
                                  "$ref": "24"
                                }
                              ],
                              "Depot": {
                                "$ref": "17"
                              },
                              "DepotId": 5
                            },
                            {
                              "$ref": "18"
                            }
                          ]
                        },
                        {
                          "$ref": "17"
                        }
                      ],
                      "TomTomQueueResults": [
                        {
                          "$id": "26",
                          "$type": "EosWeb.Models.TomTomQueueResult, EosWeb",
                          "Id": 1,
                          "CompanyId": 2,
                          "Company": {
                            "$ref": "12"
                          },
                          "distance": 1,
                          "driverNo": "sample string 3",
                          "eta": "2017-12-14T20:55:54.644+00:00",
                          "msgTime": "2017-12-14T20:55:54.644+00:00",
                          "msgText": "sample string 4",
                          "msgType": 5,
                          "objectNo": "sample string 6",
                          "orderAddrNo": "sample string 7",
                          "orderNo": "sample string 8",
                          "orderState": "sample string 9",
                          "orderType": "sample string 10",
                          "posAddrNo": "sample string 11",
                          "latitude": 1,
                          "longitude": 1,
                          "posCountry": "sample string 12",
                          "posPostcode": "sample string 13",
                          "posTime": "2017-12-14T20:55:54.644+00:00",
                          "posText": "sample string 14",
                          "speed": 15,
                          "status": "sample string 16",
                          "userStatus": "sample string 17",
                          "userText": "sample string 18"
                        },
                        {
                          "$ref": "26"
                        }
                      ],
                      "TomTomStatuses": [
                        {
                          "$id": "27",
                          "$type": "EosWeb.Models.TomTomStatus, EosWeb",
                          "Id": 1,
                          "Text": "sample string 2",
                          "Type": "sample string 3",
                          "Order": 4,
                          "Action": "NotSet"
                        },
                        {
                          "$ref": "27"
                        }
                      ],
                      "Vehicles": [
                        {
                          "$id": "28",
                          "$type": "EosWeb.Models.Vehicle, EosWeb",
                          "Id": 1,
                          "Reg": "sample string 2",
                          "IsTomTom": true
                        },
                        {
                          "$ref": "28"
                        }
                      ],
                      "Feedback": [
                        {
                          "$id": "29",
                          "$type": "EosWeb.Models.Exchange.Feedback, EosWeb",
                          "Id": 1,
                          "Order": {
                            "$ref": "8"
                          },
                          "Comments": "sample string 2",
                          "Ratings": [
                            {
                              "$id": "30",
                              "$type": "EosWeb.Models.Exchange.Rating, EosWeb",
                              "Id": 1,
                              "Criteria": "Payment",
                              "Score": 2
                            },
                            {
                              "$ref": "30"
                            }
                          ]
                        },
                        {
                          "$ref": "29"
                        }
                      ],
                      "LogoBase64": "data:image/png;base64,QEA="
                    },
                    "CompanyId": 3,
                    "Customer": {
                      "$ref": "12"
                    },
                    "CustomerId": 1,
                    "Cost": 12.0
                  },
                  {
                    "$ref": "9"
                  }
                ],
                "ConsignmentUnits": [
                  {
                    "$ref": "6"
                  },
                  {
                    "$ref": "6"
                  }
                ],
                "Manifest": {
                  "$id": "31",
                  "$type": "EosWeb.Models.Booking.Manifest, EosWeb",
                  "Id": 1,
                  "ManifestNumber": "sample string 2",
                  "Created": "2017-12-14T20:55:54.644+00:00",
                  "Bookings": [
                    {
                      "$ref": "8"
                    },
                    {
                      "$ref": "8"
                    }
                  ],
                  "Company": {
                    "$ref": "12"
                  },
                  "CompanyId": 1,
                  "UnitCount": 4,
                  "Count": 2
                },
                "Manifest_Id": 1,
                "CollectionId": 1,
                "Collection": {
                  "$ref": "4"
                },
                "DeliveryId": 1,
                "Delivery": {
                  "$ref": "4"
                },
                "Cube": 4.0,
                "StockWeight": 6.0,
                "StockCount": 2
              },
              "Order_Id": 1,
              "Barcode": "0000000001001"
            },
            "ConsignmentUnit_Id": 1,
            "Scanner": {
              "$ref": "14"
            },
            "Scanner_Id": "sample string 3",
            "Leg": {
              "$ref": "4"
            },
            "Leg_Id": 1
          },
          {
            "$ref": "5"
          }
        ],
        "AddressId": 3,
        "Address": {
          "$type": "EosWeb.Models.Address, EosWeb",
          "Id": 1,
          "Street": "sample string 2",
          "Town": "sample string 3",
          "Postcode": "sample string 4",
          "Country": "sample string 5",
          "Phone": "sample string 6",
          "Email": "sample string 7",
          "Code": "sample string 8",
          "ContactName": "sample string 9",
          "Lookups": [
            {
              "$ref": "2"
            },
            {
              "$ref": "2"
            }
          ],
          "StreetFormat": "sample string 2;",
          "FullAddress": "sample string 2\r\nsample string 3\r\nsample string 5\r\nsample string 4",
          "LongAddress": "sample string 2, sample string 3, sample string 5, sample string 4"
        },
        "POD": {
          "$id": "32",
          "$type": "EosWeb.Models.Routing.POD, EosWeb",
          "Id": 1,
          "Name": "sample string 2",
          "Created": "2017-12-14T20:55:54.644+00:00",
          "Signature": "sample string 4",
          "Leg": {
            "$ref": "4"
          }
        },
        "RouteItem": {
          "$ref": "1"
        },
        "CollectionFor": [
          {
            "$ref": "8"
          },
          {
            "$ref": "8"
          }
        ],
        "DeliveryFor": [
          {
            "$ref": "8"
          },
          {
            "$ref": "8"
          }
        ],
        "LegType": "Collection",
        "ConsignmentUnits": [
          {
            "$ref": "6"
          },
          {
            "$ref": "6"
          }
        ],
        "Order": {
          "$ref": "8"
        },
        "BookedFor": " 14 Dec"
      },
      {
        "$ref": "4"
      }
    ],
    "Type": 2,
    "Depot": {
      "$ref": "17"
    },
    "DepotId": 1,
    "Route": {
      "$id": "33",
      "$type": "EosWeb.Models.Route, EosWeb",
      "LegCount": 2,
      "ConsignmentUnits": 8,
      "LegUnits": 8,
      "Id": 1,
      "RouteNumber": "sample string 2",
      "Date": "2017-12-14T20:55:54.644+00:00",
      "Legs": [
        {
          "$ref": "1"
        },
        {
          "$ref": "1"
        }
      ],
      "Vehicle": {
        "$ref": "28"
      },
      "VehicleId": 1,
      "Driver": {
        "$ref": "14"
      },
      "DriverId": "sample string 3",
      "Company": {
        "$ref": "12"
      },
      "CompanyId": 1,
      "Load": {
        "$ref": "17"
      },
      "LoadId": 1,
      "Unload": {
        "$ref": "17"
      },
      "UnloadId": 1
    },
    "RouteId": 1
  },
  "DepotId": 1,
  "Route": {
    "$ref": "33"
  },
  "RouteId": 1,
  "Legs": [
    {
      "$ref": "4"
    },
    {
      "$ref": "4"
    }
  ]
}