Agentivity API

GetConsultantFocus

The following routes are available for this service:
All Verbs	/ConsultantFocus

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 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.Types
{
    [DataContract(Name="ActiveUnsoldAirBookings", Namespace="schemas.agentivity.com/types")]
    public partial class ActiveUnsoldAirBookings
        : IBookingItinerary
    {
        [DataMember(Order=10)]
        public virtual string RecordLocator { get; set; }

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

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

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

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

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

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

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

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

        [DataMember(Order=110)]
        public virtual string FiledFare { get; set; }

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

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

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

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

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

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

    [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="AirlineDemandsForTicketing", Namespace="schemas.agentivity.com/types")]
    public partial class AirlineDemandsForTicketing
    {
        [DataMember(Order=10)]
        public virtual string RecordLocator { get; set; }

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

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

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

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

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

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

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

        [DataMember(Order=60)]
        public virtual string DueTime { get; set; }

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

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

        [DataMember(Order=90)]
        public virtual int? AgentivityRef { 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="Warning", Namespace="schemas.agentivity.com/types")]
    public partial class BookingWarning
    {
        [DataMember(Order=10)]
        public virtual string WarningType { get; set; }

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

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

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

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

        [DataMember(Order=60)]
        public virtual string OriginalRemark { get; set; }

        [DataMember(Order=70)]
        public virtual List<BookingWarningProperty> PropertiesList { get; set; }
    }

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

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

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

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

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

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

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

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

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

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

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

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

        [DataMember(Order=1000)]
        public virtual List<BookingWarning> WarningsList { 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 ConsultantFocusOptions
    {
        Default = 0,
        ProblematicSegments = 1,
        AirlineDemandsForTicketing = 2,
        Standard = 3,
        ActiveUnsoldAirBookings = 4,
        BookingsWithWarnings = 8,
        All = 15,
    }

    [DataContract(Name="ConsultantFocusResult", Namespace="schemas.agentivity.com/types")]
    public partial class ConsultantFocusResult
    {
        [DataMember(Order=10)]
        public virtual List<ProblematicSegment> ProblematicSegments { get; set; }

        [DataMember(Order=20)]
        public virtual List<AirlineDemandsForTicketing> AirlineDemandsForTicketing { get; set; }

        [DataMember(Order=30)]
        public virtual List<ActiveUnsoldAirBookings> ActiveUnsoldAirBookings { get; set; }

        [DataMember(Order=40)]
        public virtual List<BookingWithWarnings> BookingsWithWarnings { get; set; }
    }

    [DataContract(Namespace="schemas.agentivity.com/types")]
    public partial class GetConsultantFocus
        : CompanyLevelRequestBase, IRequestConsultantID
    {
        ///<summary>
        ///Date in format YYYYMMDD
        ///</summary>
        [DataMember]
        public virtual string DateStart { get; set; }

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

        ///<summary>
        ///Comma delimited list of owning consultants ids
        ///</summary>
        [DataMember]
        public virtual string[] OwningConsultantID { get; set; } = [];

        ///<summary>
        ///Comma delimited list of transaction agency location ids
        ///</summary>
        [DataMember]
        public virtual string[] TransactionAgencyLocationID { get; set; }

        ///<summary>
        ///Options to retrieve consultant focus data. Use All to include the Active Unsold Air Bookings.
        ///</summary>
        [DataMember]
        public virtual ConsultantFocusOptions Options { get; set; }

        ///<summary>
        ///Request Consultant ID (sign on)
        ///</summary>
        [DataMember]
        public virtual string RequestConsultantID { get; set; }
    }

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

    [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="ProblematicSegment", Namespace="schemas.agentivity.com/types")]
    public partial class ProblematicSegment
    {
        [DataMember(Order=10)]
        public virtual string RecordLocator { get; set; }

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

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

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

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

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

        [DataMember(Order=60)]
        public virtual string SegmentStatus { get; set; }

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

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

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

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

        [DataMember(Order=110)]
        public virtual string AgentivityRef { get; set; }
    }

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

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

HTTP + XML

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

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

<GetConsultantFocus 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>
  <DateEnd>String</DateEnd>
  <DateStart>String</DateStart>
  <Options>Default</Options>
  <OwningConsultantID xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </OwningConsultantID>
  <RequestConsultantID>String</RequestConsultantID>
  <TransactionAgencyLocationID xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </TransactionAgencyLocationID>
</GetConsultantFocus>

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>
    <ConsultantFocusResult>
      <ProblematicSegments>
        <ProblematicSegment>
          <RecordLocator>String</RecordLocator>
          <PNRCreationDate>0001-01-01T00:00:00</PNRCreationDate>
          <OwningConsultantID>String</OwningConsultantID>
          <OwningConsultant>String</OwningConsultant>
          <PrimaryPax>String</PrimaryPax>
          <Account>String</Account>
          <SegmentStatus>String</SegmentStatus>
          <Segment>String</Segment>
          <OwningAgencyLocationID>String</OwningAgencyLocationID>
          <GdsCode>String</GdsCode>
          <DepartureDate>0001-01-01T00:00:00</DepartureDate>
          <AgentivityRef>String</AgentivityRef>
        </ProblematicSegment>
      </ProblematicSegments>
      <AirlineDemandsForTicketing>
        <AirlineDemandsForTicketing>
          <RecordLocator>String</RecordLocator>
          <PNRCreationDate>0001-01-01T00:00:00</PNRCreationDate>
          <PrimaryPax>String</PrimaryPax>
          <OwningConsultantID>String</OwningConsultantID>
          <OwningConsultant>String</OwningConsultant>
          <Account>String</Account>
          <AirlineCode>String</AirlineCode>
          <DueDate>0001-01-01T00:00:00</DueDate>
          <DueTime>String</DueTime>
          <OwningAgencyLocationID>String</OwningAgencyLocationID>
          <GdsCode>String</GdsCode>
          <AgentivityRef>0</AgentivityRef>
        </AirlineDemandsForTicketing>
      </AirlineDemandsForTicketing>
      <ActiveUnsoldAirBookings>
        <ActiveUnsoldAirBookings>
          <RecordLocator>String</RecordLocator>
          <PNRCreationDate>0001-01-01T00:00:00</PNRCreationDate>
          <OwningAgencyLocationID>String</OwningAgencyLocationID>
          <GdsCode>String</GdsCode>
          <PrimaryPax>String</PrimaryPax>
          <OwningConsultant>String</OwningConsultant>
          <OwningConsultantID>String</OwningConsultantID>
          <Account>String</Account>
          <AgentivityRef>0</AgentivityRef>
          <PrimaryCarrierCode>String</PrimaryCarrierCode>
          <FiledFare>String</FiledFare>
          <TravelDate>0001-01-01T00:00:00</TravelDate>
          <DestinationCities>String</DestinationCities>
          <BookingClasses>String</BookingClasses>
          <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>
        </ActiveUnsoldAirBookings>
      </ActiveUnsoldAirBookings>
      <BookingsWithWarnings>
        <BookingWithWarnings>
          <RecordLocator>String</RecordLocator>
          <PNRCreationDate>0001-01-01T00:00:00</PNRCreationDate>
          <AgentivityRef>0</AgentivityRef>
          <OwningConsultant>String</OwningConsultant>
          <Account>String</Account>
          <OwningConsultantID>String</OwningConsultantID>
          <OwningAgencyLocationID>String</OwningAgencyLocationID>
          <GdsCode>String</GdsCode>
          <TravelDate>0001-01-01T00:00:00</TravelDate>
          <PrimaryPax>String</PrimaryPax>
          <WarningsList>
            <Warning>
              <WarningType>String</WarningType>
              <Vendor>String</Vendor>
              <VendorType>String</VendorType>
              <WarningDateTime>0001-01-01T00:00:00</WarningDateTime>
              <LogDateTime>0001-01-01T00:00:00</LogDateTime>
              <OriginalRemark>String</OriginalRemark>
              <PropertiesList>
                <Property>
                  <Name>String</Name>
                  <Value>String</Value>
                </Property>
              </PropertiesList>
            </Warning>
          </WarningsList>
        </BookingWithWarnings>
      </BookingsWithWarnings>
    </ConsultantFocusResult>
  </ResponseReport>
  <ResponseError>
    <ErrorCode>String</ErrorCode>
    <Message>String</Message>
    <StatusCode>String</StatusCode>
    <VerboseMessage>String</VerboseMessage>
  </ResponseError>
</AgentivityResponse>