| 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; }
}
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other
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: text/jsonl
Content-Type: text/jsonl
Content-Length: length
{"DateStart":"String","DateEnd":"String","OwningConsultantID":["String"],"TransactionAgencyLocationID":["String"],"Options":0,"RequestConsultantID":"String","OwningCompanyCode":["String"],"UserName":"String","Offset":"String","Limit":"String","TotalRecords":0,"ResponseRecords":0}
HTTP/1.1 200 OK
Content-Type: text/jsonl
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":[{"ProblematicSegments":[{"RecordLocator":"String","PNRCreationDate":"\/Date(-62135596800000-0000)\/","OwningConsultantID":"String","OwningConsultant":"String","PrimaryPax":"String","Account":"String","SegmentStatus":"String","Segment":"String","OwningAgencyLocationID":"String","GdsCode":"String","DepartureDate":"\/Date(-62135596800000-0000)\/","AgentivityRef":"String"}],"AirlineDemandsForTicketing":[{"RecordLocator":"String","PNRCreationDate":"\/Date(-62135596800000-0000)\/","PrimaryPax":"String","OwningConsultantID":"String","OwningConsultant":"String","Account":"String","AirlineCode":"String","DueDate":"\/Date(-62135596800000-0000)\/","DueTime":"String","OwningAgencyLocationID":"String","GdsCode":"String","AgentivityRef":0}],"ActiveUnsoldAirBookings":[{"RecordLocator":"String","PNRCreationDate":"\/Date(-62135596800000-0000)\/","OwningAgencyLocationID":"String","GdsCode":"String","PrimaryPax":"String","OwningConsultant":"String","OwningConsultantID":"String","Account":"String","AgentivityRef":0,"PrimaryCarrierCode":"String","FiledFare":"String","TravelDate":"\/Date(-62135596800000-0000)\/","DestinationCities":"String","BookingClasses":"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"}],"BookingsWithWarnings":[{"RecordLocator":"String","PNRCreationDate":"\/Date(-62135596800000-0000)\/","AgentivityRef":0,"OwningConsultant":"String","Account":"String","OwningConsultantID":"String","OwningAgencyLocationID":"String","GdsCode":"String","TravelDate":"\/Date(-62135596800000-0000)\/","PrimaryPax":"String","WarningsList":[{"WarningType":"String","Vendor":"String","VendorType":"String","WarningDateTime":"\/Date(-62135596800000-0000)\/","LogDateTime":"\/Date(-62135596800000-0000)\/","OriginalRemark":"String","PropertiesList":[{"Name":"String","Value":"String"}]}]}]}],"ResponseError":{"ErrorCode":"String","Message":"String","StatusCode":"String","VerboseMessage":"String"}}