Agentivity API

GetTicketCouponsByStatusCode

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

**GetTicketCouponsByStatusCode** Parameters:
Name	Parameter	Data Type	Required	Description
DateStart	query	string	Yes	Date in format YYYYMMDD
DateEnd	query	string	Yes	Date in format YYYYMMDD
TravAgntID	query	integer	No	Travel agent ID
Account	query	string	No	Comma Delimited List of Accounts
OwningAgencyLocationID	query	string	No	Comma Delimited List of PCCs
CouponCodeGroup	query	string	Yes	Coupon code group ("ALL OPEN") or any Coupon Status eg USED, OPEN
DateTracker	query	string	Yes	Date range type. A single character: I = Issue date, T = Travel date, E = Expiry date
Repeat	query	string	No	Repeat
NoActiveSegments	query	boolean	No	Lists only segments that are not active
IncludePartialMatches	query	boolean	No	Include partial matches
ShowMatchingCouponsOnly	query	boolean	No	Show Matching Coupons Only
PaxSurname	query	string	No	Pax surname
CarrierCode	query	string	No	Two letter code for carrier
ExcludedPlatingCarrier	query	string	No	Comma delimited list of 3-character plating carriers
OwningConsultantID	query	string	No	Id of the owning consultant
CacheGuid	query	string	No	Cache Guid
TravellerGUID	query	string	No	Agentivity Traveller GUID
RequestConsultantID	query	string	No	Request Consultant ID (sign on)

**CompanyLevelRequestBase** Parameters:
Name	Parameter	Data Type	Required	Description
OwningCompanyCode	query	string	No	Comma Delimited List of Owning Company Codes
UserName	query	string	No	UserName in form of an email address

**PagingMetadata** Parameters:
Name	Parameter	Data Type	Required	Description
Offset	query	string	No	Starting Record
Limit	query	string	No	Number of records to return (PageSize)
TotalRecords	query	string	No	Total Number of Records in a Full Reponse (if no paging)
ResponseRecords	query	string	No	Total Number of Records in this Reponse (on this page)

**CollectionResponse<TItem>** Parameters:
Name	Parameter	Data Type	Required
ResponseMetadata	form	ResponseMetadata	No
ResponseReport	form	List<TItem>	No
ResponseError	form	AgentivityError	No

**ResponseMetadata** Parameters:
Name	Parameter	Data Type	Required
Success	form	bool	No
HasCache	form	bool	No
HasPaging	form	bool	No
CacheMetadata	form	CacheMetadata	No
PagingMetadata	form	PagingMetadata	No

**CacheMetadata** Parameters:
Name	Parameter	Data Type	Required
CachedAt	form	DateTime	No
CacheExpiresAt	form	DateTime	No
IsFromCache	form	bool	No

**AgentivityError** Parameters:
Name	Parameter	Data Type	Required
ErrorCode	form	string	No
Message	form	string	No
StatusCode	form	string	No
VerboseMessage	form	string	No

**TicketCouponsByStatusCode** Parameters:
Name	Parameter	Data Type	Required
CompanyName	form	string	No
TktNumber	form	string	No
RN	form	string	No
AirTktSegId	form	string	No
VndIssueDt	form	DateTime?	No
RecordLocator	form	string	No
Passenger	form	string	No
TravAgntID	form	string	No
OwningConsultantID	form	string	No
FOPFare	form	string	No
BaseFare	form	string	No
FOP	form	string	No
TotalTax	form	string	No
Tax1Code	form	string	No
Tax1Amt	form	string	No
Tax2Code	form	string	No
Tax2Amt	form	string	No
Tax3Code	form	string	No
Tax3Amt	form	string	No
Tax4Code	form	string	No
Tax4Amt	form	string	No
Tax5Code	form	string	No
Tax5Amt	form	string	No
Account	form	string	No
ExchangedForTicket	form	string	No
CouponSequenceNbr	form	string	No
Carrier	form	string	No
BoardPoint	form	string	No
OffPoint	form	string	No
FlightDate	form	DateTime?	No
FlightServiceClass	form	string	No
FareBasis	form	string	No
FlightCouponStatus	form	string	No
DateLastChecked	form	DateTime?	No
PCC	form	string	No
AirlineCode	form	string	No
OwningCompanyCode	form	string	No
CreditCurrency	form	string	No
CreditValue	form	decimal?	No
FlightServiceClassName	form	string	No
FlownKM	form	int?	No
BAR	form	string	No
PNRCreationDate	form	DateTime?	No
AgentivityRef	form	int	No
CustomFields	form	CustomFieldsCollection	No

**CustomFieldData** Parameters:
Name	Parameter	Data Type	Required	Description
FieldName	form	string	No
FieldValue	form	string	No

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 //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>