POST ParadeAI

Request Information

URI Parameters

None.

Body Parameters

ParadeAI
NameDescriptionTypeAdditional information
payload

payload

None.

Request Formats

application/json, text/json

Sample:
{
  "payload": {
    "id": 1,
    "created_at": "sample string 2",
    "carrier_metadata": {
      "dot_number": "sample string 1",
      "mc_number": "sample string 2",
      "carrier_name": "sample string 3"
    },
    "capacities": [
      {
        "id": 1,
        "equipment": "sample string 2",
        "equipment_metadata": {
          "trailer_type": {
            "van": true,
            "reefer": true,
            "flatbed": true,
            "dd_deck": true,
            "stepdeck": true,
            "conestoga": true,
            "dump_trailer": true,
            "container": true,
            "tanker": true,
            "po": true,
            "rgn": true
          },
          "extra": {
            "length": 1,
            "hazmat": true,
            "team": true,
            "air_ride": true,
            "tarps": true
          }
        },
        "dot_number": "sample string 3",
        "src_available_date": "sample string 4",
        "src_available_time": "sample string 5",
        "src_city": "sample string 6",
        "src_state": "sample string 7",
        "src_geo_point": {
          "type": "sample string 1",
          "coordinates": [
            "sample string 1",
            "sample string 2"
          ]
        },
        "destinations": [
          {
            "city": "sample string 1",
            "state": "sample string 2",
            "geo_point": {
              "type": "sample string 1",
              "coordinates": [
                "sample string 1",
                "sample string 2"
              ]
            }
          },
          {
            "city": "sample string 1",
            "state": "sample string 2",
            "geo_point": {
              "type": "sample string 1",
              "coordinates": [
                "sample string 1",
                "sample string 2"
              ]
            }
          }
        ]
      },
      {
        "id": 1,
        "equipment": "sample string 2",
        "equipment_metadata": {
          "trailer_type": {
            "van": true,
            "reefer": true,
            "flatbed": true,
            "dd_deck": true,
            "stepdeck": true,
            "conestoga": true,
            "dump_trailer": true,
            "container": true,
            "tanker": true,
            "po": true,
            "rgn": true
          },
          "extra": {
            "length": 1,
            "hazmat": true,
            "team": true,
            "air_ride": true,
            "tarps": true
          }
        },
        "dot_number": "sample string 3",
        "src_available_date": "sample string 4",
        "src_available_time": "sample string 5",
        "src_city": "sample string 6",
        "src_state": "sample string 7",
        "src_geo_point": {
          "type": "sample string 1",
          "coordinates": [
            "sample string 1",
            "sample string 2"
          ]
        },
        "destinations": [
          {
            "city": "sample string 1",
            "state": "sample string 2",
            "geo_point": {
              "type": "sample string 1",
              "coordinates": [
                "sample string 1",
                "sample string 2"
              ]
            }
          },
          {
            "city": "sample string 1",
            "state": "sample string 2",
            "geo_point": {
              "type": "sample string 1",
              "coordinates": [
                "sample string 1",
                "sample string 2"
              ]
            }
          }
        ]
      }
    ],
    "from_email": "sample string 3"
  }
}

application/xml, text/xml

Sample:
<ParadeAI xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ViaTMSRestApi.Controllers">
  <payload>
    <capacities>
      <capacities>
        <destinations>
          <destinations>
            <city>sample string 1</city>
            <geo_point>
              <coordinates xmlns:d8p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
                <d8p1:string>sample string 1</d8p1:string>
                <d8p1:string>sample string 2</d8p1:string>
              </coordinates>
              <type>sample string 1</type>
            </geo_point>
            <state>sample string 2</state>
          </destinations>
          <destinations>
            <city>sample string 1</city>
            <geo_point>
              <coordinates xmlns:d8p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
                <d8p1:string>sample string 1</d8p1:string>
                <d8p1:string>sample string 2</d8p1:string>
              </coordinates>
              <type>sample string 1</type>
            </geo_point>
            <state>sample string 2</state>
          </destinations>
        </destinations>
        <dot_number>sample string 3</dot_number>
        <equipment>sample string 2</equipment>
        <equipment_metadata>
          <extra>
            <air_ride>true</air_ride>
            <hazmat>true</hazmat>
            <length>1</length>
            <tarps>true</tarps>
            <team>true</team>
          </extra>
          <trailer_type>
            <conestoga>true</conestoga>
            <container>true</container>
            <dd_deck>true</dd_deck>
            <dump_trailer>true</dump_trailer>
            <flatbed>true</flatbed>
            <po>true</po>
            <reefer>true</reefer>
            <rgn>true</rgn>
            <stepdeck>true</stepdeck>
            <tanker>true</tanker>
            <van>true</van>
          </trailer_type>
        </equipment_metadata>
        <id>1</id>
        <src_available_date>sample string 4</src_available_date>
        <src_available_time>sample string 5</src_available_time>
        <src_city>sample string 6</src_city>
        <src_geo_point>
          <coordinates xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:string>sample string 1</d6p1:string>
            <d6p1:string>sample string 2</d6p1:string>
          </coordinates>
          <type>sample string 1</type>
        </src_geo_point>
        <src_state>sample string 7</src_state>
      </capacities>
      <capacities>
        <destinations>
          <destinations>
            <city>sample string 1</city>
            <geo_point>
              <coordinates xmlns:d8p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
                <d8p1:string>sample string 1</d8p1:string>
                <d8p1:string>sample string 2</d8p1:string>
              </coordinates>
              <type>sample string 1</type>
            </geo_point>
            <state>sample string 2</state>
          </destinations>
          <destinations>
            <city>sample string 1</city>
            <geo_point>
              <coordinates xmlns:d8p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
                <d8p1:string>sample string 1</d8p1:string>
                <d8p1:string>sample string 2</d8p1:string>
              </coordinates>
              <type>sample string 1</type>
            </geo_point>
            <state>sample string 2</state>
          </destinations>
        </destinations>
        <dot_number>sample string 3</dot_number>
        <equipment>sample string 2</equipment>
        <equipment_metadata>
          <extra>
            <air_ride>true</air_ride>
            <hazmat>true</hazmat>
            <length>1</length>
            <tarps>true</tarps>
            <team>true</team>
          </extra>
          <trailer_type>
            <conestoga>true</conestoga>
            <container>true</container>
            <dd_deck>true</dd_deck>
            <dump_trailer>true</dump_trailer>
            <flatbed>true</flatbed>
            <po>true</po>
            <reefer>true</reefer>
            <rgn>true</rgn>
            <stepdeck>true</stepdeck>
            <tanker>true</tanker>
            <van>true</van>
          </trailer_type>
        </equipment_metadata>
        <id>1</id>
        <src_available_date>sample string 4</src_available_date>
        <src_available_time>sample string 5</src_available_time>
        <src_city>sample string 6</src_city>
        <src_geo_point>
          <coordinates xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:string>sample string 1</d6p1:string>
            <d6p1:string>sample string 2</d6p1:string>
          </coordinates>
          <type>sample string 1</type>
        </src_geo_point>
        <src_state>sample string 7</src_state>
      </capacities>
    </capacities>
    <carrier_metadata>
      <carrier_name>sample string 3</carrier_name>
      <dot_number>sample string 1</dot_number>
      <mc_number>sample string 2</mc_number>
    </carrier_metadata>
    <created_at>sample string 2</created_at>
    <from_email>sample string 3</from_email>
    <id>1</id>
  </payload>
</ParadeAI>

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 'ParadeAI'.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

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

Sample:

Sample not available.