Agentivity API

<back to all web services

GetTicketCouponsByStatusCode

// @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="CustomField", Namespace="schemas.agentivity.com/types")
export class CustomFieldData
{
    // @DataMember(Order=20)
    public FieldName: string;

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

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

export class CustomFieldsCollection extends Array<CustomFieldData>
{

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

// @DataContract(Name="TicketCouponsByStatusCode", Namespace="schemas.agentivity.com/types")
export class TicketCouponsByStatusCode implements IBookingIdentifier, ICustomFields
{
    // @DataMember(Order=5)
    public CompanyName: string;

    // @DataMember(Order=10)
    public TktNumber: string;

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

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

    // @DataMember(Order=35)
    public VndIssueDt?: string;

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

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

    // @DataMember(Order=51)
    public TravAgntID: string;

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

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

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

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

    // @DataMember(Order=110)
    public TotalTax: string;

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

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

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

    // @DataMember(Order=150)
    public Tax2Amt: string;

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

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

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

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

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

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

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

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

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

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

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

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

    // @DataMember(Order=280)
    public FlightDate?: string;

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

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

    // @DataMember(Order=310)
    public FlightCouponStatus: string;

    // @DataMember(Order=320)
    public DateLastChecked?: string;

    // @DataMember(Order=330)
    public PCC: string;

    // @DataMember(Order=340)
    public AirlineCode: string;

    // @DataMember(Order=500)
    public OwningCompanyCode: string;

    // @DataMember(Order=510)
    public CreditCurrency: string;

    // @DataMember(Order=520)
    public CreditValue?: number;

    // @DataMember(Order=530)
    public FlightServiceClassName: string;

    // @DataMember(Order=540)
    public FlownKM?: number;

    // @DataMember(Order=550)
    public BAR: string;

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

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

    // @DataMember(Order=580)
    public CustomFields: CustomFieldsCollection;

