Reference for https://api.circuitree.com/Itineraries/GetItinerariesActiveAndFuture.json

Url: https://api.circuitree.com/Itineraries/GetItinerariesActiveAndFuture.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:

<BaseEntityParameters xmlns="http://schemas.datacontract.org/2004/07/CircuiTree.Business.Components.API.Models">
  <ApiToken>String content</ApiToken>
  <EntityID>9223372036854775807</EntityID>
</BaseEntityParameters>

The following is an example request Json body:

{
	"ApiToken":"String content",
	"EntityID":9223372036854775807
}

The following is an example response Xml body:

<GetItineraryResult xmlns="http://schemas.datacontract.org/2004/07/CircuiTree.API.Web.Itinerary">
  <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>
  <Itineraries>
    <Itinerary>
      <ArrivalDate>String content</ArrivalDate>
      <AutoPay>
        <BalanceDueDate>1999-05-31T11:20:00</BalanceDueDate>
        <Calculated>true</Calculated>
        <EFTAccount>
          <AccountDetails xmlns="http://schemas.datacontract.org/2004/07/CircuiTree.API.Web.Registration">String content</AccountDetails>
          <AccountNickName xmlns="http://schemas.datacontract.org/2004/07/CircuiTree.API.Web.Registration">String content</AccountNickName>
          <EFTAccountID xmlns="http://schemas.datacontract.org/2004/07/CircuiTree.API.Web.Registration">2147483647</EFTAccountID>
          <MaskedAccountNumber xmlns="http://schemas.datacontract.org/2004/07/CircuiTree.API.Web.Registration">String content</MaskedAccountNumber>
          <PaymentType xmlns="http://schemas.datacontract.org/2004/07/CircuiTree.API.Web.Registration">String content</PaymentType>
        </EFTAccount>
        <EFTAccountID>9223372036854775807</EFTAccountID>
        <EndingDate>1999-05-31T11:20:00</EndingDate>
        <FixedPayment>12678967.543233</FixedPayment>
        <ItineraryID>9223372036854775807</ItineraryID>
        <NextPaymentDate>1999-05-31T11:20:00</NextPaymentDate>
        <NumberOfPayments>9223372036854775807</NumberOfPayments>
        <PayOutstandingBalance>true</PayOutstandingBalance>
        <PaysOn>String content</PaysOn>
        <Registration>9223372036854775807</Registration>
        <StartingDate>1999-05-31T11:20:00</StartingDate>
      </AutoPay>
      <BalanceDue>12678967.543233</BalanceDue>
      <DepartureDate>String content</DepartureDate>
      <EntityName>String content</EntityName>
      <ItineraryID>9223372036854775807</ItineraryID>
    </Itinerary>
    <Itinerary>
      <ArrivalDate>String content</ArrivalDate>
      <AutoPay>
        <BalanceDueDate>1999-05-31T11:20:00</BalanceDueDate>
        <Calculated>true</Calculated>
        <EFTAccount>
          <AccountDetails xmlns="http://schemas.datacontract.org/2004/07/CircuiTree.API.Web.Registration">String content</AccountDetails>
          <AccountNickName xmlns="http://schemas.datacontract.org/2004/07/CircuiTree.API.Web.Registration">String content</AccountNickName>
          <EFTAccountID xmlns="http://schemas.datacontract.org/2004/07/CircuiTree.API.Web.Registration">2147483647</EFTAccountID>
          <MaskedAccountNumber xmlns="http://schemas.datacontract.org/2004/07/CircuiTree.API.Web.Registration">String content</MaskedAccountNumber>
          <PaymentType xmlns="http://schemas.datacontract.org/2004/07/CircuiTree.API.Web.Registration">String content</PaymentType>
        </EFTAccount>
        <EFTAccountID>9223372036854775807</EFTAccountID>
        <EndingDate>1999-05-31T11:20:00</EndingDate>
        <FixedPayment>12678967.543233</FixedPayment>
        <ItineraryID>9223372036854775807</ItineraryID>
        <NextPaymentDate>1999-05-31T11:20:00</NextPaymentDate>
        <NumberOfPayments>9223372036854775807</NumberOfPayments>
        <PayOutstandingBalance>true</PayOutstandingBalance>
        <PaysOn>String content</PaysOn>
        <Registration>9223372036854775807</Registration>
        <StartingDate>1999-05-31T11:20:00</StartingDate>
      </AutoPay>
      <BalanceDue>12678967.543233</BalanceDue>
      <DepartureDate>String content</DepartureDate>
      <EntityName>String content</EntityName>
      <ItineraryID>9223372036854775807</ItineraryID>
    </Itinerary>
  </Itineraries>
</GetItineraryResult>

The following is an example response Json body:

{
	"StatusCode":0,
	"StatusMessage":"String content",
	"Itineraries":[{
		"ArrivalDate":"String content",
		"AutoPay":{
			"BalanceDueDate":"\/Date(928167600000-0500)\/",
			"Calculated":true,
			"EFTAccount":{
				"AccountDetails":"String content",
				"AccountNickName":"String content",
				"EFTAccountID":2147483647,
				"MaskedAccountNumber":"String content",
				"PaymentType":"String content"
			},
			"EFTAccountID":9223372036854775807,
			"EndingDate":"\/Date(928167600000-0500)\/",
			"FixedPayment":12678967.543233,
			"ItineraryID":9223372036854775807,
			"NextPaymentDate":"\/Date(928167600000-0500)\/",
			"NumberOfPayments":9223372036854775807,
			"PayOutstandingBalance":true,
			"PaysOn":"String content",
			"Registration":9223372036854775807,
			"StartingDate":"\/Date(928167600000-0500)\/"
		},
		"BalanceDue":12678967.543233,
		"DepartureDate":"String content",
		"EntityName":"String content",
		"ItineraryID":9223372036854775807
	}]
}

