Agentivity API

<back to all web services

SegmentsQC

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

// @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); }
}

export enum QcCheck
{
    Missing = 'Missing',
    Warning = 'Warning',
    Valid = 'Valid',
    Denied = 'Denied',
}

// @DataContract(Name="SegmentQC", Namespace="schemas.agentivity.com/types")
export class SegmentQC
{
    // @DataMember(Order=10)
    public AgentivityRef: number;

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

    // @DataMember(Order=30)
    public OwningConsultant: string;

    // @DataMember(Order=40)
    public Passenger: string;

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

    // @DataMember(Order=50)
    public BoardPoint: string;

    // @DataMember(Order=50)
    public OffPoint: string;

    // @DataMember(Order=60)
    public DepartureTime: string;

    // @DataMember(Order=70)
    public BookingClass: string;

    // @DataMember(Order=80)
    public SegmentStatus: string;

    // @DataMember(Order=90)
    public CarrierCode: string;

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

    // @DataMember(Order=105)
    public FlightNumberFromatted: string;

    // @DataMember(Order=110)
    public SeatCheck: QcCheck;

    // @DataMember(Order=120)
    public SeatFormatted: string;

    // @DataMember(Order=130)
    public MealCheck: QcCheck;

    // @DataMember(Order=155)
    public MealFormatted: string;

    // @DataMember(Order=160)
    public ChauffeurDesc: string;

    // @DataMember(Order=170)
    public TransferDesc: string;

    // @DataMember(Order=180)
    public CarsFormatted: string;

    // @DataMember(Order=190)
    public HoteCheck: QcCheck;

    // @DataMember(Order=200)
    public Hotels: string;

    // @DataMember(Order=210)
    public ShuttleDesc: string;

    // @DataMember(Order=220)
    public TourDesc: string;

    // @DataMember(Order=230)
    public FrequentFlyerNumbers: string;

    // @DataMember(Order=240)
    public PnrTicketed: string;

    // @DataMember(Order=250)
    public TicketNumber: string;

    // @DataMember(Order=260)
    public Comments: string;

    // @DataMember(Order=270)
    public OpsComments: string;

    // @DataMember(Order=280)
    public IsVip: boolean;

    // @DataMember(Order=290)
    public CorporateFFs: string;

    // @DataMember(Order=300)
    public VendorLocator: string;

    public constructor(init?: Partial<SegmentQC>) { (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="SegmentQC", Namespace="schemas.agentivity.com/types")
export class SegmentsQCResponseReport extends Report<SegmentsQCItemResponse, SegmentQC>
{

    public constructor(init?: Partial<SegmentsQCResponseReport>) { 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 SegmentsQCItemResponse extends ItemResponse<SegmentQC, SegmentsQCResponseReport>
{

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

// @DataContract(Namespace="schemas.agentivity.com/types")
export class SegmentsQC extends CompanyLevelRequestBase
{
    /** @description Comma Delimited List of Accounts */
    // @DataMember
    public Account: string[];

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

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

    /** @description Return only segments that are flagged as VIP only */
    // @DataMember
    public VipOnly: boolean;

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

TypeScript SegmentsQC DTOs

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

HTTP + OTHER

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: 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":{"Item":{"AgentivityRef":0,"RecordLocator":"String","OwningConsultant":"String","Passenger":"String","Account":"String","BoardPoint":"String","OffPoint":"String","DepartureTime":"String","BookingClass":"String","SegmentStatus":"String","CarrierCode":"String","FlightNbr":"String","FlightNumberFromatted":"String","SeatCheck":"Missing","SeatFormatted":"String","MealCheck":"Missing","MealFormatted":"String","ChauffeurDesc":"String","TransferDesc":"String","CarsFormatted":"String","HoteCheck":"Missing","Hotels":"String","ShuttleDesc":"String","TourDesc":"String","FrequentFlyerNumbers":"String","PnrTicketed":"String","TicketNumber":"String","Comments":"String","OpsComments":"String","IsVip":false,"CorporateFFs":"String","VendorLocator":"String"}},"ResponseError":{"ErrorCode":"String","Message":"String","StatusCode":"String","VerboseMessage":"String"}}