Agentivity API

<back to all web services

GetBookingsWithActiveSegments

import java.math.*;
import java.util.*;
import java.io.InputStream;
import net.servicestack.client.*;

public class dtos
{

    @DataContract(Namespace="schemas.agentivity.com/types")
    public static class GetBookingsWithActiveSegments extends CompanyLevelRequestBase
    {
        /**
        * Date in format YYYYMMDD
        */
        @DataMember
        public String TravelDateStart = null;

        /**
        * Date in format YYYYMMDD
        */
        @DataMember
        public String TravelDateEnd = null;

        /**
        * All future date
        */
        @DataMember
        public Boolean AllFutureDate = null;

        /**
        * Comma Delimited List of Accounts
        */
        @DataMember
        public ArrayList<String> Account = null;
        
        public String getTravelDateStart() { return TravelDateStart; }
        public GetBookingsWithActiveSegments setTravelDateStart(String value) { this.TravelDateStart = value; return this; }
        public String getTravelDateEnd() { return TravelDateEnd; }
        public GetBookingsWithActiveSegments setTravelDateEnd(String value) { this.TravelDateEnd = value; return this; }
        public Boolean isAllFutureDate() { return AllFutureDate; }
        public GetBookingsWithActiveSegments setAllFutureDate(Boolean value) { this.AllFutureDate = value; return this; }
        public ArrayList<String> getAccount() { return Account; }
        public GetBookingsWithActiveSegments setAccount(ArrayList<String> value) { this.Account = value; return this; }
    }

    @DataContract(Namespace="schemas.agentivity.com/types")
    public static class CompanyLevelRequestBase extends PagingMetadata implements IMemberUsername, IMemberOwningCompanyCode
    {
        /**
        * Comma Delimited List of Owning Company Codes
        */
        @DataMember
        public ArrayList<String> OwningCompanyCode = null;

        /**
        * UserName in form of an email address
        */
        @DataMember
        public String UserName = null;
        
        public ArrayList<String> getOwningCompanyCode() { return OwningCompanyCode; }
        public CompanyLevelRequestBase setOwningCompanyCode(ArrayList<String> value) { this.OwningCompanyCode = value; return this; }
        public String getUserName() { return UserName; }
        public CompanyLevelRequestBase setUserName(String value) { this.UserName = value; return this; }
    }

    @DataContract(Name="Metadata", Namespace="schemas.agentivity.com/types")
    public static class PagingMetadata
    {
        /**
        * Starting Record
        */
        @DataMember
        @ApiMember(DataType="string", Description="Starting Record", Name="Offset", ParameterType="query")
        public String Offset = null;

        /**
        * Number of records to return (PageSize)
        */
        @DataMember
        @ApiMember(DataType="string", Description="Number of records to return (PageSize)", Name="Limit", ParameterType="query")
        public String Limit = null;

        /**
        * Total Number of Records in a Full Reponse (if no paging)
        */
        @DataMember
        @ApiMember(DataType="string", Description="Total Number of Records in a Full Reponse (if no paging)", Name="TotalRecords", ParameterType="query")
        public Integer TotalRecords = null;

        /**
        * Total Number of Records in this Reponse (on this page)
        */
        @DataMember
        @ApiMember(DataType="string", Description="Total Number of Records in this Reponse (on this page)", Name="ResponseRecords", ParameterType="query")
        public Integer ResponseRecords = null;
        
        public String getOffset() { return Offset; }
        public PagingMetadata setOffset(String value) { this.Offset = value; return this; }
        public String getLimit() { return Limit; }
        public PagingMetadata setLimit(String value) { this.Limit = value; return this; }
        public Integer getTotalRecords() { return TotalRecords; }
        public PagingMetadata setTotalRecords(Integer value) { this.TotalRecords = value; return this; }
        public Integer getResponseRecords() { return ResponseRecords; }
        public PagingMetadata setResponseRecords(Integer value) { this.ResponseRecords = value; return this; }
    }

    @DataContract(Name="AgentivityResponse", Namespace="schemas.agentivity.com/types")
    public static class GetBookingsWithActiveSegmentsItemResponse extends ItemResponse<BookingWithActiveSegments, GetBookingsWithActiveSegmentsResponseReport>
    {
        
    }

    @DataContract(Name="AgentivityResponse", Namespace="schemas.agentivity.com/types")
    public static class ItemResponse<TItem, TReport>
    {
        @DataMember(Order=1)
        public ResponseMetadata ResponseMetadata = null;

        @DataMember(Order=2, EmitDefaultValue=false)
        public TReport ResponseReport = null;

