Agentivity API

<back to all web services

GetPassengerLocationsByCity

using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using AgentivityAPI.ServiceModel.Types;
using AgentivityAPI.ServiceModel.Base;
using AgentivityAPI.ServiceModel;
using AgentivityAPI.ServiceModel.ExtendedModels;

namespace AgentivityAPI.ServiceModel
{
    [DataContract(Name="AgentivityResponse", Namespace="schemas.agentivity.com/types")]
    public partial class CollectionResponse<TItem>
    {
        [DataMember(Order=1)]
        public virtual ResponseMetadata ResponseMetadata { get; set; }

        [DataMember(Order=2, EmitDefaultValue=false)]
        public virtual List<ApiRequestPerHour> ResponseReport { get; set; }

        [DataMember(Order=3, EmitDefaultValue=false)]
        public virtual AgentivityError ResponseError { get; set; }
    }

}

namespace AgentivityAPI.ServiceModel.Base
{
    [DataContract(Namespace="schemas.agentivity.com/types")]
    public partial class CompanyLevelRequestBase
        : PagingMetadata, IMemberUsername, IMemberOwningCompanyCode
    {
        ///<summary>
        ///Comma Delimited List of Owning Company Codes
        ///</summary>
        [DataMember]
        public virtual string[] OwningCompanyCode { get; set; }

        ///<summary>
        ///UserName in form of an email address
        ///</summary>
        [DataMember]
        public virtual string UserName { get; set; }
    }

}

namespace AgentivityAPI.ServiceModel.ExtendedModels
{
    [DataContract(Name="VendorLocator", Namespace="schemas.agentivity.com/types")]
    public partial class BookingExtVendorLocator
        : IBookingIdentifier
    {
        [DataMember(Order=10)]
        public virtual string CarrierCode { get; set; }

        [DataMember(Order=20)]
        public virtual string VendorLocator { get; set; }
    }

}

namespace AgentivityAPI.ServiceModel.Types
{
    [DataContract(Name="ResponseMetadata", Namespace="schemas.agentivity.com/types")]
    public partial class AgentivityError
    {
        [DataMember]
        public virtual string ErrorCode { get; set; }

        [DataMember]
        public virtual string Message { get; set; }

        [DataMember]
        public virtual string StatusCode { get; set; }

        [DataMember]
        public virtual string VerboseMessage { get; set; }
    }

    [DataContract(Name="ApiRequestPerHour", Namespace="schemas.agentivity.com/types")]
    public partial class ApiRequestPerHour
    {
        [DataMember(Order=10)]
        public virtual DateTime RequestDate { get; set; }

        [DataMember(Order=100)]
        public virtual int Hour0 { get; set; }

        [DataMember(Order=110)]
        public virtual int Hour1 { get; set; }

        [DataMember(Order=120)]
        public virtual int Hour2 { get; set; }

        [DataMember(Order=130)]
        public virtual int Hour3 { get; set; }

        [DataMember(Order=140)]
        public virtual int Hour4 { get; set; }

        [DataMember(Order=150)]
        public virtual int Hour5 { get; set; }

        [DataMember(Order=160)]
        public virtual int Hour6 { get; set; }

        [DataMember(Order=170)]
        public virtual int Hour7 { get; set; }

        [DataMember(Order=180)]
        public virtual int Hour8 { get; set; }

        [DataMember(Order=190)]
        public virtual int Hour9 { get; set; }

        [DataMember(Order=200)]
        public virtual int Hour10 { get; set; }

        [DataMember(Order=210)]
        public virtual int Hour11 { get; set; }

        [DataMember(Order=220)]
        public virtual int Hour12 { get; set; }

        [DataMember(Order=230)]
        public virtual int Hour13 { get; set; }

        [DataMember(Order=240)]
        public virtual int Hour14 { get; set; }

        [DataMember(Order=250)]
        public virtual int Hour15 { get; set; }

        [DataMember(Order=260)]
        public virtual int Hour16 { get; set; }

        [DataMember(Order=270)]
        public virtual int Hour17 { get; set; }

        [DataMember(Order=280)]
        public virtual int Hour18 { get; set; }

        [DataMember(Order=290)]
        public virtual int Hour19 { get; set; }

        [DataMember(Order=300)]
        public virtual int Hour20 { get; set; }

