Reference for https://api.circuitree.com/Transportation/GetCharterAvailability.json

Url: https://api.circuitree.com/Transportation/GetCharterAvailability.json

HTTP Method: POST

Message direction	Format	Body
Request	Xml	Example,Schema
Request	Json	Example
Response	Xml	Example,Schema
Response	Json	Example

The following is an example request Xml body:

<GetCharterAvailabilityParameter xmlns="http://schemas.datacontract.org/2004/07/CircuiTree.API.Web.Transportation">
  <ApiToken xmlns="http://schemas.datacontract.org/2004/07/CircuiTree.Business.Components.API.Models">String content</ApiToken>
  <EndDate>String content</EndDate>
  <StartDate>String content</StartDate>
  <Year>2147483647</Year>
</GetCharterAvailabilityParameter>

The following is an example request Json body:

{
	"ApiToken":"String content",
	"EndDate":"String content",
	"StartDate":"String content",
	"Year":2147483647
}

The following is an example response Xml body:

<GetCharterAvailabilityResult xmlns="http://schemas.datacontract.org/2004/07/CircuiTree.API.Web.Transportation">
  <StatusCode xmlns="http://schemas.datacontract.org/2004/07/CircuiTree.Business.Components.API.Models">Unknown</StatusCode>
  <StatusMessage xmlns="http://schemas.datacontract.org/2004/07/CircuiTree.Business.Components.API.Models">String content</StatusMessage>
  <CharterAvailabilityList>
    <CharterAvailability>
      <Abbreviation>String content</Abbreviation>
      <Address1>String content</Address1>
      <AddressName>String content</AddressName>
      <Capacity>String content</Capacity>
      <DateFilled>String content</DateFilled>
      <DepartureCity>String content</DepartureCity>
      <DepartureState>String content</DepartureState>
      <EndDate>String content</EndDate>
      <Enrolled>2147483647</Enrolled>
      <Fee>12678967.543233</Fee>
      <LoadDetails>String content</LoadDetails>
      <LoadTime>String content</LoadTime>
      <LocationNotes>String content</LocationNotes>
      <Name>String content</Name>
      <Open>2147483647</Open>
      <StartDate>String content</StartDate>
      <TransportationLocationID>2147483647</TransportationLocationID>
      <TransportationTripID>9223372036854775807</TransportationTripID>
      <TransportationType>2147483647</TransportationType>
      <UnlimitedCapacity>true</UnlimitedCapacity>
      <WaitListed>2147483647</WaitListed>
      <Zip>String content</Zip>
    </CharterAvailability>
    <CharterAvailability>
      <Abbreviation>String content</Abbreviation>
      <Address1>String content</Address1>
      <AddressName>String content</AddressName>
      <Capacity>String content</Capacity>
      <DateFilled>String content</DateFilled>
      <DepartureCity>String content</DepartureCity>
      <DepartureState>String content</DepartureState>
      <EndDate>String content</EndDate>
      <Enrolled>2147483647</Enrolled>
      <Fee>12678967.543233</Fee>
      <LoadDetails>String content</LoadDetails>
      <LoadTime>String content</LoadTime>
      <LocationNotes>String content</LocationNotes>
      <Name>String content</Name>
      <Open>2147483647</Open>
      <StartDate>String content</StartDate>
      <TransportationLocationID>2147483647</TransportationLocationID>
      <TransportationTripID>9223372036854775807</TransportationTripID>
      <TransportationType>2147483647</TransportationType>
      <UnlimitedCapacity>true</UnlimitedCapacity>
      <WaitListed>2147483647</WaitListed>
      <Zip>String content</Zip>
    </CharterAvailability>
  </CharterAvailabilityList>
</GetCharterAvailabilityResult>

The following is an example response Json body:

{
	"StatusCode":0,
	"StatusMessage":"String content",
	"CharterAvailabilityList":[{
		"Abbreviation":"String content",
		"Address1":"String content",
		"AddressName":"String content",
		"Capacity":"String content",
		"DateFilled":"String content",
		"DepartureCity":"String content",
		"DepartureState":"String content",
		"EndDate":"String content",
		"Enrolled":2147483647,
		"Fee":12678967.543233,
		"LoadDetails":"String content",
		"LoadTime":"String content",
		"LocationNotes":"String content",
		"Name":"String content",
		"Open":2147483647,
		"StartDate":"String content",
		"TransportationLocationID":2147483647,
		"TransportationTripID":9223372036854775807,
		"TransportationType":2147483647,
		"UnlimitedCapacity":true,
		"WaitListed":2147483647,
		"Zip":"String content"
	}]
}