        @DataMember(Order=3, EmitDefaultValue=false)
        public AgentivityError ResponseError = null;
        
        public ResponseMetadata getResponseMetadata() { return ResponseMetadata; }
        public ItemResponse<TItem, TReport> setResponseMetadata(ResponseMetadata value) { this.ResponseMetadata = value; return this; }
        public TReport getResponseReport() { return ResponseReport; }
        public ItemResponse<TItem, TReport> setResponseReport(TReport value) { this.ResponseReport = value; return this; }
        public AgentivityError getResponseError() { return ResponseError; }
        public ItemResponse<TItem, TReport> setResponseError(AgentivityError value) { this.ResponseError = value; return this; }
    }

    @DataContract(Name="ResponseMetadata", Namespace="schemas.agentivity.com/types")
    public static class ResponseMetadata
    {
        @DataMember(Order=0)
        public Boolean Success = null;

        @DataMember(Order=1)
        public Boolean HasCache = null;

        @DataMember(Order=2)
        public Boolean HasPaging = null;

        @DataMember(Order=3, EmitDefaultValue=false)
        public CacheMetadata CacheMetadata = null;

        @DataMember(Order=4, EmitDefaultValue=false)
        public PagingMetadata PagingMetadata = null;
        
        public Boolean isSuccess() { return Success; }
        public ResponseMetadata setSuccess(Boolean value) { this.Success = value; return this; }
        public Boolean isHasCache() { return HasCache; }
        public ResponseMetadata setHasCache(Boolean value) { this.HasCache = value; return this; }
        public Boolean isHasPaging() { return HasPaging; }
        public ResponseMetadata setHasPaging(Boolean value) { this.HasPaging = value; return this; }
        public CacheMetadata getCacheMetadata() { return CacheMetadata; }
        public ResponseMetadata setCacheMetadata(CacheMetadata value) { this.CacheMetadata = value; return this; }
        public PagingMetadata getPagingMetadata() { return PagingMetadata; }
        public ResponseMetadata setPagingMetadata(PagingMetadata value) { this.PagingMetadata = value; return this; }
    }

    @DataContract(Name="CacheMetadata", Namespace="schemas.agentivity.com/types")
    public static class CacheMetadata
    {
        @DataMember(Order=1)
        public Date CachedAt = null;

        @DataMember(Order=2)
        public Date CacheExpiresAt = null;

        @DataMember(Order=0)
        public Boolean IsFromCache = null;
        
        public Date getCachedAt() { return CachedAt; }
        public CacheMetadata setCachedAt(Date value) { this.CachedAt = value; return this; }
        public Date getCacheExpiresAt() { return CacheExpiresAt; }
        public CacheMetadata setCacheExpiresAt(Date value) { this.CacheExpiresAt = value; return this; }
        public Boolean getIsFromCache() { return IsFromCache; }
        public CacheMetadata setIsFromCache(Boolean value) { this.IsFromCache = value; return this; }
    }

    @DataContract(Name="ResponseMetadata", Namespace="schemas.agentivity.com/types")
    public static class AgentivityError
    {
        @DataMember
        public String ErrorCode = null;

        @DataMember
        public String Message = null;

        @DataMember
        public String StatusCode = null;

        @DataMember
        public String VerboseMessage = null;
        
        public String getErrorCode() { return ErrorCode; }
        public AgentivityError setErrorCode(String value) { this.ErrorCode = value; return this; }
        public String getMessage() { return Message; }
        public AgentivityError setMessage(String value) { this.Message = value; return this; }
        public String getStatusCode() { return StatusCode; }
        public AgentivityError setStatusCode(String value) { this.StatusCode = value; return this; }
        public String getVerboseMessage() { return VerboseMessage; }
        public AgentivityError setVerboseMessage(String value) { this.VerboseMessage = value; return this; }
    }

    @DataContract(Name="BookingWithActiveSegments", Namespace="schemas.agentivity.com/types")
    public static class BookingWithActiveSegments implements IBookingIdentifier, ITicketNumbers, IVendorLocators
    {
        @DataMember(Order=10)
        public Integer AgentivityRef = null;

        @DataMember(Order=20)
        public String RecordLocator = null;

        @DataMember(Order=30)
        public Date PNRCreationDate = null;

        @DataMember(Order=40)
        public String OwningAgencyLocationID = null;

        @DataMember(Order=50)
        public String Account = null;

        @DataMember(Order=60)
        public String OwningConsultantID = null;

        @DataMember(Order=70)
        public String OwningConsultant = null;

