Agentivity API

<back to all web services

PartnerBookingsDataCapture

The following routes are available for this service:
GET/PartnerBookingDataCaptures
PartnerBookingsDataCapture Parameters:
NameParameterData TypeRequiredDescription
UserNamequerystringYesUserName in form of an email address
PNRCreationDateStartquerystringYesDate in format YYYYMMDD
PNRCreationDateEndquerystringYesDate in format YYYYMMDD
PCCListquerystringNoComma Delimited List of PCCs
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)
ItemResponse<TItem, TReport> Parameters:
NameParameterData TypeRequiredDescription
ResponseMetadataformResponseMetadataNo
ResponseReportformTReportNo
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
PartnerBookingDataCapture Parameters:
NameParameterData TypeRequiredDescription
AGENCY_IATAformstringNo
TRVL_YRformint?No
TRVL_MTHformint?No
GLOBALCUST_NOformstringNo
LOCALCUST_NOformstringNo
TRAVELLER_NAMEformstringNo
GDS_RECLOCformstringNo
RESERVATION_DATEformDateTime?No
EMPLOYEE_NUMBERformstringNo
TRAVELLER_STATUSformstringNo
COST_CENTER_CODEformstringNo
PROJECT_NUMBERformstringNo
DEPARTMENT_NUMBERformstringNo
ORDER_REFERENCEformstringNo
APPROVERformstringNo
APPROVAL_CODEformstringNo
MANAGER_SUPERIORformstringNo
REASON_OF_TRIPformstringNo
CS_DATA1formstringNo
CS_DATA2formstringNo
CS_DATA3formstringNo
CS_DATA4formstringNo
CS_DATA7formstringNo
CS_DATA8formstringNo
CREDIT_CARD_COMPANY_CODEformstringNo
CREDIT_CARD_NUMBERformstringNo
AIR_BOOKED_FLAGformstringNo
DEPART_DATEformDateTime?No
ITINERARY_DATESformstringNo
DEPARTURE_ARRIVAL_TIMESformstringNo
CARRIER_CDformstringNo
VALIDATING_CARRIER_CDformstringNo
PNR_SEGMENT_NOformint?No
OPR_FLT_NOformstringNo
CLASSformstringNo
FARE_BASISformstringNo
TKT_TYPEformstringNo
TKT_NOformstringNo
NO_OF_DOCUMENTSformint?No
STOPOVR_TRF_FLAGformstringNo
TOUR_CODEformstringNo
ITINERARYformstringNo
LOC_CURformstringNo
FULL_FAREformstringNo
FARE_PAIDformstringNo
LOW_FAREformstringNo
LOC_TAXformstringNo
SALES_CHANNELformstringNo
REASON_CODEformstringNo
REASON_CODE_DENIEDformstringNo
AIR_NO_ACCOMODATION_REASON_CODEformstringNo
ORIGINAL_DOCUMENTformstringNo
REFUNDED_FAREformstringNo
AIR_COMM_AMTformstringNo
FFLYR_NOformstringNo
HOTEL_BOOKED_FLAGformstringNo
HOTEL_NAMEformstringNo
ADDRESSformstringNo
CITY_COUNTRYCODE_ZIPCODE_PHONEformstringNo
CHECKINDATEformstringNo
HOTEL_CHAIN_CODEformstringNo
HOTEL_GDS_PARTNER_CD_USEDformstringNo
GDS_RM_TYPE_CODEformstringNo
RM_TYPEformstringNo
HOTEL_VOUCHER_NOformstringNo
RATE_TYPE_CODEformstringNo
AREA_CODEformstringNo
NIGHT_STAYSformstringNo
ROOM_RATE_CURformstringNo
PAID_ROOM_RATE_PER_NIGHTformstringNo
HOTEL_BOOK_MODEformstringNo
HOTEL_REASON_CODEformstringNo
HOTEL_COMM_AMTformstringNo
CAR_BOOKED_FLAGformstringNo
SUPPLIER_NAMEformstringNo
GDS_MASTER_SUPPLIER_CODEformstringNo
CAR_GDS_PARTNER_CD_USEDformstringNo
GDS_CAR_TYPE_CODEformstringNo
CAR_VOUCHER_NOformstringNo
RENTAL_DAYSformstringNo
CAR_RENT_RATE_CURformstringNo
PAID_CAR_RENT_RATE_PER_DAYformstringNo
CAR_BOOK_MODEformstringNo
PICKUPDATEformstringNo
CAR_ITINERARY_CDformstringNo
CAR_REASON_CODEformstringNo
RAIL_FERRY_BOOKED_FLAGformstringNo
Report<TItemResponse, TItem> Parameters:
NameParameterData TypeRequiredDescription
ItemformTItemNo

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

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET //PartnerBookingDataCaptures HTTP/1.1 
Host: api.agentivity.com 
Accept: text/csv

