| GET | /BookingsCreated |
|---|
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="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="BookingCreated", Namespace="schemas.agentivity.com/types")]
public partial class BookingCreated
: IBookingItinerary, ICarbonTonnage
{
[DataMember(Order=10)]
public virtual int AgentivityRef { get; set; }
[DataMember(Order=20)]
public virtual string RecordLocator { get; set; }
[DataMember(Order=30)]
public virtual DateTime? PNRCreationDate { get; set; }
[DataMember(Order=40)]
public virtual string OwningAgencyLocationID { 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 OwningConsultant { get; set; }
[DataMember(Order=80)]
public virtual string PNRTicketed { get; set; }
[DataMember(Order=90)]
public virtual DateTime? PNRTicketedDate { get; set; }
[DataMember(Order=100)]
public virtual string PNRCancelled { get; set; }
[DataMember(Order=110)]
public virtual DateTime? TravelDate { get; set; }
[DataMember(Order=120)]
public virtual DateTime? CancelledTravelDate { get; set; }
[DataMember(Order=130)]
public virtual string Passengers { get; set; }
[DataMember(Order=140)]
public virtual string Mobile { get; set; }
[DataMember(Order=150)]
public virtual string Emails { get; set; }
[DataMember(Order=160)]
public virtual int DestinationCount { get; set; }
[DataMember(Order=170)]
public virtual bool IsVip { get; set; }
[DataMember(Order=180)]
public virtual string CTCM { get; set; }
[DataMember(Order=190)]
public virtual string CTCE { get; set; }
[DataMember(Order=200)]
public virtual ItinerarySegmentsCollection Itinerary { get; set; }
[DataMember(Order=210)]
public virtual string ItineraryFormatted { get; set; }
[DataMember(Order=220)]
public virtual double? CarbonTonnage { get; set; }
}
[DataContract(Name="AgentivityResponse", Namespace="schemas.agentivity.com/types")]
public partial class BookingsCreatedResponse
: CollectionResponse<BookingCreated>
{
}
[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 GetBookingsCreated
: CompanyLevelRequestBase, IMemberAccount, IMemberPNRCreationDateStart, IMemberPNRCreationDateEnd, IMemberPNRCancelled, IMemberHasMobile, IMemberHasEmail, IMemberMissingEmailOrPhone, IMemberHasHotel, IMemberHasAccount, IMemberIncludeItinerary, IMemberMinSegments, IMemberIsVip, IMemberItineraryFormatting
{
///<summary>
///Includes CTCM and CTCE in results
///</summary>
[DataMember]
public virtual bool IncludeCTFields { get; set; }
///<summary>
///Comma Delimited List of Accounts
///</summary>
[DataMember]
public virtual string[] Account { get; set; }
///<summary>
///Return only PNRs with/without an account
///</summary>
[DataMember]
public virtual bool? HasAccount { get; set; }
///<summary>
///Return only PNRs with/without an email address
///</summary>
[DataMember]
public virtual bool? HasEmail { get; set; }
///<summary>
///Return only PNRs with/without a hotel
///</summary>
[DataMember]
public virtual bool? HasHotel { get; set; }
///<summary>
///Return only PNRs with/without a mobile number
///</summary>
[DataMember]
public virtual bool? HasMobile { 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>
///Indicates the required formatting: 0=None(Default); 1= Html; 2 = Chart
///</summary>
[DataMember]
public virtual FormattingStyle ItineraryFormatting { get; set; }
///<summary>
///Return only PNRs that equal or exceed a certain number of segments
///</summary>
[DataMember]
public virtual int? MinSegments { get; set; }
///<summary>
///Return only PNRs with/without an email address OR a mobile number
///</summary>
[DataMember]
public virtual bool? MissingEmailOrPhone { get; set; }
///<summary>
///Date in format YYYYMMDD
///</summary>
[DataMember]
public virtual string PNRCreationDateEnd { get; set; }
///<summary>
///Date in format YYYYMMDD
///</summary>
[DataMember]
public virtual string PNRCreationDateStart { get; set; }
///<summary>
///Return only PNRs that are cancelled(Y)/not cancelled(N)/all
///</summary>
[DataMember]
public virtual string PNRCancelled { get; set; }
///<summary>
///Comma Delimited List of PCCs
///</summary>
[DataMember]
public virtual string[] OwningAgencyLocationID { 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; }
}
}
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.
GET /BookingsCreated HTTP/1.1 Host: api.agentivity.com Accept: text/jsonl
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":[{"AgentivityRef":0,"RecordLocator":"String","PNRCreationDate":"\/Date(-62135596800000-0000)\/","OwningAgencyLocationID":"String","Account":"String","OwningConsultantID":"String","OwningConsultant":"String","PNRTicketed":"String","PNRTicketedDate":"\/Date(-62135596800000-0000)\/","PNRCancelled":"String","TravelDate":"\/Date(-62135596800000-0000)\/","CancelledTravelDate":"\/Date(-62135596800000-0000)\/","Passengers":"String","Mobile":"String","Emails":"String","DestinationCount":0,"IsVip":false,"CTCM":"String","CTCE":"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","CarbonTonnage":0}],"ResponseError":{"ErrorCode":"String","Message":"String","StatusCode":"String","VerboseMessage":"String"}}