        @DataMember(Order=80)
        public Date TravelDate = null;

        @DataMember(Order=85)
        public String Passenger = null;

        @DataMember(Order=90)
        public String PNRTicketed = null;

        @DataMember(Order=100)
        public String EmailAddress = null;

        @DataMember(Order=110)
        public String PhoneNbr = null;

        @DataMember(Order=120)
        public Boolean HasAir = null;

        @DataMember(Order=130)
        public Boolean HasHtl = null;

        @DataMember(Order=140)
        public Boolean HasCar = null;

        @DataMember(Order=150)
        public String DestinationCities = null;

        @DataMember(Order=160)
        public String Connections = null;

        @DataMember(Order=170)
        public String CarrierCodes = null;

        @DataMember(Order=180)
        public String FlightNumbers = null;

        @DataMember(Order=190)
        public String IataCodes = null;

        @DataMember(Order=200)
        public ArrayList<String> TicketNumbers = null;

        @DataMember(Order=210)
        public ArrayList<BookingExtVendorLocator> VendorLocators = null;
        
        public Integer getAgentivityRef() { return AgentivityRef; }
        public BookingWithActiveSegments setAgentivityRef(Integer value) { this.AgentivityRef = value; return this; }
        public String getRecordLocator() { return RecordLocator; }
        public BookingWithActiveSegments setRecordLocator(String value) { this.RecordLocator = value; return this; }
        public Date getPnrCreationDate() { return PNRCreationDate; }
        public BookingWithActiveSegments setPnrCreationDate(Date value) { this.PNRCreationDate = value; return this; }
        public String getOwningAgencyLocationID() { return OwningAgencyLocationID; }
        public BookingWithActiveSegments setOwningAgencyLocationID(String value) { this.OwningAgencyLocationID = value; return this; }
        public String getAccount() { return Account; }
        public BookingWithActiveSegments setAccount(String value) { this.Account = value; return this; }
        public String getOwningConsultantID() { return OwningConsultantID; }
        public BookingWithActiveSegments setOwningConsultantID(String value) { this.OwningConsultantID = value; return this; }
        public String getOwningConsultant() { return OwningConsultant; }
        public BookingWithActiveSegments setOwningConsultant(String value) { this.OwningConsultant = value; return this; }
        public Date getTravelDate() { return TravelDate; }
        public BookingWithActiveSegments setTravelDate(Date value) { this.TravelDate = value; return this; }
        public String getPassenger() { return Passenger; }
        public BookingWithActiveSegments setPassenger(String value) { this.Passenger = value; return this; }
        public String getPnrTicketed() { return PNRTicketed; }
        public BookingWithActiveSegments setPnrTicketed(String value) { this.PNRTicketed = value; return this; }
        public String getEmailAddress() { return EmailAddress; }
        public BookingWithActiveSegments setEmailAddress(String value) { this.EmailAddress = value; return this; }
        public String getPhoneNbr() { return PhoneNbr; }
        public BookingWithActiveSegments setPhoneNbr(String value) { this.PhoneNbr = value; return this; }
        public Boolean isHasAir() { return HasAir; }
        public BookingWithActiveSegments setHasAir(Boolean value) { this.HasAir = value; return this; }
        public Boolean isHasHtl() { return HasHtl; }
        public BookingWithActiveSegments setHasHtl(Boolean value) { this.HasHtl = value; return this; }
        public Boolean isHasCar() { return HasCar; }
        public BookingWithActiveSegments setHasCar(Boolean value) { this.HasCar = value; return this; }
        public String getDestinationCities() { return DestinationCities; }
        public BookingWithActiveSegments setDestinationCities(String value) { this.DestinationCities = value; return this; }
        public String getConnections() { return Connections; }
        public BookingWithActiveSegments setConnections(String value) { this.Connections = value; return this; }
        public String getCarrierCodes() { return CarrierCodes; }
        public BookingWithActiveSegments setCarrierCodes(String value) { this.CarrierCodes = value; return this; }
        public String getFlightNumbers() { return FlightNumbers; }
        public BookingWithActiveSegments setFlightNumbers(String value) { this.FlightNumbers = value; return this; }
        public String getIataCodes() { return IataCodes; }
        public BookingWithActiveSegments setIataCodes(String value) { this.IataCodes = value; return this; }
        public ArrayList<String> getTicketNumbers() { return TicketNumbers; }
        public BookingWithActiveSegments setTicketNumbers(ArrayList<String> value) { this.TicketNumbers = value; return this; }
        public ArrayList<BookingExtVendorLocator> getVendorLocators() { return VendorLocators; }
        public BookingWithActiveSegments setVendorLocators(ArrayList<BookingExtVendorLocator> value) { this.VendorLocators = value; return this; }
    }

