Agentivity API

<back to all web services

GetPassengerDepartures

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;

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

        [DataMember(Order=2, EmitDefaultValue=false)]
        public virtual TReport ResponseReport { get; set; }

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

    [DataContract(Namespace="schemas.agentivity.com/types")]
    public partial class Report<TItemResponse, TItem>
    {
        [DataMember(Order=1, EmitDefaultValue=false)]
        public virtual TItem Item { 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.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="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; }
    }

    [Flags]
    public enum FormattingStyle
    {
        None = 0,
        Html = 1,
        Charting = 2,
    }

    [DataContract(Namespace="schemas.agentivity.com/types")]
    public partial class GetPassengerDepartures
        : CompanyLevelRequestBase
    {
        ///<summary>
        ///Comma Delimited List of Accounts
        ///</summary>
        [DataMember]
        public virtual string[] Account { get; set; }

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

        ///<summary>
        ///Carrier name
        ///</summary>
        [DataMember]
        public virtual string[] Carrier { get; set; }

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

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

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

        ///<summary>
        ///Add transfers
        ///</summary>
        [DataMember]
        public virtual bool AddVouchers { get; set; }

        ///<summary>
        ///Add transfers
        ///</summary>
        [DataMember]
        public virtual bool AddTransfers { get; set; }

        ///<summary>
        ///Include Itinerary in the response
        ///</summary>
        [DataMember]
        public virtual bool IncludeItinerary { get; set; }

        ///<summary>
        ///Return only PNRs that are or are not flagged as VIP bookings
        ///</summary>
        [DataMember]
        public virtual bool? IsVip { get; set; }

        ///<summary>
        ///Show SMS
        ///</summary>
        [DataMember]
        public virtual bool ShowSMS { get; set; }

        ///<summary>
        ///Indicates the required formatting: 0=None(Default); 1= Html; 2 = Chart
        ///</summary>
        [DataMember]
        public virtual FormattingStyle ItineraryFormatting { 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="PassengerDeparture", Namespace="schemas.agentivity.com/types")]
    public partial class PassengerDeparture
        : IBookingItinerary
    {
        [DataMember(Order=10)]
        public virtual int AgentivityRef { get; set; }

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

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

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

        [DataMember(Order=35)]
        public virtual string OwningConsultantID { get; set; }

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

        [DataMember(Order=45)]
        public virtual string Passenger { get; set; }

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

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

        [DataMember(Order=70)]
        public virtual string TicketedStatusCode { get; set; }

        [DataMember(Order=75)]
        public virtual string TicketedStatus { get; set; }

        [DataMember(Order=80)]
        public virtual string SupplierReference { get; set; }

        [DataMember(Order=85)]
        public virtual string SMS { get; set; }

        [DataMember(Order=90)]
        public virtual string Vouchers { get; set; }

        [DataMember(Order=100)]
        public virtual string Transfers { get; set; }

        [DataMember(Order=110)]
        public virtual bool IsVip { get; set; }

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

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

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

        [DataMember(Order=150)]
        public virtual string DestinationCountries { get; set; }

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

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

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

    [DataContract(Name="AgentivityResponse", Namespace="schemas.agentivity.com/types")]
    public partial class PassengerDeparturesItemResponse
        : ItemResponse<PassengerDeparture, PassengerDeparturesResponseReport>
    {
    }

    [DataContract(Name="PassengerDeparture", Namespace="schemas.agentivity.com/types")]
    public partial class PassengerDeparturesResponseReport
        : Report<PassengerDeparturesItemResponse, PassengerDeparture>
    {
    }

    [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# GetPassengerDepartures DTOs

GET /PassengerDepartures 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>
    <Item>
      <AgentivityRef>0</AgentivityRef>
      <RecordLocator>String</RecordLocator>
      <OwningAgencyLocationID>String</OwningAgencyLocationID>
      <OwningConsultant>String</OwningConsultant>
      <OwningConsultantID>String</OwningConsultantID>
      <GdsCode>String</GdsCode>
      <Passenger>String</Passenger>
      <Account>String</Account>
      <TravelDate>0001-01-01T00:00:00</TravelDate>
      <TicketedStatusCode>String</TicketedStatusCode>
      <TicketedStatus>String</TicketedStatus>
      <SupplierReference>String</SupplierReference>
      <SMS>String</SMS>
      <Vouchers>String</Vouchers>
      <Transfers>String</Transfers>
      <IsVip>false</IsVip>
      <PhoneNbr>String</PhoneNbr>
      <EmailAddress>String</EmailAddress>
      <DestinationCities>String</DestinationCities>
      <DestinationCountries>String</DestinationCountries>
      <Connections>String</Connections>
      <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>
    </Item>
  </ResponseReport>
  <ResponseError>
    <ErrorCode>String</ErrorCode>
    <Message>String</Message>
    <StatusCode>String</StatusCode>
    <VerboseMessage>String</VerboseMessage>
  </ResponseError>
</AgentivityResponse>