Agentivity API

<back to all web services

GetTicketCouponsByStatusCode

The following routes are available for this service:
GET/TicketCouponsByStatusCode
GetTicketCouponsByStatusCode Parameters:
NameParameterData TypeRequiredDescription
DateStartquerystringYesDate in format YYYYMMDD
DateEndquerystringYesDate in format YYYYMMDD
TravAgntIDqueryintegerNoTravel agent ID
AccountquerystringNoComma Delimited List of Accounts
OwningAgencyLocationIDquerystringNoComma Delimited List of PCCs
CouponCodeGroupquerystringYesCoupon code group ("ALL OPEN") or any Coupon Status eg USED, OPEN
DateTrackerquerystringYesDate range type. A single character: I = Issue date, T = Travel date, E = Expiry date
RepeatquerystringNoRepeat
NoActiveSegmentsquerybooleanNoLists only segments that are not active
IncludePartialMatchesquerybooleanNoInclude partial matches
ShowMatchingCouponsOnlyquerybooleanNoShow Matching Coupons Only
PaxSurnamequerystringNoPax surname
CarrierCodequerystringNoTwo letter code for carrier
ExcludedPlatingCarrierquerystringNoComma delimited list of 3-character plating carriers
OwningConsultantIDquerystringNoId of the owning consultant
CacheGuidquerystringNoCache Guid
TravellerGUIDquerystringNoAgentivity Traveller GUID
RequestConsultantIDquerystringNoRequest Consultant ID (sign on)
CompanyLevelRequestBase Parameters:
NameParameterData TypeRequiredDescription
OwningCompanyCodequerystringNoComma Delimited List of Owning Company Codes
UserNamequerystringNoUserName in form of an email address
PagingMetadata Parameters:
NameParameterData TypeRequiredDescription
OffsetquerystringNoStarting Record
LimitquerystringNoNumber of records to return (PageSize)
TotalRecordsquerystringNoTotal Number of Records in a Full Reponse (if no paging)
ResponseRecordsquerystringNoTotal Number of Records in this Reponse (on this page)
CollectionResponse<TItem> Parameters:
NameParameterData TypeRequiredDescription
ResponseMetadataformResponseMetadataNo
ResponseReportformList<TItem>No
ResponseErrorformAgentivityErrorNo
ResponseMetadata Parameters:
NameParameterData TypeRequiredDescription
SuccessformboolNo
HasCacheformboolNo
HasPagingformboolNo
CacheMetadataformCacheMetadataNo
PagingMetadataformPagingMetadataNo
CacheMetadata Parameters:
NameParameterData TypeRequiredDescription
CachedAtformDateTimeNo
CacheExpiresAtformDateTimeNo
IsFromCacheformboolNo
AgentivityError Parameters:
NameParameterData TypeRequiredDescription
ErrorCodeformstringNo
MessageformstringNo
StatusCodeformstringNo
VerboseMessageformstringNo
TicketCouponsByStatusCode Parameters:
NameParameterData TypeRequiredDescription
CompanyNameformstringNo
TktNumberformstringNo
RNformstringNo
AirTktSegIdformstringNo
VndIssueDtformDateTime?No
RecordLocatorformstringNo
PassengerformstringNo
TravAgntIDformstringNo
OwningConsultantIDformstringNo
FOPFareformstringNo
BaseFareformstringNo
FOPformstringNo
TotalTaxformstringNo
Tax1CodeformstringNo
Tax1AmtformstringNo
Tax2CodeformstringNo
Tax2AmtformstringNo
Tax3CodeformstringNo
Tax3AmtformstringNo
Tax4CodeformstringNo
Tax4AmtformstringNo
Tax5CodeformstringNo
Tax5AmtformstringNo
AccountformstringNo
ExchangedForTicketformstringNo
CouponSequenceNbrformstringNo
CarrierformstringNo
BoardPointformstringNo
OffPointformstringNo
FlightDateformDateTime?No
FlightServiceClassformstringNo
FareBasisformstringNo
FlightCouponStatusformstringNo
DateLastCheckedformDateTime?No
PCCformstringNo
AirlineCodeformstringNo
OwningCompanyCodeformstringNo
CreditCurrencyformstringNo
CreditValueformdecimal?No
FlightServiceClassNameformstringNo
FlownKMformint?No
BARformstringNo
PNRCreationDateformDateTime?No
AgentivityRefformintNo
CustomFieldsformCustomFieldsCollectionNo
CustomFieldData Parameters:
NameParameterData TypeRequiredDescription
FieldNameformstringNo
FieldValueformstringNo

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 //TicketCouponsByStatusCode 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":[{"CompanyName":"String","TktNumber":"String","RN":"String","AirTktSegId":"String","VndIssueDt":"\/Date(-62135596800000-0000)\/","RecordLocator":"String","Passenger":"String","TravAgntID":"String","OwningConsultantID":"String","FOPFare":"String","BaseFare":"String","FOP":"String","TotalTax":"String","Tax1Code":"String","Tax1Amt":"String","Tax2Code":"String","Tax2Amt":"String","Tax3Code":"String","Tax3Amt":"String","Tax4Code":"String","Tax4Amt":"String","Tax5Code":"String","Tax5Amt":"String","Account":"String","ExchangedForTicket":"String","CouponSequenceNbr":"String","Carrier":"String","BoardPoint":"String","OffPoint":"String","FlightDate":"\/Date(-62135596800000-0000)\/","FlightServiceClass":"String","FareBasis":"String","FlightCouponStatus":"String","DateLastChecked":"\/Date(-62135596800000-0000)\/","PCC":"String","AirlineCode":"String","OwningCompanyCode":"String","CreditCurrency":"String","CreditValue":0,"FlightServiceClassName":"String","FlownKM":0,"BAR":"String","PNRCreationDate":"\/Date(-62135596800000-0000)\/","AgentivityRef":0,"CustomFields":[{"FieldName":"String","FieldValue":"String"}]}],"ResponseError":{"ErrorCode":"String","Message":"String","StatusCode":"String","VerboseMessage":"String"}}