POST api/v1/shuttle/run/update

Request Information

URI Parameters

None.

Body Parameters

ShuttleRun
NameDescriptionTypeAdditional information
shuttle_id

integer

None.

shuttle_no

string

None.

asset_id

globally unique identifier

None.

customer_id

globally unique identifier

None.

plan_id

globally unique identifier

None.

order_no

string

None.

status

string

None.

driver_id

string

None.

billto_id

string

None.

billto_name

string

None.

billto_address1

string

None.

billto_address2

string

None.

billto_city

string

None.

billto_state

string

None.

billto_zip

string

None.

billto_country

string

None.

pickup_id

string

None.

pickup_name

string

None.

pickup_address1

string

None.

pickup_address2

string

None.

pickup_city

string

None.

pickup_state

string

None.

pickup_zip

string

None.

pickup_country

string

None.

pickup_lat

decimal number

None.

pickup_lng

decimal number

None.

actual_pickup_lat

decimal number

None.

actual_pickup_lng

decimal number

None.

pickup_instructions

string

None.

delivery_id

string

None.

delivery_name

string

None.

delivery_address1

string

None.

delivery_address2

string

None.

delivery_city

string

None.

delivery_state

string

None.

delivery_zip

string

None.

delivery_country

string

None.

delivery_lat

decimal number

None.

delivery_lng

decimal number

None.

actual_delivery_lat

decimal number

None.

actual_delivery_lng

decimal number

None.

delivery_instructions

string

None.

pickup_date

date

None.

create_date

date

None.

delivery_date

date

None.

driver_assign_date

date

None.

account_id

integer

None.

reftype1

string

None.

ref1

string

None.

reftype2

string

None.

ref2

string

None.

reftype3

string

None.

ref3

string

None.

reftype4

string

None.

ref4

string

None.

qty

integer

None.

cancel_date

date

None.

scheduled_pickup_date

date

None.

total_miles

integer

None.

total_pay

decimal number

None.

pay_item_code

string

None.

make

string

None.

model

string

None.

commodity_code

string

None.

commodity_description

string

None.

year

integer

None.

proof_count

integer

None.

creator_id

globally unique identifier

None.

shuttle_fees

decimal number

None.

charges

Collection of ShuttleCharge

None.

Request Formats

application/json, text/json

Sample:
{
  "shuttle_id": 1,
  "shuttle_no": "sample string 2",
  "asset_id": "557afbdb-0924-4e0f-ba1f-7edbfda4909d",
  "customer_id": "1678c27f-3ef8-4243-aad5-91c1a9247dc1",
  "plan_id": "e5aad4b3-a97e-4163-b452-43b6d3b7bace",
  "order_no": "sample string 6",
  "status": "sample string 7",
  "driver_id": "sample string 8",
  "billto_id": "sample string 9",
  "billto_name": "sample string 10",
  "billto_address1": "sample string 11",
  "billto_address2": "sample string 12",
  "billto_city": "sample string 13",
  "billto_state": "sample string 14",
  "billto_zip": "sample string 15",
  "billto_country": "sample string 16",
  "pickup_id": "sample string 17",
  "pickup_name": "sample string 18",
  "pickup_address1": "sample string 19",
  "pickup_address2": "sample string 20",
  "pickup_city": "sample string 21",
  "pickup_state": "sample string 22",
  "pickup_zip": "sample string 23",
  "pickup_country": "sample string 24",
  "pickup_lat": 25.1,
  "pickup_lng": 26.1,
  "actual_pickup_lat": 27.1,
  "actual_pickup_lng": 28.1,
  "pickup_instructions": "sample string 29",
  "delivery_id": "sample string 30",
  "delivery_name": "sample string 31",
  "delivery_address1": "sample string 32",
  "delivery_address2": "sample string 33",
  "delivery_city": "sample string 34",
  "delivery_state": "sample string 35",
  "delivery_zip": "sample string 36",
  "delivery_country": "sample string 37",
  "delivery_lat": 38.1,
  "delivery_lng": 39.1,
  "actual_delivery_lat": 40.1,
  "actual_delivery_lng": 41.1,
  "delivery_instructions": "sample string 42",
  "pickup_date": "2025-12-21T05:01:43.2875318+00:00",
  "create_date": "2025-12-21T05:01:43.2875318+00:00",
  "delivery_date": "2025-12-21T05:01:43.2875318+00:00",
  "driver_assign_date": "2025-12-21T05:01:43.2875318+00:00",
  "account_id": 47,
  "reftype1": "sample string 48",
  "ref1": "sample string 49",
  "reftype2": "sample string 50",
  "ref2": "sample string 51",
  "reftype3": "sample string 52",
  "ref3": "sample string 53",
  "reftype4": "sample string 54",
  "ref4": "sample string 55",
  "qty": 56,
  "cancel_date": "2025-12-21T05:01:43.2875318+00:00",
  "scheduled_pickup_date": "2025-12-21T05:01:43.2875318+00:00",
  "total_miles": 59,
  "total_pay": 60.0,
  "pay_item_code": "sample string 61",
  "make": "sample string 62",
  "model": "sample string 63",
  "commodity_code": "sample string 64",
  "commodity_description": "sample string 65",
  "year": 66,
  "proof_count": 67,
  "creator_id": "ad6655c5-fe25-404a-808f-cac72e499cf8",
  "shuttle_fees": 69.0,
  "charges": [
    {
      "charge_id": "0be3cf5c-6035-4699-9fb9-2f2f57f1ab18",
      "shuttle_id": 2,
      "plan_id": "75a73b13-313c-4026-a785-ac9892978ef9",
      "charge_type_code": "sample string 4",
      "name": "sample string 5",
      "description": "sample string 6",
      "qty": 7.0,
      "rate": 8.0,
      "actual_rate": 9.0,
      "line_total": 10.0,
      "unit_count": 11,
      "prorated": true,
      "creator_id": "a25ec2b2-d982-4bcd-98a0-f905518a0aef",
      "days": 14,
      "frequency": "sample string 15",
      "create_date": "2025-12-21T05:01:43.2875318+00:00"
    },
    {
      "charge_id": "0be3cf5c-6035-4699-9fb9-2f2f57f1ab18",
      "shuttle_id": 2,
      "plan_id": "75a73b13-313c-4026-a785-ac9892978ef9",
      "charge_type_code": "sample string 4",
      "name": "sample string 5",
      "description": "sample string 6",
      "qty": 7.0,
      "rate": 8.0,
      "actual_rate": 9.0,
      "line_total": 10.0,
      "unit_count": 11,
      "prorated": true,
      "creator_id": "a25ec2b2-d982-4bcd-98a0-f905518a0aef",
      "days": 14,
      "frequency": "sample string 15",
      "create_date": "2025-12-21T05:01:43.2875318+00:00"
    }
  ]
}

