Agentivity API

<back to all web services

SegmentsQC

The following routes are available for this service:
GET/SegmentsQC
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="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; }
    }

    [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; }
    }

    public enum QcCheck
    {
        Missing,
        Warning,
        Valid,
        Denied,
    }

    [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; }
    }

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

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

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

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

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

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

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

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

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

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

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

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

        [DataMember(Order=105)]
        public virtual string FlightNumberFromatted { get; set; }

        [DataMember(Order=110)]
        public virtual QcCheck SeatCheck { get; set; }

        [DataMember(Order=120)]
        public virtual string SeatFormatted { get; set; }

        [DataMember(Order=130)]
        public virtual QcCheck MealCheck { get; set; }

        [DataMember(Order=155)]
        public virtual string MealFormatted { get; set; }

        [DataMember(Order=160)]
        public virtual string ChauffeurDesc { get; set; }

        [DataMember(Order=170)]
        public virtual string TransferDesc { get; set; }

        [DataMember(Order=180)]
        public virtual string CarsFormatted { get; set; }

        [DataMember(Order=190)]
        public virtual QcCheck HoteCheck { get; set; }

        [DataMember(Order=200)]
        public virtual string Hotels { get; set; }

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

        [DataMember(Order=220)]
        public virtual string TourDesc { get; set; }

        [DataMember(Order=230)]
        public virtual string FrequentFlyerNumbers { get; set; }

        [DataMember(Order=240)]
        public virtual string PnrTicketed { get; set; }

        [DataMember(Order=250)]
        public virtual string TicketNumber { get; set; }

        [DataMember(Order=260)]
        public virtual string Comments { get; set; }

        [DataMember(Order=270)]
        public virtual string OpsComments { get; set; }

        [DataMember(Order=280)]
        public virtual bool IsVip { get; set; }

        [DataMember(Order=290)]
        public virtual string CorporateFFs { get; set; }

        [DataMember(Order=300)]
        public virtual string VendorLocator { get; set; }
    }

    [DataContract(Namespace="schemas.agentivity.com/types")]
    public partial class SegmentsQC
        : CompanyLevelRequestBase
    {
        ///<summary>
        ///Comma Delimited List of Accounts
        ///</summary>
        [DataMember]
        public virtual string[] Account { get; set; }

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

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

        ///<summary>
        ///Return only segments that are flagged as VIP only
        ///</summary>
        [DataMember]
        public virtual bool VipOnly { get; set; }
    }

    [DataContract(Name="AgentivityResponse", Namespace="schemas.agentivity.com/types")]
    public partial class SegmentsQCItemResponse
        : ItemResponse<SegmentQC, SegmentsQCResponseReport>
    {
    }

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

}

C# SegmentsQC 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.

GET /SegmentsQC HTTP/1.1 
Host: api.agentivity.com 
Accept: application/xml
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>
    <Item>
      <AgentivityRef>0</AgentivityRef>
      <RecordLocator>String</RecordLocator>
      <OwningConsultant>String</OwningConsultant>
      <Passenger>String</Passenger>
      <Account>String</Account>
      <BoardPoint>String</BoardPoint>
      <OffPoint>String</OffPoint>
      <DepartureTime>String</DepartureTime>
      <BookingClass>String</BookingClass>
      <SegmentStatus>String</SegmentStatus>
      <CarrierCode>String</CarrierCode>
      <FlightNbr>String</FlightNbr>
      <FlightNumberFromatted>String</FlightNumberFromatted>
      <SeatCheck>Missing</SeatCheck>
      <SeatFormatted>String</SeatFormatted>
      <MealCheck>Missing</MealCheck>
      <MealFormatted>String</MealFormatted>
      <ChauffeurDesc>String</ChauffeurDesc>
      <TransferDesc>String</TransferDesc>
      <CarsFormatted>String</CarsFormatted>
      <HoteCheck>Missing</HoteCheck>
      <Hotels>String</Hotels>
      <ShuttleDesc>String</ShuttleDesc>
      <TourDesc>String</TourDesc>
      <FrequentFlyerNumbers>String</FrequentFlyerNumbers>
      <PnrTicketed>String</PnrTicketed>
      <TicketNumber>String</TicketNumber>
      <Comments>String</Comments>
      <OpsComments>String</OpsComments>
      <IsVip>false</IsVip>
      <CorporateFFs>String</CorporateFFs>
      <VendorLocator>String</VendorLocator>
    </Item>
  </ResponseReport>
  <ResponseError>
    <ErrorCode>String</ErrorCode>
    <Message>String</Message>
    <StatusCode>String</StatusCode>
    <VerboseMessage>String</VerboseMessage>
  </ResponseError>
</AgentivityResponse>