HTTP/1.1 200 OK
Content-Type: text/csv
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":{"AGENCY_IATA":"String","TRVL_YR":0,"TRVL_MTH":0,"GLOBALCUST_NO":"String","LOCALCUST_NO":"String","TRAVELLER_NAME":"String","GDS_RECLOC":"String","RESERVATION_DATE":"\/Date(-62135596800000-0000)\/","EMPLOYEE_NUMBER":"String","TRAVELLER_STATUS":"String","COST_CENTER_CODE":"String","PROJECT_NUMBER":"String","DEPARTMENT_NUMBER":"String","ORDER_REFERENCE":"String","APPROVER":"String","APPROVAL_CODE":"String","MANAGER_SUPERIOR":"String","REASON_OF_TRIP":"String","CS_DATA1":"String","CS_DATA2":"String","CS_DATA3":"String","CS_DATA4":"String","CS_DATA7":"String","CS_DATA8":"String","CREDIT_CARD_COMPANY_CODE":"String","CREDIT_CARD_NUMBER":"String","AIR_BOOKED_FLAG":"String","DEPART_DATE":"\/Date(-62135596800000-0000)\/","ITINERARY_DATES":"String","DEPARTURE_ARRIVAL_TIMES":"String","CARRIER_CD":"String","VALIDATING_CARRIER_CD":"String","PNR_SEGMENT_NO":0,"OPR_FLT_NO":"String","CLASS":"String","FARE_BASIS":"String","TKT_TYPE":"String","TKT_NO":"String","NO_OF_DOCUMENTS":0,"STOPOVR_TRF_FLAG":"String","TOUR_CODE":"String","ITINERARY":"String","LOC_CUR":"String","FULL_FARE":"String","FARE_PAID":"String","LOW_FARE":"String","LOC_TAX":"String","SALES_CHANNEL":"String","REASON_CODE":"String","REASON_CODE_DENIED":"String","AIR_NO_ACCOMODATION_REASON_CODE":"String","ORIGINAL_DOCUMENT":"String","REFUNDED_FARE":"String","AIR_COMM_AMT":"String","FFLYR_NO":"String","HOTEL_BOOKED_FLAG":"String","HOTEL_NAME":"String","ADDRESS":"String","CITY_COUNTRYCODE_ZIPCODE_PHONE":"String","CHECKINDATE":"String","HOTEL_CHAIN_CODE":"String","HOTEL_GDS_PARTNER_CD_USED":"String","GDS_RM_TYPE_CODE":"String","RM_TYPE":"String","HOTEL_VOUCHER_NO":"String","RATE_TYPE_CODE":"String","AREA_CODE":"String","NIGHT_STAYS":"String","ROOM_RATE_CUR":"String","PAID_ROOM_RATE_PER_NIGHT":"String","HOTEL_BOOK_MODE":"String","HOTEL_REASON_CODE":"String","HOTEL_COMM_AMT":"String","CAR_BOOKED_FLAG":"String","SUPPLIER_NAME":"String","GDS_MASTER_SUPPLIER_CODE":"String","CAR_GDS_PARTNER_CD_USED":"String","GDS_CAR_TYPE_CODE":"String","CAR_VOUCHER_NO":"String","RENTAL_DAYS":"String","CAR_RENT_RATE_CUR":"String","PAID_CAR_RENT_RATE_PER_DAY":"String","CAR_BOOK_MODE":"String","PICKUPDATE":"String","CAR_ITINERARY_CD":"String","CAR_REASON_CODE":"String","RAIL_FERRY_BOOKED_FLAG":"String"}},"ResponseError":{"ErrorCode":"String","Message":"String","StatusCode":"String","VerboseMessage":"String"}}