    @DataContract(Name="VendorLocator", Namespace="schemas.agentivity.com/types")
    public static class BookingExtVendorLocator implements IBookingIdentifier
    {
        @DataMember(Order=10)
        public String CarrierCode = null;

        @DataMember(Order=20)
        public String VendorLocator = null;
        
        public String getCarrierCode() { return CarrierCode; }
        public BookingExtVendorLocator setCarrierCode(String value) { this.CarrierCode = value; return this; }
        public String getVendorLocator() { return VendorLocator; }
        public BookingExtVendorLocator setVendorLocator(String value) { this.VendorLocator = value; return this; }
    }

    @DataContract(Name="BookingWithActiveSegments", Namespace="schemas.agentivity.com/types")
    public static class GetBookingsWithActiveSegmentsResponseReport extends Report<GetBookingsWithActiveSegmentsItemResponse, BookingWithActiveSegments>
    {
        
    }

    @DataContract(Namespace="schemas.agentivity.com/types")
    public static class Report<TItemResponse, TItem>
    {
        @DataMember(Order=1, EmitDefaultValue=false)
        public TItem Item = null;
        
        public TItem getItem() { return Item; }
        public Report<TItemResponse, TItem> setItem(TItem value) { this.Item = value; return this; }
    }

}

Java GetBookingsWithActiveSegments DTOs

POST /BookingsWithActiveSegments HTTP/1.1 
Host: api.agentivity.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<GetBookingsWithActiveSegments xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="schemas.agentivity.com/types">
  <Limit>String</Limit>
  <Offset>String</Offset>
  <ResponseRecords>0</ResponseRecords>
  <TotalRecords>0</TotalRecords>
  <OwningCompanyCode xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </OwningCompanyCode>
  <UserName>String</UserName>
  <Account xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </Account>
  <AllFutureDate>false</AllFutureDate>
  <TravelDateEnd>String</TravelDateEnd>
  <TravelDateStart>String</TravelDateStart>
</GetBookingsWithActiveSegments>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<AgentivityResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="schemas.agentivity.com/types">
  <ResponseMetadata>
    <Success>false</Success>
    <HasCache>false</HasCache>
    <HasPaging>false</HasPaging>
    <CacheMetadata>
      <IsFromCache>false</IsFromCache>
      <CachedAt>0001-01-01T00:00:00</CachedAt>
      <CacheExpiresAt>0001-01-01T00:00:00</CacheExpiresAt>
    </CacheMetadata>
    <PagingMetadata>
      <Limit>String</Limit>
      <Offset>String</Offset>
      <ResponseRecords>0</ResponseRecords>
      <TotalRecords>0</TotalRecords>
    </PagingMetadata>
  </ResponseMetadata>
  <ResponseReport>
    <Item>
      <AgentivityRef>0</AgentivityRef>
      <RecordLocator>String</RecordLocator>
      <PNRCreationDate>0001-01-01T00:00:00</PNRCreationDate>
      <OwningAgencyLocationID>String</OwningAgencyLocationID>
      <Account>String</Account>
      <OwningConsultantID>String</OwningConsultantID>
      <OwningConsultant>String</OwningConsultant>
      <TravelDate>0001-01-01T00:00:00</TravelDate>
      <Passenger>String</Passenger>
      <PNRTicketed>String</PNRTicketed>
      <EmailAddress>String</EmailAddress>
      <PhoneNbr>String</PhoneNbr>
      <HasAir>false</HasAir>
      <HasHtl>false</HasHtl>
      <HasCar>false</HasCar>
      <DestinationCities>String</DestinationCities>
      <Connections>String</Connections>
      <CarrierCodes>String</CarrierCodes>
      <FlightNumbers>String</FlightNumbers>
      <IataCodes>String</IataCodes>
      <TicketNumbers xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>String</d4p1:string>
      </TicketNumbers>
      <VendorLocators>
        <VendorLocator>
          <CarrierCode>String</CarrierCode>
          <VendorLocator>String</VendorLocator>
        </VendorLocator>
      </VendorLocators>
    </Item>
  </ResponseReport>
  <ResponseError>
    <ErrorCode>String</ErrorCode>
    <Message>String</Message>
    <StatusCode>String</StatusCode>
    <VerboseMessage>String</VerboseMessage>
  </ResponseError>
</AgentivityResponse>