Agentivity API

<back to all web services

BookingsCountsPerConsultant

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

// @DataContract(Name="Metadata", Namespace="schemas.agentivity.com/types")
export class PagingMetadata
{
    /** @description Starting Record */
    // @DataMember
    // @ApiMember(DataType="string", Description="Starting Record", Name="Offset", ParameterType="query")
    public Offset: string;

    /** @description Number of records to return (PageSize) */
    // @DataMember
    // @ApiMember(DataType="string", Description="Number of records to return (PageSize)", Name="Limit", ParameterType="query")
    public Limit: string;

    /** @description Total Number of Records in a Full Reponse (if no paging) */
    // @DataMember
    // @ApiMember(DataType="string", Description="Total Number of Records in a Full Reponse (if no paging)", Name="TotalRecords", ParameterType="query")
    public TotalRecords: number;

    /** @description Total Number of Records in this Reponse (on this page) */
    // @DataMember
    // @ApiMember(DataType="string", Description="Total Number of Records in this Reponse (on this page)", Name="ResponseRecords", ParameterType="query")
    public ResponseRecords: number;

    public constructor(init?: Partial<PagingMetadata>) { (Object as any).assign(this, init); }
}

// @DataContract(Namespace="schemas.agentivity.com/types")
export class CompanyLevelRequestBase extends PagingMetadata implements IMemberUsername, IMemberOwningCompanyCode
{
    /** @description Comma Delimited List of Owning Company Codes */
    // @DataMember
    public OwningCompanyCode: string[];

    /** @description UserName in form of an email address */
    // @DataMember
    public UserName: string;

    public constructor(init?: Partial<CompanyLevelRequestBase>) { super(init); (Object as any).assign(this, init); }
}

// @DataContract(Name="ItinerarySegment", Namespace="schemas.agentivity.com/types")
export class ItinerarySegment
{
    // @DataMember
    public SegmentType: string;

    // @DataMember
    public SegmentNbr: number;

    // @DataMember
    public BoardPoint: string;

    // @DataMember
    public OffPoint: string;

    // @DataMember
    public OperatorCode: string;

    // @DataMember
    public OperatorService: string;

    // @DataMember
    public SegmentStatus: string;

    // @DataMember
    public DepartureTimeFormatted: string;

    // @DataMember
    public ArrivalTimeFormatted: string;

    // @DataMember
    public ChangeOfDayFormatted: string;

    // @DataMember
    public ServiceCode: string;

    // @DataMember
    public StartDate: string;

    // @DataMember
    public EndDate: string;

    // @DataMember
    public TicketNumber: string;

    /** @description Comma separated list of vendor locators */
    // @DataMember
    public VendorLocators: string;

    // @DataMember
    public EquipmentCode: string;

    // @DataMember
    public Equipment: string;

    public constructor(init?: Partial<ItinerarySegment>) { (Object as any).assign(this, init); }
}

export class ItinerarySegmentsCollection extends Array<ItinerarySegment>
{

    public constructor(init?: Partial<ItinerarySegmentsCollection>) { super(); (Object as any).assign(this, init); }
}

// @DataContract(Name="BookingCountsPerConsultant", Namespace="schemas.agentivity.com/types")
export class BookingCountsPerConsultant implements IBookingItinerary
{
    // @DataMember(Order=10)
    public OwningConsultant: string;

    // @DataMember(Order=20)
    public OwningConsultantID: string;

    // @DataMember(Order=30)
    public TotalBookings: number;

    // @DataMember(Order=40)
    public CancelledCount: number;

    // @DataMember(Order=50)
    public ContainingAirCount: number;

    // @DataMember(Order=60)
    public GDSTicketedCount: number;

    // @DataMember(Order=70)
    public LowCostCarrierCount: number;

    // @DataMember(Order=75)
    public AssumedTicketedCount: number;

    // @DataMember(Order=80)
    public ChurnCount: number;

    // @DataMember(Order=90)
    public QualifierCount?: number;

    // @DataMember(Order=100)
    public CountryCount: string;

    // @DataMember(Order=105)
    public RoboticTicketingCount: number;

    // @DataMember(Order=107)
    public RecordLocator: string;

    // @DataMember(Order=109)
    public Account: string;

    // @DataMember(Order=111)
    public TravelDate?: string;

    // @DataMember(Order=113)
    public Remark: string;

    // @DataMember(Order=115)
    public Passangers: string;

    // @DataMember(Order=130)
    public PNRCreationDate?: string;

    // @DataMember(Order=140)
    public AgentInitials: string;

    // @DataMember(Order=120)
    public AgentivityRef: number;

    // @DataMember(Order=1000)
    public Itinerary: ItinerarySegmentsCollection;

    // @DataMember(Order=1010)
    public ItineraryFormatted: string;

    public constructor(init?: Partial<BookingCountsPerConsultant>) { (Object as any).assign(this, init); }
}

// @DataContract(Namespace="schemas.agentivity.com/types")
export class Report<TItemResponse, TItem>
{
    // @DataMember(Order=1, EmitDefaultValue=false)
    public Item: TItem;

