Agentivity API

<back to all web services

GetPassengerLocationsByCity

The following routes are available for this service:
GET/PassengerLocationsByCity

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

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

    /** @description 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 TotalRecords: number;

    /** @description 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 ResponseRecords: number;

    public constructor(init?: Partial<PagingMetadata>) { (Object as any).assign(this, init); }
}

// @DataContract(Namespace="schemas.agentivity.com/types")
export class CompanyLevelRequestBase extends PagingMetadata implements IMemberUsername, IMemberOwningCompanyCode
{
    /** @description Comma Delimited List of Owning Company Codes */
    // @DataMember
    public OwningCompanyCode: string[];

    /** @description UserName in form of an email address */
    // @DataMember
    public UserName: string;

    public constructor(init?: Partial<CompanyLevelRequestBase>) { super(init); (Object as any).assign(this, init); }
}

// @DataContract(Name="ItinerarySegment", Namespace="schemas.agentivity.com/types")
export class ItinerarySegment
{
    // @DataMember
    public SegmentType: string;

    // @DataMember
    public SegmentNbr: number;

    // @DataMember
    public BoardPoint: string;

    // @DataMember
    public OffPoint: string;

    // @DataMember
    public OperatorCode: string;

    // @DataMember
    public OperatorService: string;

    // @DataMember
    public SegmentStatus: string;

    // @DataMember
    public DepartureTimeFormatted: string;

    // @DataMember
    public ArrivalTimeFormatted: string;

    // @DataMember
    public ChangeOfDayFormatted: string;

    // @DataMember
    public ServiceCode: string;

    // @DataMember
    public StartDate: string;

    // @DataMember
    public EndDate: string;

    // @DataMember
    public TicketNumber: string;

    /** @description Comma separated list of vendor locators */
    // @DataMember
    public VendorLocators: string;

    // @DataMember
    public EquipmentCode: string;

    // @DataMember
    public Equipment: string;

    public constructor(init?: Partial<ItinerarySegment>) { (Object as any).assign(this, init); }
}

export class ItinerarySegmentsCollection extends Array<ItinerarySegment>
{

    public constructor(init?: Partial<ItinerarySegmentsCollection>) { super(); (Object as any).assign(this, init); }
}

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

    // @DataMember(Order=30)
    public FieldValue: string;

    public constructor(init?: Partial<CustomFieldData>) { (Object as any).assign(this, init); }
}

export class CustomFieldsCollection extends Array<CustomFieldData>
{

    public constructor(init?: Partial<CustomFieldsCollection>) { super(); (Object as any).assign(this, init); }
}

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

    // @DataMember(Order=20)
    public VendorLocator: string;

    public constructor(init?: Partial<BookingExtVendorLocator>) { (Object as any).assign(this, init); }
}

// @DataContract(Name="Passenger", Namespace="schemas.agentivity.com/types")
export class BookingPassengerModel
{
    // @DataMember(Order=10)
    public FirstName: string;

    // @DataMember(Order=20)
    public LastName: string;

    // @DataMember(Order=30)
    public PassengerDataId: number;

    public constructor(init?: Partial<BookingPassengerModel>) { (Object as any).assign(this, init); }
}

// @DataContract(Name="Segment", Namespace="schemas.agentivity.com/types")
export class PassengerLocation implements IBookingItinerary, IBookingCustomFields, IBookingIdentifier, ITicketNumbers, IVendorLocators, IPassengerInfo
{
    // @DataMember(Order=1)
    public RecordLocator: string;

    // @DataMember(Order=2)
    public TravelDate?: string;

    // @DataMember(Order=3)
    public DepartureDate?: string;

    // @DataMember(Order=4)
    public BoardPoint: string;

    // @DataMember(Order=5)
    public OffPoint: string;

    // @DataMember(Order=6)
    public PnrTicketed: string;

    // @DataMember(Order=7)
    public Account: string;

    // @DataMember(Order=8)
    public Consultant: string;

    // @DataMember(Order=9)
    public PaxList: string;

    // @DataMember(Order=10)
    public PhoneNbr: string;

    // @DataMember(Order=11)
    public EmailAddress: string;

    // @DataMember(Order=12)
    public DestinationCities: string;