        [DataMember(Order=310)]
        public virtual int Hour21 { get; set; }

        [DataMember(Order=320)]
        public virtual int Hour22 { get; set; }

        [DataMember(Order=330)]
        public virtual int Hour23 { get; set; }
    }

    [DataContract(Name="Passenger", Namespace="schemas.agentivity.com/types")]
    public partial class BookingPassengerModel
    {
        [DataMember(Order=10)]
        public virtual string FirstName { get; set; }

        [DataMember(Order=20)]
        public virtual string LastName { get; set; }

        [DataMember(Order=30)]
        public virtual int PassengerDataId { get; set; }
    }

    [DataContract(Name="CacheMetadata", Namespace="schemas.agentivity.com/types")]
    public partial class CacheMetadata
    {
        [DataMember(Order=1)]
        public virtual DateTime CachedAt { get; set; }

        [DataMember(Order=2)]
        public virtual DateTime CacheExpiresAt { get; set; }

        [DataMember(Order=0)]
        public virtual bool IsFromCache { get; set; }
    }

    [DataContract(Name="CustomField", Namespace="schemas.agentivity.com/types")]
    public partial class CustomFieldData
    {
        [DataMember(Order=20)]
        public virtual string FieldName { get; set; }

        [DataMember(Order=30)]
        public virtual string FieldValue { get; set; }
    }

    public partial class CustomFieldsCollection
        : List<CustomFieldData>
    {
    }

    [DataContract(Namespace="schemas.agentivity.com/types")]
    public partial class GetPassengerLocationsByCity
        : CompanyLevelRequestBase, IRepeatByPassenger
    {
        ///<summary>
        ///3 letter city code
        ///</summary>
        [DataMember]
        public virtual string CityCode { get; set; }

        ///<summary>
        ///Date in format YYYYMMDD
        ///</summary>
        [DataMember]
        public virtual string DateEnd { get; set; }

        ///<summary>
        ///Date in format YYYYMMDD
        ///</summary>
        [DataMember]
        public virtual string DateStart { get; set; }

        ///<summary>
        ///Include passengers that are in transit only in response
        ///</summary>
        [DataMember]
        public virtual bool? InTransitOnly { get; set; }

        ///<summary>
        ///Comma Delimited List of Accounts
        ///</summary>
        [DataMember]
        public virtual string[] Account { get; set; }

        ///<summary>
        ///Include items with hotel in response
        ///</summary>
        [DataMember]
        public virtual bool? WithHotel { get; set; }

        ///<summary>
        ///Name of the hotel
        ///</summary>
        [DataMember]
        public virtual string HotelName { get; set; }

        ///<summary>
        ///Comma Delimited List of Custom Fields
        ///</summary>
        [DataMember]
        public virtual string[] CustomField { get; set; }

        ///<summary>
        ///Option to place passenger names on separate lines in the downloadable result (spreadsheet)
        ///</summary>
        [DataMember]
        public virtual bool RepeatByPassenger { get; set; }
    }

    [DataContract(Name="ItinerarySegment", Namespace="schemas.agentivity.com/types")]
    public partial class ItinerarySegment
    {
        [DataMember]
        public virtual string SegmentType { get; set; }

        [DataMember]
        public virtual int SegmentNbr { get; set; }

        [DataMember]
        public virtual string BoardPoint { get; set; }

        [DataMember]
        public virtual string OffPoint { get; set; }

        [DataMember]
        public virtual string OperatorCode { get; set; }

        [DataMember]
        public virtual string OperatorService { get; set; }

        [DataMember]
        public virtual string SegmentStatus { get; set; }

        [DataMember]
        public virtual string DepartureTimeFormatted { get; set; }

        [DataMember]
        public virtual string ArrivalTimeFormatted { get; set; }

        [DataMember]
        public virtual string ChangeOfDayFormatted { get; set; }

        [DataMember]
        public virtual string ServiceCode { get; set; }

        [DataMember]
        public virtual string StartDate { get; set; }

        [DataMember]
        public virtual string EndDate { get; set; }

        [DataMember]
        public virtual string TicketNumber { get; set; }

        ///<summary>
        ///Comma separated list of vendor locators
        ///</summary>
        [DataMember]
        public virtual string VendorLocators { get; set; }

        [DataMember]
        public virtual string EquipmentCode { get; set; }

