Agentivity API

GetBookingsByConsultant

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

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

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

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

        [DataMember(Order=40)]
        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 PnrTicketed { get; set; }

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

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

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

        [DataMember(Order=10)]
        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="AgentivityResponse", Namespace="schemas.agentivity.com/types")]
    public partial class BookingsByConsultantItemResponse
        : ItemResponse<BookingByConsultant, BookingsByConsultantResponseReport>
    {
    }

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

    [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 GetBookingsByConsultant
        : CompanyLevelRequestBase
    {
        ///<summary>
        ///Date in format YYYYMMDD
        ///</summary>
        [DataMember]
        public virtual string PNRCreationDateStart { get; set; }

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

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

        ///<summary>
        ///Obsolete parameter; it will be removed in future versions
        ///</summary>
        [DataMember]
        public virtual string OwningConsultant { get; set; }

        ///<summary>
        ///Include Itinerary in the response
        ///</summary>
        [DataMember]
        public virtual bool IncludeItinerary { 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="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# GetBookingsByConsultant DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

GET /BookingsByConsultant HTTP/1.1 
Host: api.agentivity.com 
Accept: application/json

HTTP/1.1 200 OK
Content-Type: application/json
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":{"Item":{"AgentivityRef":0,"RecordLocator":"String","PNRCreationDate":"\/Date(-62135596800000-0000)\/","CountryCountGroup":"String","Passenger":"String","Account":"String","TravelDate":"\/Date(-62135596800000-0000)\/","PnrTicketed":"String","PnrCancelled":"String","AgentInitials":"String","IsChurned":"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"}},"ResponseError":{"ErrorCode":"String","Message":"String","StatusCode":"String","VerboseMessage":"String"}}