    public constructor(init?: Partial<Report<TItemResponse, TItem>>) { (Object as any).assign(this, init); }
}

// @DataContract(Name="BookingCountsPerConsultant", Namespace="schemas.agentivity.com/types")
export class BookingsCountsPerConsultantResponseReport extends Report<BookingsCountsPerConsultantItemResponse, BookingCountsPerConsultant>
{

    public constructor(init?: Partial<BookingsCountsPerConsultantResponseReport>) { super(init); (Object as any).assign(this, init); }
}

// @DataContract(Name="CacheMetadata", Namespace="schemas.agentivity.com/types")
export class CacheMetadata
{
    // @DataMember(Order=1)
    public CachedAt: string;

    // @DataMember(Order=2)
    public CacheExpiresAt: string;

    // @DataMember(Order=0)
    public IsFromCache: boolean;

    public constructor(init?: Partial<CacheMetadata>) { (Object as any).assign(this, init); }
}

// @DataContract(Name="ResponseMetadata", Namespace="schemas.agentivity.com/types")
export class ResponseMetadata
{
    // @DataMember(Order=0)
    public Success: boolean;

    // @DataMember(Order=1)
    public HasCache: boolean;

    // @DataMember(Order=2)
    public HasPaging: boolean;

    // @DataMember(Order=3, EmitDefaultValue=false)
    public CacheMetadata: CacheMetadata;

    // @DataMember(Order=4, EmitDefaultValue=false)
    public PagingMetadata: PagingMetadata;

    public constructor(init?: Partial<ResponseMetadata>) { (Object as any).assign(this, init); }
}

// @DataContract(Name="ResponseMetadata", Namespace="schemas.agentivity.com/types")
export class AgentivityError
{
    // @DataMember
    public ErrorCode: string;

    // @DataMember
    public Message: string;

    // @DataMember
    public StatusCode: string;

    // @DataMember
    public VerboseMessage: string;

    public constructor(init?: Partial<AgentivityError>) { (Object as any).assign(this, init); }
}

// @DataContract(Name="AgentivityResponse", Namespace="schemas.agentivity.com/types")
export class ItemResponse<TItem, TReport>
{
    // @DataMember(Order=1)
    public ResponseMetadata: ResponseMetadata;

    // @DataMember(Order=2, EmitDefaultValue=false)
    public ResponseReport: TReport;

    // @DataMember(Order=3, EmitDefaultValue=false)
    public ResponseError: AgentivityError;

    public constructor(init?: Partial<ItemResponse<TItem, TReport>>) { (Object as any).assign(this, init); }
}

// @DataContract(Name="AgentivityResponse", Namespace="schemas.agentivity.com/types")
export class BookingsCountsPerConsultantItemResponse extends ItemResponse<BookingCountsPerConsultant, BookingsCountsPerConsultantResponseReport>
{

    public constructor(init?: Partial<BookingsCountsPerConsultantItemResponse>) { super(init); (Object as any).assign(this, init); }
}

// @Flags()
export enum FormattingStyle
{
    None = 0,
    Html = 1,
    Charting = 2,
}

// @DataContract(Namespace="schemas.agentivity.com/types")
export class BookingsCountsPerConsultant extends CompanyLevelRequestBase
{
    /** @description Date in format YYYYMMDD */
    // @DataMember
    public PNRCreationDateStart: string;

    /** @description Date in format YYYYMMDD */
    // @DataMember
    public PNRCreationDateEnd: string;

    /** @description Comma Delimited List of PCCs */
    // @DataMember
    public OwningAgencyLocationID: string[];

    /** @description Team name */
    // @DataMember
    public Team: string;

    /** @description Qualifier */
    // @DataMember
    public Qualifier: string;

    /** @description List only summary if selected true */
    // @DataMember
    public OnlySummary: boolean;

    /** @description Include Itinerary in the response */
    // @DataMember
    public IncludeItinerary: boolean;

    /** @description Indicates the required formatting: 0=None(Default); 1= Html; 2 = Chart */
    // @DataMember
    public ItineraryFormatting: FormattingStyle;

    /** @description Repeat */
    // @DataMember
    public Repeat: boolean;

    public constructor(init?: Partial<BookingsCountsPerConsultant>) { super(init); (Object as any).assign(this, init); }
}

TypeScript BookingsCountsPerConsultant 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 /BookingsCountsPerConsultant 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":{"OwningConsultant":"String","OwningConsultantID":"String","TotalBookings":0,"CancelledCount":0,"ContainingAirCount":0,"GDSTicketedCount":0,"LowCostCarrierCount":0,"AssumedTicketedCount":0,"ChurnCount":0,"QualifierCount":0,"CountryCount":"String","RoboticTicketingCount":0,"RecordLocator":"String","Account":"String","TravelDate":"\/Date(-62135596800000-0000)\/","Remark":"String","Passangers":"String","AgentivityRef":0,"PNRCreationDate":"\/Date(-62135596800000-0000)\/","AgentInitials":"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"}}