        [DataMember]
        public virtual string Equipment { get; set; }
    }

    public partial class ItinerarySegmentsCollection
        : List<ItinerarySegment>
    {
    }

    [DataContract(Name="Metadata", Namespace="schemas.agentivity.com/types")]
    public partial class PagingMetadata
    {
        ///<summary>
        ///Starting Record
        ///</summary>
        [DataMember]
        [ApiMember(DataType="string", Description="Starting Record", Name="Offset", ParameterType="query")]
        public virtual string Offset { get; set; }

        ///<summary>
        ///Number of records to return (PageSize)
        ///</summary>
        [DataMember]
        [ApiMember(DataType="string", Description="Number of records to return (PageSize)", Name="Limit", ParameterType="query")]
        public virtual string Limit { get; set; }

        ///<summary>
        ///Total Number of Records in a Full Reponse (if no paging)
        ///</summary>
        [DataMember]
        [ApiMember(DataType="string", Description="Total Number of Records in a Full Reponse (if no paging)", Name="TotalRecords", ParameterType="query")]
        public virtual int TotalRecords { get; set; }

        ///<summary>
        ///Total Number of Records in this Reponse (on this page)
        ///</summary>
        [DataMember]
        [ApiMember(DataType="string", Description="Total Number of Records in this Reponse (on this page)", Name="ResponseRecords", ParameterType="query")]
        public virtual int ResponseRecords { get; set; }
    }

    [DataContract(Name="Segment", Namespace="schemas.agentivity.com/types")]
    public partial class PassengerLocation
        : IBookingItinerary, IBookingCustomFields, IBookingIdentifier, ITicketNumbers, IVendorLocators, IPassengerInfo
    {
        [DataMember(Order=1)]
        public virtual string RecordLocator { get; set; }

        [DataMember(Order=2)]
        public virtual DateTime? TravelDate { get; set; }

        [DataMember(Order=3)]
        public virtual DateTime? DepartureDate { get; set; }

        [DataMember(Order=4)]
        public virtual string BoardPoint { get; set; }

        [DataMember(Order=5)]
        public virtual string OffPoint { get; set; }

        [DataMember(Order=6)]
        public virtual string PnrTicketed { get; set; }

        [DataMember(Order=7)]
        public virtual string Account { get; set; }

        [DataMember(Order=8)]
        public virtual string Consultant { get; set; }

        [DataMember(Order=9)]
        public virtual string PaxList { get; set; }

        [DataMember(Order=10)]
        public virtual string PhoneNbr { get; set; }

        [DataMember(Order=11)]
        public virtual string EmailAddress { get; set; }

        [DataMember(Order=12)]
        public virtual string DestinationCities { get; set; }

        [DataMember(Order=13)]
        public virtual string Connections { get; set; }

        [DataMember(Order=14)]
        public virtual string CarrierCodes { get; set; }

        [DataMember(Order=16)]
        public virtual string HotelsNames { get; set; }

        [DataMember(Order=30)]
        public virtual string FlightNumbers { get; set; }

        [DataMember(Order=40)]
        public virtual string OwningAgencyLocationID { get; set; }

        [DataMember(Order=50)]
        public virtual string IataCodes { get; set; }

        [DataMember(Order=15)]
        public virtual int AgentivityRef { get; set; }

        [DataMember(Order=120)]
        public virtual ItinerarySegmentsCollection Itinerary { get; set; }

        [DataMember(Order=130)]
        public virtual string ItineraryFormatted { get; set; }

        [DataMember(Order=140)]
        public virtual CustomFieldsCollection CustomFields { get; set; }

        [DataMember(Order=150)]
        public virtual DateTime? DepartureDateTime { get; set; }

        [DataMember(Order=160)]
        public virtual DateTime? CurrentArrivalDateTime { get; set; }

        [DataMember(Order=170)]
        public virtual string SegmentType { get; set; }

        [DataMember(Order=180)]
        public virtual string AirSegmentNbr { get; set; }

        [DataMember(Order=190)]
        public virtual DateTime? PNRCreationDate { get; set; }

        [DataMember(Order=200)]
        public virtual string[] TicketNumbers { get; set; }

        [DataMember(Order=210)]
        public virtual BookingExtVendorLocator[] VendorLocators { get; set; }

        [DataMember(Order=220)]
        public virtual BookingPassengerModel[] PassengerInfo { get; set; }
    }

