Agentivity API

<back to all web services

GetPassengerLocationsByFlightNumber

The following routes are available for this service:
GET/PassengerLocationsByFlightNumber
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 GetPassengerLocationsByFlightNumber extends CompanyLevelRequestBase
    {
        /**
        * Comma Delimited List of Accounts
        */
        @DataMember
        public ArrayList<String> Account = null;

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

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

        /**
        * Two letter code for carrier
        */
        @DataMember
        public String CarrierCode = null;

        /**
        * Flight number without spaces
        */
        @DataMember
        public String FlightNumber = null;

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

        /**
        * Comma Delimited List of Custom Fields
        */
        @DataMember
        public ArrayList<String> CustomField = null;
        
        public ArrayList<String> getAccount() { return Account; }
        public GetPassengerLocationsByFlightNumber setAccount(ArrayList<String> value) { this.Account = value; return this; }
        public String getDepartureDateStart() { return DepartureDateStart; }
        public GetPassengerLocationsByFlightNumber setDepartureDateStart(String value) { this.DepartureDateStart = value; return this; }
        public String getDepartureDateEnd() { return DepartureDateEnd; }
        public GetPassengerLocationsByFlightNumber setDepartureDateEnd(String value) { this.DepartureDateEnd = value; return this; }
        public String getCarrierCode() { return CarrierCode; }
        public GetPassengerLocationsByFlightNumber setCarrierCode(String value) { this.CarrierCode = value; return this; }
        public String getFlightNumber() { return FlightNumber; }
        public GetPassengerLocationsByFlightNumber setFlightNumber(String value) { this.FlightNumber = value; return this; }
        public Boolean isAllFutureDate() { return AllFutureDate; }
        public GetPassengerLocationsByFlightNumber setAllFutureDate(Boolean value) { this.AllFutureDate = value; return this; }
        public ArrayList<String> getCustomField() { return CustomField; }
        public GetPassengerLocationsByFlightNumber setCustomField(ArrayList<String> value) { this.CustomField = 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 PassengerLocationsByFlightNumberItemResponse extends ItemResponse<PassengerLocationFlightNumber, PassengerLocationsByFlightNumberResponseReport>
    {
        
    }

    @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="PassengerLocationFlightNumber", Namespace="schemas.agentivity.com/types")
    public static class PassengerLocationFlightNumber implements IBookingCustomFields, IBookingIdentifier, ITicketNumbers, IVendorLocators
    {
        @DataMember(Order=10)
        public Integer AgentivityRef = null;

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

        @DataMember(Order=30)
        public String PaxList = null;

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

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

        @DataMember(Order=60)
        public Date DepartureDate = null;

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

        @DataMember(Order=80)
        public String OffPoint = null;

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

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

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

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

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

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

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

        @DataMember(Order=160)
        public CustomFieldsCollection CustomFields = null;

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

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

        @DataMember(Order=190)
        public ArrayList<BookingExtVendorLocator> VendorLocators = null;
        
        public Integer getAgentivityRef() { return AgentivityRef; }
        public PassengerLocationFlightNumber setAgentivityRef(Integer value) { this.AgentivityRef = value; return this; }
        public String getRecordLocator() { return RecordLocator; }
        public PassengerLocationFlightNumber setRecordLocator(String value) { this.RecordLocator = value; return this; }
        public String getPaxList() { return PaxList; }
        public PassengerLocationFlightNumber setPaxList(String value) { this.PaxList = value; return this; }
        public String getOwningConsultantID() { return OwningConsultantID; }
        public PassengerLocationFlightNumber setOwningConsultantID(String value) { this.OwningConsultantID = value; return this; }
        public String getAccount() { return Account; }
        public PassengerLocationFlightNumber setAccount(String value) { this.Account = value; return this; }
        public Date getDepartureDate() { return DepartureDate; }
        public PassengerLocationFlightNumber setDepartureDate(Date value) { this.DepartureDate = value; return this; }
        public String getBoardPoint() { return BoardPoint; }
        public PassengerLocationFlightNumber setBoardPoint(String value) { this.BoardPoint = value; return this; }
        public String getOffPoint() { return OffPoint; }
        public PassengerLocationFlightNumber setOffPoint(String value) { this.OffPoint = value; return this; }
        public String getDepartureTime() { return DepartureTime; }
        public PassengerLocationFlightNumber setDepartureTime(String value) { this.DepartureTime = value; return this; }
        public String getArrivalTime() { return ArrivalTime; }
        public PassengerLocationFlightNumber setArrivalTime(String value) { this.ArrivalTime = value; return this; }
        public String getChangeOfDay() { return ChangeOfDay; }
        public PassengerLocationFlightNumber setChangeOfDay(String value) { this.ChangeOfDay = value; return this; }
        public String getEmailAddress() { return EmailAddress; }
        public PassengerLocationFlightNumber setEmailAddress(String value) { this.EmailAddress = value; return this; }
        public String getPhoneNbr() { return PhoneNbr; }
        public PassengerLocationFlightNumber setPhoneNbr(String value) { this.PhoneNbr = value; return this; }
        public String getOwningAgencyLocationID() { return OwningAgencyLocationID; }
        public PassengerLocationFlightNumber setOwningAgencyLocationID(String value) { this.OwningAgencyLocationID = value; return this; }
        public String getIataCodes() { return IataCodes; }
        public PassengerLocationFlightNumber setIataCodes(String value) { this.IataCodes = value; return this; }
        public CustomFieldsCollection getCustomFields() { return CustomFields; }
        public PassengerLocationFlightNumber setCustomFields(CustomFieldsCollection value) { this.CustomFields = value; return this; }
        public Date getPnrCreationDate() { return PNRCreationDate; }
        public PassengerLocationFlightNumber setPnrCreationDate(Date value) { this.PNRCreationDate = value; return this; }
        public ArrayList<String> getTicketNumbers() { return TicketNumbers; }
        public PassengerLocationFlightNumber setTicketNumbers(ArrayList<String> value) { this.TicketNumbers = value; return this; }
        public ArrayList<BookingExtVendorLocator> getVendorLocators() { return VendorLocators; }
        public PassengerLocationFlightNumber setVendorLocators(ArrayList<BookingExtVendorLocator> value) { this.VendorLocators = value; return this; }
    }

    public static class CustomFieldsCollection extends ArrayList<CustomFieldData>
    {
        
    }

    @DataContract(Name="CustomField", Namespace="schemas.agentivity.com/types")
    public static class CustomFieldData
    {
        @DataMember(Order=20)
        public String FieldName = null;

        @DataMember(Order=30)
        public String FieldValue = null;
        
        public String getFieldName() { return FieldName; }
        public CustomFieldData setFieldName(String value) { this.FieldName = value; return this; }
        public String getFieldValue() { return FieldValue; }
        public CustomFieldData setFieldValue(String value) { this.FieldValue = 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="PassengerLocationFlightNumber", Namespace="schemas.agentivity.com/types")
    public static class PassengerLocationsByFlightNumberResponseReport extends Report<PassengerLocationsByFlightNumberItemResponse, PassengerLocationFlightNumber>
    {
        
    }

    @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 GetPassengerLocationsByFlightNumber DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /PassengerLocationsByFlightNumber HTTP/1.1 
Host: api.agentivity.com 
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"ResponseMetadata":{"Success":false,"HasCache":false,"HasPaging":false,"CacheMetadata":{"IsFromCache":false,"CachedAt":"\/Date(-62135596800000-0000)\/","CacheExpiresAt":"\/Date(-62135596800000-0000)\/"},"PagingMetadata":{"Offset":"String","Limit":"String","TotalRecords":0,"ResponseRecords":0}},"ResponseReport":{"Item":{"AgentivityRef":0,"RecordLocator":"String","PaxList":"String","OwningConsultantID":"String","Account":"String","DepartureDate":"\/Date(-62135596800000-0000)\/","BoardPoint":"String","OffPoint":"String","DepartureTime":"String","ArrivalTime":"String","ChangeOfDay":"String","EmailAddress":"String","PhoneNbr":"String","OwningAgencyLocationID":"String","IataCodes":"String","CustomFields":[{"FieldName":"String","FieldValue":"String"}],"PNRCreationDate":"\/Date(-62135596800000-0000)\/","TicketNumbers":["String"],"VendorLocators":[{"CarrierCode":"String","VendorLocator":"String"}]}},"ResponseError":{"ErrorCode":"String","Message":"String","StatusCode":"String","VerboseMessage":"String"}}