The following is the request Xml 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="BaseEntityParameters">
    <xs:complexContent mixed="false">
      <xs:extension base="tns:BaseRequest">
        <xs:sequence>
          <xs:element minOccurs="0" name="EntityID" type="xs:long" />
        </xs:sequence>
      </xs:extension>
    </xs:complexContent>
  </xs:complexType>
  <xs:element name="BaseEntityParameters" nillable="true" type="tns:BaseEntityParameters" />
  <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>

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 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.Itinerary" elementFormDefault="qualified" targetNamespace="http://schemas.datacontract.org/2004/07/CircuiTree.API.Web.Itinerary" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:import namespace="http://schemas.datacontract.org/2004/07/CircuiTree.Business.Components.API.Models" />
  <xs:import namespace="http://schemas.datacontract.org/2004/07/CircuiTree.API.Web.Registration" />
  <xs:complexType name="GetItineraryResult">
    <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="Itineraries" nillable="true" type="tns:ArrayOfItinerary" />
        </xs:sequence>
      </xs:extension>
    </xs:complexContent>
  </xs:complexType>
  <xs:element name="GetItineraryResult" nillable="true" type="tns:GetItineraryResult" />
  <xs:complexType name="ArrayOfItinerary">
    <xs:sequence>
      <xs:element minOccurs="0" maxOccurs="unbounded" name="Itinerary" nillable="true" type="tns:Itinerary" />
    </xs:sequence>
  </xs:complexType>
  <xs:element name="ArrayOfItinerary" nillable="true" type="tns:ArrayOfItinerary" />
  <xs:complexType name="Itinerary">
    <xs:sequence>
      <xs:element minOccurs="0" name="ArrivalDate" nillable="true" type="xs:string" />
      <xs:element minOccurs="0" name="AutoPay" nillable="true" type="tns:AutoPayResult" />
      <xs:element minOccurs="0" name="BalanceDue" type="xs:decimal" />
      <xs:element minOccurs="0" name="DepartureDate" nillable="true" type="xs:string" />
      <xs:element minOccurs="0" name="EntityName" nillable="true" type="xs:string" />
      <xs:element minOccurs="0" name="ItineraryID" type="xs:long" />
    </xs:sequence>
  </xs:complexType>
  <xs:element name="Itinerary" nillable="true" type="tns:Itinerary" />
  <xs:complexType name="AutoPayResult">
    <xs:sequence>
      <xs:element minOccurs="0" name="BalanceDueDate" type="xs:dateTime" />
      <xs:element minOccurs="0" name="Calculated" type="xs:boolean" />
      <xs:element minOccurs="0" name="EFTAccount" nillable="true" xmlns:q2="http://schemas.datacontract.org/2004/07/CircuiTree.API.Web.Registration" type="q2:EFTAccountSummaryResult" />
      <xs:element minOccurs="0" name="EFTAccountID" type="xs:long" />
      <xs:element minOccurs="0" name="EndingDate" type="xs:dateTime" />
      <xs:element minOccurs="0" name="FixedPayment" type="xs:decimal" />
      <xs:element minOccurs="0" name="ItineraryID" type="xs:long" />
      <xs:element minOccurs="0" name="NextPaymentDate" type="xs:dateTime" />
      <xs:element minOccurs="0" name="NumberOfPayments" type="xs:long" />
      <xs:element minOccurs="0" name="PayOutstandingBalance" type="xs:boolean" />
      <xs:element minOccurs="0" name="PaysOn" nillable="true" type="xs:string" />
      <xs:element minOccurs="0" name="Registration" type="xs:long" />
      <xs:element minOccurs="0" name="StartingDate" type="xs:dateTime" />
    </xs:sequence>
  </xs:complexType>
  <xs:element name="AutoPayResult" nillable="true" type="tns:AutoPayResult" />
</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 xmlns:tns="http://schemas.datacontract.org/2004/07/CircuiTree.API.Web.Registration" elementFormDefault="qualified" targetNamespace="http://schemas.datacontract.org/2004/07/CircuiTree.API.Web.Registration" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:complexType name="EFTAccountSummaryResult">
    <xs:sequence>
      <xs:element minOccurs="0" name="AccountDetails" nillable="true" type="xs:string" />
      <xs:element minOccurs="0" name="AccountNickName" nillable="true" type="xs:string" />
      <xs:element minOccurs="0" name="EFTAccountID" type="xs:int" />
      <xs:element minOccurs="0" name="MaskedAccountNumber" nillable="true" type="xs:string" />
      <xs:element minOccurs="0" name="PaymentType" nillable="true" type="xs:string" />
    </xs:sequence>
  </xs:complexType>
  <xs:element name="EFTAccountSummaryResult" nillable="true" type="tns:EFTAccountSummaryResult" />
</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>