The following is the request Xml Schema:

<xs:schema xmlns:tns="http://schemas.datacontract.org/2004/07/CircuiTree.API.Web.Transportation" elementFormDefault="qualified" targetNamespace="http://schemas.datacontract.org/2004/07/CircuiTree.API.Web.Transportation" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:import namespace="http://schemas.datacontract.org/2004/07/CircuiTree.Business.Components.API.Models" />
  <xs:complexType name="GetCharterAvailabilityParameter">
    <xs:complexContent mixed="false">
      <xs:extension xmlns:q1="http://schemas.datacontract.org/2004/07/CircuiTree.Business.Components.API.Models" base="q1:BaseRequest">
        <xs:sequence>
          <xs:element minOccurs="0" name="EndDate" nillable="true" type="xs:string" />
          <xs:element minOccurs="0" name="StartDate" nillable="true" type="xs:string" />
          <xs:element minOccurs="0" name="Year" type="xs:int" />
        </xs:sequence>
      </xs:extension>
    </xs:complexContent>
  </xs:complexType>
  <xs:element name="GetCharterAvailabilityParameter" nillable="true" type="tns:GetCharterAvailabilityParameter" />
</xs:schema>

Additional request Xml Schemas:

<xs:schema xmlns:tns="http://schemas.microsoft.com/2003/10/Serialization/" attributeFormDefault="qualified" elementFormDefault="qualified" targetNamespace="http://schemas.microsoft.com/2003/10/Serialization/" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:element name="anyType" nillable="true" type="xs:anyType" />
  <xs:element name="anyURI" nillable="true" type="xs:anyURI" />
  <xs:element name="base64Binary" nillable="true" type="xs:base64Binary" />
  <xs:element name="boolean" nillable="true" type="xs:boolean" />
  <xs:element name="byte" nillable="true" type="xs:byte" />
  <xs:element name="dateTime" nillable="true" type="xs:dateTime" />
  <xs:element name="decimal" nillable="true" type="xs:decimal" />
  <xs:element name="double" nillable="true" type="xs:double" />
  <xs:element name="float" nillable="true" type="xs:float" />
  <xs:element name="int" nillable="true" type="xs:int" />
  <xs:element name="long" nillable="true" type="xs:long" />
  <xs:element name="QName" nillable="true" type="xs:QName" />
  <xs:element name="short" nillable="true" type="xs:short" />
  <xs:element name="string" nillable="true" type="xs:string" />
  <xs:element name="unsignedByte" nillable="true" type="xs:unsignedByte" />
  <xs:element name="unsignedInt" nillable="true" type="xs:unsignedInt" />
  <xs:element name="unsignedLong" nillable="true" type="xs:unsignedLong" />
  <xs:element name="unsignedShort" nillable="true" type="xs:unsignedShort" />
  <xs:element name="char" nillable="true" type="tns:char" />
  <xs:simpleType name="char">
    <xs:restriction base="xs:int" />
  </xs:simpleType>
  <xs:element name="duration" nillable="true" type="tns:duration" />
  <xs:simpleType name="duration">
    <xs:restriction base="xs:duration">
      <xs:pattern value="\-?P(\d*D)?(T(\d*H)?(\d*M)?(\d*(\.\d*)?S)?)?" />
      <xs:minInclusive value="-P10675199DT2H48M5.4775808S" />
      <xs:maxInclusive value="P10675199DT2H48M5.4775807S" />
    </xs:restriction>
  </xs:simpleType>
  <xs:element name="guid" nillable="true" type="tns:guid" />
  <xs:simpleType name="guid">
    <xs:restriction base="xs:string">
      <xs:pattern value="[\da-fA-F]{8}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{12}" />
    </xs:restriction>
  </xs:simpleType>
  <xs:attribute name="FactoryType" type="xs:QName" />
  <xs:attribute name="Id" type="xs:ID" />
  <xs:attribute name="Ref" type="xs:IDREF" />
</xs:schema>