application/xml, text/xml

Sample:
<ShuttleRun xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Cogent.BL.Models">
  <account_id>47</account_id>
  <actual_delivery_lat>40.1</actual_delivery_lat>
  <actual_delivery_lng>41.1</actual_delivery_lng>
  <actual_pickup_lat>27.1</actual_pickup_lat>
  <actual_pickup_lng>28.1</actual_pickup_lng>
  <asset_id>557afbdb-0924-4e0f-ba1f-7edbfda4909d</asset_id>
  <billto_address1>sample string 11</billto_address1>
  <billto_address2>sample string 12</billto_address2>
  <billto_city>sample string 13</billto_city>
  <billto_country>sample string 16</billto_country>
  <billto_id>sample string 9</billto_id>
  <billto_name>sample string 10</billto_name>
  <billto_state>sample string 14</billto_state>
  <billto_zip>sample string 15</billto_zip>
  <cancel_date xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:DateTime>2025-12-21T05:01:43.2875318Z</d2p1:DateTime>
    <d2p1:OffsetMinutes>0</d2p1:OffsetMinutes>
  </cancel_date>
  <charges>
    <ShuttleCharge>
      <actual_rate>9</actual_rate>
      <charge_id>0be3cf5c-6035-4699-9fb9-2f2f57f1ab18</charge_id>
      <charge_type_code>sample string 4</charge_type_code>
      <create_date xmlns:d4p1="http://schemas.datacontract.org/2004/07/System">
        <d4p1:DateTime>2025-12-21T05:01:43.2875318Z</d4p1:DateTime>
        <d4p1:OffsetMinutes>0</d4p1:OffsetMinutes>
      </create_date>
      <creator_id>a25ec2b2-d982-4bcd-98a0-f905518a0aef</creator_id>
      <days>14</days>
      <description>sample string 6</description>
      <frequency>sample string 15</frequency>
      <line_total>10</line_total>
      <name>sample string 5</name>
      <plan_id>75a73b13-313c-4026-a785-ac9892978ef9</plan_id>
      <prorated>true</prorated>
      <qty>7</qty>
      <rate>8</rate>
      <shuttle_id>2</shuttle_id>
      <unit_count>11</unit_count>
    </ShuttleCharge>
    <ShuttleCharge>
      <actual_rate>9</actual_rate>
      <charge_id>0be3cf5c-6035-4699-9fb9-2f2f57f1ab18</charge_id>
      <charge_type_code>sample string 4</charge_type_code>
      <create_date xmlns:d4p1="http://schemas.datacontract.org/2004/07/System">
        <d4p1:DateTime>2025-12-21T05:01:43.2875318Z</d4p1:DateTime>
        <d4p1:OffsetMinutes>0</d4p1:OffsetMinutes>
      </create_date>
      <creator_id>a25ec2b2-d982-4bcd-98a0-f905518a0aef</creator_id>
      <days>14</days>
      <description>sample string 6</description>
      <frequency>sample string 15</frequency>
      <line_total>10</line_total>
      <name>sample string 5</name>
      <plan_id>75a73b13-313c-4026-a785-ac9892978ef9</plan_id>
      <prorated>true</prorated>
      <qty>7</qty>
      <rate>8</rate>
      <shuttle_id>2</shuttle_id>
      <unit_count>11</unit_count>
    </ShuttleCharge>
  </charges>
  <commodity_code>sample string 64</commodity_code>
  <commodity_description>sample string 65</commodity_description>
  <create_date xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:DateTime>2025-12-21T05:01:43.2875318Z</d2p1:DateTime>
    <d2p1:OffsetMinutes>0</d2p1:OffsetMinutes>
  </create_date>
  <creator_id>ad6655c5-fe25-404a-808f-cac72e499cf8</creator_id>
  <customer_id>1678c27f-3ef8-4243-aad5-91c1a9247dc1</customer_id>
  <delivery_address1>sample string 32</delivery_address1>
  <delivery_address2>sample string 33</delivery_address2>
  <delivery_city>sample string 34</delivery_city>
  <delivery_country>sample string 37</delivery_country>
  <delivery_date xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:DateTime>2025-12-21T05:01:43.2875318Z</d2p1:DateTime>
    <d2p1:OffsetMinutes>0</d2p1:OffsetMinutes>
  </delivery_date>
  <delivery_id>sample string 30</delivery_id>
  <delivery_instructions>sample string 42</delivery_instructions>
  <delivery_lat>38.1</delivery_lat>
  <delivery_lng>39.1</delivery_lng>
  <delivery_name>sample string 31</delivery_name>
  <delivery_state>sample string 35</delivery_state>
  <delivery_zip>sample string 36</delivery_zip>
  <driver_assign_date xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:DateTime>2025-12-21T05:01:43.2875318Z</d2p1:DateTime>
    <d2p1:OffsetMinutes>0</d2p1:OffsetMinutes>
  </driver_assign_date>
  <driver_id>sample string 8</driver_id>
  <make>sample string 62</make>
  <model>sample string 63</model>
  <order_no>sample string 6</order_no>
  <pay_item_code>sample string 61</pay_item_code>
  <pickup_address1>sample string 19</pickup_address1>
  <pickup_address2>sample string 20</pickup_address2>
  <pickup_city>sample string 21</pickup_city>
  <pickup_country>sample string 24</pickup_country>
  <pickup_date xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:DateTime>2025-12-21T05:01:43.2875318Z</d2p1:DateTime>
    <d2p1:OffsetMinutes>0</d2p1:OffsetMinutes>
  </pickup_date>
  <pickup_id>sample string 17</pickup_id>
  <pickup_instructions>sample string 29</pickup_instructions>
  <pickup_lat>25.1</pickup_lat>
  <pickup_lng>26.1</pickup_lng>
  <pickup_name>sample string 18</pickup_name>
  <pickup_state>sample string 22</pickup_state>
  <pickup_zip>sample string 23</pickup_zip>
  <plan_id>e5aad4b3-a97e-4163-b452-43b6d3b7bace</plan_id>
  <proof_count>67</proof_count>
  <qty>56</qty>
  <ref1>sample string 49</ref1>
  <ref2>sample string 51</ref2>
  <ref3>sample string 53</ref3>
  <ref4>sample string 55</ref4>
  <reftype1>sample string 48</reftype1>
  <reftype2>sample string 50</reftype2>
  <reftype3>sample string 52</reftype3>
  <reftype4>sample string 54</reftype4>
  <scheduled_pickup_date xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:DateTime>2025-12-21T05:01:43.2875318Z</d2p1:DateTime>
    <d2p1:OffsetMinutes>0</d2p1:OffsetMinutes>
  </scheduled_pickup_date>
  <shuttle_fees>69</shuttle_fees>
  <shuttle_id>1</shuttle_id>
  <shuttle_no>sample string 2</shuttle_no>
  <status>sample string 7</status>
  <total_miles>59</total_miles>
  <total_pay>60</total_pay>
  <year>66</year>
</ShuttleRun>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'ShuttleRun'.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.