    public constructor(init?: Partial<TicketCouponsByStatusCode>) { (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="ApiRequestPerHour", Namespace="schemas.agentivity.com/types")
export class ApiRequestPerHour
{
    // @DataMember(Order=10)
    public RequestDate: string;

    // @DataMember(Order=100)
    public Hour0: number;

    // @DataMember(Order=110)
    public Hour1: number;

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

    // @DataMember(Order=130)
    public Hour3: number;

    // @DataMember(Order=140)
    public Hour4: number;

    // @DataMember(Order=150)
    public Hour5: number;

    // @DataMember(Order=160)
    public Hour6: number;

    // @DataMember(Order=170)
    public Hour7: number;

    // @DataMember(Order=180)
    public Hour8: number;

    // @DataMember(Order=190)
    public Hour9: number;

    // @DataMember(Order=200)
    public Hour10: number;

    // @DataMember(Order=210)
    public Hour11: number;

    // @DataMember(Order=220)
    public Hour12: number;

    // @DataMember(Order=230)
    public Hour13: number;

    // @DataMember(Order=240)
    public Hour14: number;

    // @DataMember(Order=250)
    public Hour15: number;

    // @DataMember(Order=260)
    public Hour16: number;

    // @DataMember(Order=270)
    public Hour17: number;

    // @DataMember(Order=280)
    public Hour18: number;

    // @DataMember(Order=290)
    public Hour19: number;

    // @DataMember(Order=300)
    public Hour20: number;

    // @DataMember(Order=310)
    public Hour21: number;

    // @DataMember(Order=320)
    public Hour22: number;

    // @DataMember(Order=330)
    public Hour23: number;

    public constructor(init?: Partial<ApiRequestPerHour>) { (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 CollectionResponse<TItem>
{
    // @DataMember(Order=1)
    public ResponseMetadata: ResponseMetadata;

    // @DataMember(Order=2, EmitDefaultValue=false)
    public ResponseReport: ApiRequestPerHour[];

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

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

// @DataContract(Name="AgentivityResponse", Namespace="schemas.agentivity.com/types")
export class TicketCouponsByStatusCodeResponse extends CollectionResponse<TicketCouponsByStatusCode>
{

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

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

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

    /** @description Travel agent ID */
    // @DataMember
    public TravAgntID: string;

    /** @description Comma Delimited List of Accounts */
    // @DataMember
    public Account: string[];

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

    /** @description Coupon code group ("ALL OPEN") or any Coupon Status eg USED, OPEN */
    // @DataMember
    public CouponCodeGroup: string;

    /** @description Date range type. A single character: I = Issue date, T = Travel date, E = Expiry date */
    // @DataMember
    public DateTracker: string;

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

    /** @description Lists only segments that are not active */
    // @DataMember
    public NoActiveSegments: boolean;

    /** @description Include partial matches */
    // @DataMember
    public IncludePartialMatches: boolean;

    /** @description Show Matching Coupons Only */
    // @DataMember
    public ShowMatchingCouponsOnly: boolean;

    /** @description Pax surname */
    // @DataMember
    public PaxSurname: string;

    /** @description Two letter code for carrier */
    // @DataMember
    public CarrierCode: string;

    /** @description Comma delimited list of 3-character plating carriers */
    // @DataMember
    public ExcludedPlatingCarrier: string[];

    /** @description Id of the owning consultant */
    // @DataMember
    public OwningConsultantID: string;

    /** @description Cache Guid */
    // @DataMember
    public CacheGuid: string;

    /** @description Agentivity Traveller GUID */
    // @DataMember
    public TravellerGUID: string;

    /** @description Request Consultant ID (sign on) */
    // @DataMember
    public RequestConsultantID: string;

    // @DataMember
    public CRMCode: number;

    // @DataMember
    public CRMID: string;

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

TypeScript GetTicketCouponsByStatusCode DTOs

GET /TicketCouponsByStatusCode 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>
    <TicketCouponsByStatusCode>
      <CompanyName>String</CompanyName>
      <TktNumber>String</TktNumber>
      <RN>String</RN>
      <AirTktSegId>String</AirTktSegId>
      <VndIssueDt>0001-01-01T00:00:00</VndIssueDt>
      <RecordLocator>String</RecordLocator>
      <Passenger>String</Passenger>
      <TravAgntID>String</TravAgntID>
      <OwningConsultantID>String</OwningConsultantID>
      <FOPFare>String</FOPFare>
      <BaseFare>String</BaseFare>
      <FOP>String</FOP>
      <TotalTax>String</TotalTax>
      <Tax1Code>String</Tax1Code>
      <Tax1Amt>String</Tax1Amt>
      <Tax2Code>String</Tax2Code>
      <Tax2Amt>String</Tax2Amt>
      <Tax3Code>String</Tax3Code>
      <Tax3Amt>String</Tax3Amt>
      <Tax4Amt>String</Tax4Amt>
      <Tax4Code>String</Tax4Code>
      <Tax5Code>String</Tax5Code>
      <Tax5Amt>String</Tax5Amt>
      <Account>String</Account>
      <ExchangedForTicket>String</ExchangedForTicket>
      <CouponSequenceNbr>String</CouponSequenceNbr>
      <Carrier>String</Carrier>
      <BoardPoint>String</BoardPoint>
      <OffPoint>String</OffPoint>
      <FlightDate>0001-01-01T00:00:00</FlightDate>
      <FlightServiceClass>String</FlightServiceClass>
      <FareBasis>String</FareBasis>
      <FlightCouponStatus>String</FlightCouponStatus>
      <DateLastChecked>0001-01-01T00:00:00</DateLastChecked>
      <PCC>String</PCC>
      <AirlineCode>String</AirlineCode>
      <OwningCompanyCode>String</OwningCompanyCode>
      <CreditCurrency>String</CreditCurrency>
      <CreditValue>0</CreditValue>
      <FlightServiceClassName>String</FlightServiceClassName>
      <FlownKM>0</FlownKM>
      <BAR>String</BAR>
      <PNRCreationDate>0001-01-01T00:00:00</PNRCreationDate>
      <AgentivityRef>0</AgentivityRef>
      <CustomFields>
        <CustomField>
          <FieldName>String</FieldName>
          <FieldValue>String</FieldValue>
        </CustomField>
      </CustomFields>
    </TicketCouponsByStatusCode>
  </ResponseReport>
  <ResponseError>
    <ErrorCode>String</ErrorCode>
    <Message>String</Message>
    <StatusCode>String</StatusCode>
    <VerboseMessage>String</VerboseMessage>
  </ResponseError>
</AgentivityResponse>