    // @DataMember(Order=13)
    public Connections: string;

    // @DataMember(Order=14)
    public CarrierCodes: string;

    // @DataMember(Order=16)
    public HotelsNames: string;

    // @DataMember(Order=30)
    public FlightNumbers: string;

    // @DataMember(Order=40)
    public OwningAgencyLocationID: string;

    // @DataMember(Order=50)
    public IataCodes: string;

    // @DataMember(Order=15)
    public AgentivityRef: number;

    // @DataMember(Order=120)
    public Itinerary: ItinerarySegmentsCollection;

    // @DataMember(Order=130)
    public ItineraryFormatted: string;

    // @DataMember(Order=140)
    public CustomFields: CustomFieldsCollection;

    // @DataMember(Order=150)
    public DepartureDateTime?: string;

    // @DataMember(Order=160)
    public CurrentArrivalDateTime?: string;

    // @DataMember(Order=170)
    public SegmentType: string;

    // @DataMember(Order=180)
    public AirSegmentNbr: string;

    // @DataMember(Order=190)
    public PNRCreationDate?: string;

    // @DataMember(Order=200)
    public TicketNumbers: string[];

    // @DataMember(Order=210)
    public VendorLocators: BookingExtVendorLocator[];

    // @DataMember(Order=220)
    public PassengerInfo: BookingPassengerModel[];

    public constructor(init?: Partial<PassengerLocation>) { (Object as any).assign(this, init); }
}

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

    // @DataMember(Order=2)
    public CacheExpiresAt: string;

    // @DataMember(Order=0)
    public IsFromCache: boolean;

    public constructor(init?: Partial<CacheMetadata>) { (Object as any).assign(this, init); }
}

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

    // @DataMember(Order=1)
    public HasCache: boolean;

    // @DataMember(Order=2)
    public HasPaging: boolean;

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

    // @DataMember(Order=4, EmitDefaultValue=false)
    public PagingMetadata: PagingMetadata;

    public constructor(init?: Partial<ResponseMetadata>) { (Object as any).assign(this, init); }
}

// @DataContract(Name="ApiRequestPerHour", Namespace="schemas.agentivity.com/types")
export class ApiRequestPerHour
{
    // @DataMember(Order=10)
    public RequestDate: string;

    // @DataMember(Order=100)
    public Hour0: number;

    // @DataMember(Order=110)
    public Hour1: number;

    // @DataMember(Order=120)
    public Hour2: number;

    // @DataMember(Order=130)
    public Hour3: number;

    // @DataMember(Order=140)
    public Hour4: number;

    // @DataMember(Order=150)
    public Hour5: number;

    // @DataMember(Order=160)
    public Hour6: number;

    // @DataMember(Order=170)
    public Hour7: number;

    // @DataMember(Order=180)
    public Hour8: number;

    // @DataMember(Order=190)
    public Hour9: number;

    // @DataMember(Order=200)
    public Hour10: number;

    // @DataMember(Order=210)
    public Hour11: number;

    // @DataMember(Order=220)
    public Hour12: number;

    // @DataMember(Order=230)
    public Hour13: number;

    // @DataMember(Order=240)
    public Hour14: number;

    // @DataMember(Order=250)
    public Hour15: number;

    // @DataMember(Order=260)
    public Hour16: number;

    // @DataMember(Order=270)
    public Hour17: number;

    // @DataMember(Order=280)
    public Hour18: number;

    // @DataMember(Order=290)
    public Hour19: number;

    // @DataMember(Order=300)
    public Hour20: number;

    // @DataMember(Order=310)
    public Hour21: number;

    // @DataMember(Order=320)
    public Hour22: number;

    // @DataMember(Order=330)
    public Hour23: number;

    public constructor(init?: Partial<ApiRequestPerHour>) { (Object as any).assign(this, init); }
}

// @DataContract(Name="ResponseMetadata", Namespace="schemas.agentivity.com/types")
export class AgentivityError
{
    // @DataMember
    public ErrorCode: string;

    // @DataMember
    public Message: string;

    // @DataMember
    public StatusCode: string;

    // @DataMember
    public VerboseMessage: string;

    public constructor(init?: Partial<AgentivityError>) { (Object as any).assign(this, init); }
}