    [DataContract(Name="AgentivityResponse", Namespace="schemas.agentivity.com/types")]
    public partial class PassengerLocationsByCityResponse
        : CollectionResponse<PassengerLocation>
    {
    }

    [DataContract(Name="ResponseMetadata", Namespace="schemas.agentivity.com/types")]
    public partial class ResponseMetadata
    {
        [DataMember(Order=0)]
        public virtual bool Success { get; set; }

        [DataMember(Order=1)]
        public virtual bool HasCache { get; set; }

        [DataMember(Order=2)]
        public virtual bool HasPaging { get; set; }

        [DataMember(Order=3, EmitDefaultValue=false)]
        public virtual CacheMetadata CacheMetadata { get; set; }

        [DataMember(Order=4, EmitDefaultValue=false)]
        public virtual PagingMetadata PagingMetadata { get; set; }
    }

}

C# GetPassengerLocationsByCity DTOs

GET /PassengerLocationsByCity HTTP/1.1 
Host: api.agentivity.com 
Accept: application/xml

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>
    <Segment>
      <RecordLocator>String</RecordLocator>
      <TravelDate>0001-01-01T00:00:00</TravelDate>
      <DepartureDate>0001-01-01T00:00:00</DepartureDate>
      <BoardPoint>String</BoardPoint>
      <OffPoint>String</OffPoint>
      <PnrTicketed>String</PnrTicketed>
      <Account>String</Account>
      <Consultant>String</Consultant>
      <PaxList>String</PaxList>
      <PhoneNbr>String</PhoneNbr>
      <EmailAddress>String</EmailAddress>
      <DestinationCities>String</DestinationCities>
      <Connections>String</Connections>
      <CarrierCodes>String</CarrierCodes>
      <AgentivityRef>0</AgentivityRef>
      <HotelsNames>String</HotelsNames>
      <FlightNumbers>String</FlightNumbers>
      <OwningAgencyLocationID>String</OwningAgencyLocationID>
      <IataCodes>String</IataCodes>
      <Itinerary>
        <ItinerarySegment>
          <ArrivalTimeFormatted>String</ArrivalTimeFormatted>
          <BoardPoint>String</BoardPoint>
          <ChangeOfDayFormatted>String</ChangeOfDayFormatted>
          <DepartureTimeFormatted>String</DepartureTimeFormatted>
          <EndDate>String</EndDate>
          <Equipment>String</Equipment>
          <EquipmentCode>String</EquipmentCode>
          <OffPoint>String</OffPoint>
          <OperatorCode>String</OperatorCode>
          <OperatorService>String</OperatorService>
          <SegmentNbr>0</SegmentNbr>
          <SegmentStatus>String</SegmentStatus>
          <SegmentType>String</SegmentType>
          <ServiceCode>String</ServiceCode>
          <StartDate>String</StartDate>
          <TicketNumber>String</TicketNumber>
          <VendorLocators>String</VendorLocators>
        </ItinerarySegment>
      </Itinerary>
      <ItineraryFormatted>String</ItineraryFormatted>
      <CustomFields>
        <CustomField>
          <FieldName>String</FieldName>
          <FieldValue>String</FieldValue>
        </CustomField>
      </CustomFields>
      <DepartureDateTime>0001-01-01T00:00:00</DepartureDateTime>
      <CurrentArrivalDateTime>0001-01-01T00:00:00</CurrentArrivalDateTime>
      <SegmentType>String</SegmentType>
      <AirSegmentNbr>String</AirSegmentNbr>
      <PNRCreationDate>0001-01-01T00:00:00</PNRCreationDate>
      <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>
      <PassengerInfo>
        <Passenger>
          <FirstName>String</FirstName>
          <LastName>String</LastName>
          <PassengerDataId>0</PassengerDataId>
          <Tickets>
            <Ticket>
              <Number>String</Number>
              <Type>String</Type>
            </Ticket>
          </Tickets>
        </Passenger>
      </PassengerInfo>
    </Segment>
  </ResponseReport>
  <ResponseError>
    <ErrorCode>String</ErrorCode>
    <Message>String</Message>
    <StatusCode>String</StatusCode>
    <VerboseMessage>String</VerboseMessage>
  </ResponseError>
</AgentivityResponse>