<xs:schema xmlns:tns="http://schemas.datacontract.org/2004/07/CircuiTree.Business.Components.API.Models" elementFormDefault="qualified" targetNamespace="http://schemas.datacontract.org/2004/07/CircuiTree.Business.Components.API.Models" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:complexType name="BaseRequest">
    <xs:sequence>
      <xs:element name="ApiToken" nillable="true" type="xs:string" />
    </xs:sequence>
  </xs:complexType>
  <xs:element name="BaseRequest" nillable="true" type="tns:BaseRequest" />
</xs:schema>

<xs:schema targetNamespace="http://www.w3.org/2001/XMLSchema" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:element name="schema">
    <xs:complexType />
  </xs:element>
</xs:schema>

The following is the response Xml Schema:

<xs:schema xmlns:tns="http://schemas.datacontract.org/2004/07/CircuiTree.API.Web.Transportation" elementFormDefault="qualified" targetNamespace="http://schemas.datacontract.org/2004/07/CircuiTree.API.Web.Transportation" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:import namespace="http://schemas.datacontract.org/2004/07/CircuiTree.Business.Components.API.Models" />
  <xs:complexType name="GetCharterAvailabilityResult">
    <xs:complexContent mixed="false">
      <xs:extension xmlns:q1="http://schemas.datacontract.org/2004/07/CircuiTree.Business.Components.API.Models" base="q1:BaseResult">
        <xs:sequence>
          <xs:element minOccurs="0" name="CharterAvailabilityList" nillable="true" type="tns:ArrayOfCharterAvailability" />
        </xs:sequence>
      </xs:extension>
    </xs:complexContent>
  </xs:complexType>
  <xs:element name="GetCharterAvailabilityResult" nillable="true" type="tns:GetCharterAvailabilityResult" />
  <xs:complexType name="ArrayOfCharterAvailability">
    <xs:sequence>
      <xs:element minOccurs="0" maxOccurs="unbounded" name="CharterAvailability" nillable="true" type="tns:CharterAvailability" />
    </xs:sequence>
  </xs:complexType>
  <xs:element name="ArrayOfCharterAvailability" nillable="true" type="tns:ArrayOfCharterAvailability" />
  <xs:complexType name="CharterAvailability">
    <xs:sequence>
      <xs:element minOccurs="0" name="Abbreviation" nillable="true" type="xs:string" />
      <xs:element minOccurs="0" name="Address1" nillable="true" type="xs:string" />
      <xs:element minOccurs="0" name="AddressName" nillable="true" type="xs:string" />
      <xs:element minOccurs="0" name="Capacity" nillable="true" type="xs:string" />
      <xs:element minOccurs="0" name="DateFilled" nillable="true" type="xs:string" />
      <xs:element minOccurs="0" name="DepartureCity" nillable="true" type="xs:string" />
      <xs:element minOccurs="0" name="DepartureState" nillable="true" type="xs:string" />
      <xs:element minOccurs="0" name="EndDate" nillable="true" type="xs:string" />
      <xs:element minOccurs="0" name="Enrolled" type="xs:int" />
      <xs:element minOccurs="0" name="Fee" type="xs:decimal" />
      <xs:element minOccurs="0" name="LoadDetails" nillable="true" type="xs:string" />
      <xs:element minOccurs="0" name="LoadTime" nillable="true" type="xs:string" />
      <xs:element minOccurs="0" name="LocationNotes" nillable="true" type="xs:string" />
      <xs:element minOccurs="0" name="Name" nillable="true" type="xs:string" />
      <xs:element minOccurs="0" name="Open" type="xs:int" />
      <xs:element minOccurs="0" name="StartDate" nillable="true" type="xs:string" />
      <xs:element minOccurs="0" name="TransportationLocationID" type="xs:int" />
      <xs:element minOccurs="0" name="TransportationTripID" type="xs:long" />
      <xs:element minOccurs="0" name="TransportationType" type="xs:int" />
      <xs:element minOccurs="0" name="UnlimitedCapacity" type="xs:boolean" />
      <xs:element minOccurs="0" name="WaitListed" type="xs:int" />
      <xs:element minOccurs="0" name="Zip" nillable="true" type="xs:string" />
    </xs:sequence>
  </xs:complexType>
  <xs:element name="CharterAvailability" nillable="true" type="tns:CharterAvailability" />
</xs:schema>

Additional response Xml Schemas:

<xs:schema xmlns:tns="http://schemas.microsoft.com/2003/10/Serialization/" attributeFormDefault="qualified" elementFormDefault="qualified" targetNamespace="http://schemas.microsoft.com/2003/10/Serialization/" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:element name="anyType" nillable="true" type="xs:anyType" />
  <xs:element name="anyURI" nillable="true" type="xs:anyURI" />
  <xs:element name="base64Binary" nillable="true" type="xs:base64Binary" />
  <xs:element name="boolean" nillable="true" type="xs:boolean" />
  <xs:element name="byte" nillable="true" type="xs:byte" />
  <xs:element name="dateTime" nillable="true" type="xs:dateTime" />
  <xs:element name="decimal" nillable="true" type="xs:decimal" />
  <xs:element name="double" nillable="true" type="xs:double" />
  <xs:element name="float" nillable="true" type="xs:float" />
  <xs:element name="int" nillable="true" type="xs:int" />
  <xs:element name="long" nillable="true" type="xs:long" />
  <xs:element name="QName" nillable="true" type="xs:QName" />
  <xs:element name="short" nillable="true" type="xs:short" />
  <xs:element name="string" nillable="true" type="xs:string" />
  <xs:element name="unsignedByte" nillable="true" type="xs:unsignedByte" />
  <xs:element name="unsignedInt" nillable="true" type="xs:unsignedInt" />
  <xs:element name="unsignedLong" nillable="true" type="xs:unsignedLong" />
  <xs:element name="unsignedShort" nillable="true" type="xs:unsignedShort" />
  <xs:element name="char" nillable="true" type="tns:char" />
  <xs:simpleType name="char">
    <xs:restriction base="xs:int" />
  </xs:simpleType>
  <xs:element name="duration" nillable="true" type="tns:duration" />
  <xs:simpleType name="duration">
    <xs:restriction base="xs:duration">
      <xs:pattern value="\-?P(\d*D)?(T(\d*H)?(\d*M)?(\d*(\.\d*)?S)?)?" />
      <xs:minInclusive value="-P10675199DT2H48M5.4775808S" />
      <xs:maxInclusive value="P10675199DT2H48M5.4775807S" />
    </xs:restriction>
  </xs:simpleType>
  <xs:element name="guid" nillable="true" type="tns:guid" />
  <xs:simpleType name="guid">
    <xs:restriction base="xs:string">
      <xs:pattern value="[\da-fA-F]{8}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{12}" />
    </xs:restriction>
  </xs:simpleType>
  <xs:attribute name="FactoryType" type="xs:QName" />
  <xs:attribute name="Id" type="xs:ID" />
  <xs:attribute name="Ref" type="xs:IDREF" />
</xs:schema>

<xs:schema xmlns:tns="http://schemas.datacontract.org/2004/07/CircuiTree.Business.Components.API.Models" elementFormDefault="qualified" targetNamespace="http://schemas.datacontract.org/2004/07/CircuiTree.Business.Components.API.Models" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:import namespace="http://schemas.datacontract.org/2004/07/CTS.Common" />
  <xs:complexType name="BaseResult">
    <xs:sequence>
      <xs:element minOccurs="0" name="StatusCode" xmlns:q1="http://schemas.datacontract.org/2004/07/CTS.Common" type="q1:Enums.APIStatusCodes" />
      <xs:element minOccurs="0" name="StatusMessage" nillable="true" type="xs:string" />
    </xs:sequence>
  </xs:complexType>
  <xs:element name="BaseResult" nillable="true" type="tns:BaseResult" />
</xs:schema>

<xs:schema xmlns:tns="http://schemas.datacontract.org/2004/07/CTS.Common" elementFormDefault="qualified" targetNamespace="http://schemas.datacontract.org/2004/07/CTS.Common" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:simpleType name="Enums.APIStatusCodes">
    <xs:restriction base="xs:string">
      <xs:enumeration value="Unknown" />
      <xs:enumeration value="Success" />
      <xs:enumeration value="InvalidCredentials" />
      <xs:enumeration value="InvalidCompanyCode" />
      <xs:enumeration value="Configuration" />
      <xs:enumeration value="UnexpectedError" />
      <xs:enumeration value="Invalid" />
      <xs:enumeration value="Failed" />
    </xs:restriction>
  </xs:simpleType>
  <xs:element name="Enums.APIStatusCodes" nillable="true" type="tns:Enums.APIStatusCodes" />
</xs:schema>

<xs:schema targetNamespace="http://www.w3.org/2001/XMLSchema" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:element name="schema">
    <xs:complexType />
  </xs:element>
</xs:schema>