// @DataContract(Name="AgentivityResponse", Namespace="schemas.agentivity.com/types")
export class CollectionResponse<TItem>
{
    // @DataMember(Order=1)
    public ResponseMetadata: ResponseMetadata;

    // @DataMember(Order=2, EmitDefaultValue=false)
    public ResponseReport: ApiRequestPerHour[];

    // @DataMember(Order=3, EmitDefaultValue=false)
    public ResponseError: AgentivityError;

    public constructor(init?: Partial<CollectionResponse<TItem>>) { (Object as any).assign(this, init); }
}

// @DataContract(Name="AgentivityResponse", Namespace="schemas.agentivity.com/types")
export class PassengerLocationsByCityResponse extends CollectionResponse<PassengerLocation>
{

    public constructor(init?: Partial<PassengerLocationsByCityResponse>) { super(init); (Object as any).assign(this, init); }
}

// @DataContract(Namespace="schemas.agentivity.com/types")
export class GetPassengerLocationsByCity extends CompanyLevelRequestBase implements IRepeatByPassenger
{
    /** @description 3 letter city code */
    // @DataMember
    public CityCode: string;

    /** @description Date in format YYYYMMDD */
    // @DataMember
    public DateEnd: string;

    /** @description Date in format YYYYMMDD */
    // @DataMember
    public DateStart: string;

    /** @description Include passengers that are in transit only in response */
    // @DataMember
    public InTransitOnly?: boolean;

    /** @description Comma Delimited List of Accounts */
    // @DataMember
    public Account: string[];

    /** @description Include items with hotel in response */
    // @DataMember
    public WithHotel?: boolean;

    /** @description Name of the hotel */
    // @DataMember
    public HotelName: string;

    /** @description Comma Delimited List of Custom Fields */
    // @DataMember
    public CustomField: string[];

    /** @description Option to place passenger names on separate lines in the downloadable result (spreadsheet) */
    // @DataMember
    public RepeatByPassenger: boolean;

    public constructor(init?: Partial<GetPassengerLocationsByCity>) { super(init); (Object as any).assign(this, init); }
}

TypeScript GetPassengerLocationsByCity DTOs

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

HTTP + CSV

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

GET /PassengerLocationsByCity HTTP/1.1 
Host: api.agentivity.com 
Accept: text/csv

HTTP/1.1 200 OK
Content-Type: text/csv
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":[{"RecordLocator":"String","TravelDate":"\/Date(-62135596800000-0000)\/","DepartureDate":"\/Date(-62135596800000-0000)\/","BoardPoint":"String","OffPoint":"String","PnrTicketed":"String","Account":"String","Consultant":"String","PaxList":"String","PhoneNbr":"String","EmailAddress":"String","DestinationCities":"String","Connections":"String","CarrierCodes":"String","AgentivityRef":0,"HotelsNames":"String","FlightNumbers":"String","OwningAgencyLocationID":"String","IataCodes":"String","Itinerary":[{"SegmentType":"String","SegmentNbr":0,"BoardPoint":"String","OffPoint":"String","OperatorCode":"String","OperatorService":"String","SegmentStatus":"String","DepartureTimeFormatted":"String","ArrivalTimeFormatted":"String","ChangeOfDayFormatted":"String","ServiceCode":"String","StartDate":"String","EndDate":"String","TicketNumber":"String","VendorLocators":"String","EquipmentCode":"String","Equipment":"String"}],"ItineraryFormatted":"String","CustomFields":[{"FieldName":"String","FieldValue":"String"}],"DepartureDateTime":"\/Date(-62135596800000-0000)\/","CurrentArrivalDateTime":"\/Date(-62135596800000-0000)\/","SegmentType":"String","AirSegmentNbr":"String","PNRCreationDate":"\/Date(-62135596800000-0000)\/","TicketNumbers":["String"],"VendorLocators":[{"CarrierCode":"String","VendorLocator":"String"}],"PassengerInfo":[{"FirstName":"String","LastName":"String","PassengerDataId":0,"Tickets":[{"Number":"String","Type":"String"}]}]}],"ResponseError":{"ErrorCode":"String","Message":"String","StatusCode":"String","VerboseMessage":"String"}}