Agentivity API

PartnerBookingsDataCapture

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

**PartnerBookingsDataCapture** Parameters:
Name	Parameter	Data Type	Required	Description
UserName	query	string	Yes	UserName in form of an email address
PNRCreationDateStart	query	string	Yes	Date in format YYYYMMDD
PNRCreationDateEnd	query	string	Yes	Date in format YYYYMMDD
PCCList	query	string	No	Comma Delimited List of PCCs

**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)

**ItemResponse<TItem, TReport>** Parameters:
Name	Parameter	Data Type	Required
ResponseMetadata	form	ResponseMetadata	No
ResponseReport	form	TReport	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

**PartnerBookingDataCapture** Parameters:
Name	Parameter	Data Type	Required
AGENCY_IATA	form	string	No
TRVL_YR	form	int?	No
TRVL_MTH	form	int?	No
GLOBALCUST_NO	form	string	No
LOCALCUST_NO	form	string	No
TRAVELLER_NAME	form	string	No
GDS_RECLOC	form	string	No
RESERVATION_DATE	form	DateTime?	No
EMPLOYEE_NUMBER	form	string	No
TRAVELLER_STATUS	form	string	No
COST_CENTER_CODE	form	string	No
PROJECT_NUMBER	form	string	No
DEPARTMENT_NUMBER	form	string	No
ORDER_REFERENCE	form	string	No
APPROVER	form	string	No
APPROVAL_CODE	form	string	No
MANAGER_SUPERIOR	form	string	No
REASON_OF_TRIP	form	string	No
CS_DATA1	form	string	No
CS_DATA2	form	string	No
CS_DATA3	form	string	No
CS_DATA4	form	string	No
CS_DATA7	form	string	No
CS_DATA8	form	string	No
CREDIT_CARD_COMPANY_CODE	form	string	No
CREDIT_CARD_NUMBER	form	string	No
AIR_BOOKED_FLAG	form	string	No
DEPART_DATE	form	DateTime?	No
ITINERARY_DATES	form	string	No
DEPARTURE_ARRIVAL_TIMES	form	string	No
CARRIER_CD	form	string	No
VALIDATING_CARRIER_CD	form	string	No
PNR_SEGMENT_NO	form	int?	No
OPR_FLT_NO	form	string	No
CLASS	form	string	No
FARE_BASIS	form	string	No
TKT_TYPE	form	string	No
TKT_NO	form	string	No
NO_OF_DOCUMENTS	form	int?	No
STOPOVR_TRF_FLAG	form	string	No
TOUR_CODE	form	string	No
ITINERARY	form	string	No
LOC_CUR	form	string	No
FULL_FARE	form	string	No
FARE_PAID	form	string	No
LOW_FARE	form	string	No
LOC_TAX	form	string	No
SALES_CHANNEL	form	string	No
REASON_CODE	form	string	No
REASON_CODE_DENIED	form	string	No
AIR_NO_ACCOMODATION_REASON_CODE	form	string	No
ORIGINAL_DOCUMENT	form	string	No
REFUNDED_FARE	form	string	No
AIR_COMM_AMT	form	string	No
FFLYR_NO	form	string	No
HOTEL_BOOKED_FLAG	form	string	No
HOTEL_NAME	form	string	No
ADDRESS	form	string	No
CITY_COUNTRYCODE_ZIPCODE_PHONE	form	string	No
CHECKINDATE	form	string	No
HOTEL_CHAIN_CODE	form	string	No
HOTEL_GDS_PARTNER_CD_USED	form	string	No
GDS_RM_TYPE_CODE	form	string	No
RM_TYPE	form	string	No
HOTEL_VOUCHER_NO	form	string	No
RATE_TYPE_CODE	form	string	No
AREA_CODE	form	string	No
NIGHT_STAYS	form	string	No
ROOM_RATE_CUR	form	string	No
PAID_ROOM_RATE_PER_NIGHT	form	string	No
HOTEL_BOOK_MODE	form	string	No
HOTEL_REASON_CODE	form	string	No
HOTEL_COMM_AMT	form	string	No
CAR_BOOKED_FLAG	form	string	No
SUPPLIER_NAME	form	string	No
GDS_MASTER_SUPPLIER_CODE	form	string	No
CAR_GDS_PARTNER_CD_USED	form	string	No
GDS_CAR_TYPE_CODE	form	string	No
CAR_VOUCHER_NO	form	string	No
RENTAL_DAYS	form	string	No
CAR_RENT_RATE_CUR	form	string	No
PAID_CAR_RENT_RATE_PER_DAY	form	string	No
CAR_BOOK_MODE	form	string	No
PICKUPDATE	form	string	No
CAR_ITINERARY_CD	form	string	No
CAR_REASON_CODE	form	string	No
RAIL_FERRY_BOOKED_FLAG	form	string	No

**Report<TItemResponse, TItem>** Parameters:
Name	Parameter	Data Type	Required	Description
Item	form	TItem	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 //PartnerBookingDataCaptures 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>
    <Item>
      <ADDRESS>String</ADDRESS>
      <AGENCY_IATA>String</AGENCY_IATA>
      <AIR_BOOKED_FLAG>String</AIR_BOOKED_FLAG>
      <AIR_COMM_AMT>String</AIR_COMM_AMT>
      <AIR_NO_ACCOMODATION_REASON_CODE>String</AIR_NO_ACCOMODATION_REASON_CODE>
      <APPROVAL_CODE>String</APPROVAL_CODE>
      <APPROVER>String</APPROVER>
      <AREA_CODE>String</AREA_CODE>
      <CARRIER_CD>String</CARRIER_CD>
      <CAR_BOOKED_FLAG>String</CAR_BOOKED_FLAG>
      <CAR_BOOK_MODE>String</CAR_BOOK_MODE>
      <CAR_GDS_PARTNER_CD_USED>String</CAR_GDS_PARTNER_CD_USED>
      <CAR_ITINERARY_CD>String</CAR_ITINERARY_CD>
      <CAR_REASON_CODE>String</CAR_REASON_CODE>
      <CAR_RENT_RATE_CUR>String</CAR_RENT_RATE_CUR>
      <CAR_VOUCHER_NO>String</CAR_VOUCHER_NO>
      <CHECKINDATE>String</CHECKINDATE>
      <CITY_COUNTRYCODE_ZIPCODE_PHONE>String</CITY_COUNTRYCODE_ZIPCODE_PHONE>
      <CLASS>String</CLASS>
      <COST_CENTER_CODE>String</COST_CENTER_CODE>
      <CREDIT_CARD_COMPANY_CODE>String</CREDIT_CARD_COMPANY_CODE>
      <CREDIT_CARD_NUMBER>String</CREDIT_CARD_NUMBER>
      <CS_DATA1>String</CS_DATA1>
      <CS_DATA2>String</CS_DATA2>
      <CS_DATA3>String</CS_DATA3>
      <CS_DATA4>String</CS_DATA4>
      <CS_DATA7>String</CS_DATA7>
      <CS_DATA8>String</CS_DATA8>
      <DEPARTMENT_NUMBER>String</DEPARTMENT_NUMBER>
      <DEPARTURE_ARRIVAL_TIMES>String</DEPARTURE_ARRIVAL_TIMES>
      <DEPART_DATE>0001-01-01T00:00:00</DEPART_DATE>
      <EMPLOYEE_NUMBER>String</EMPLOYEE_NUMBER>
      <FARE_BASIS>String</FARE_BASIS>
      <FARE_PAID>String</FARE_PAID>
      <FFLYR_NO>String</FFLYR_NO>
      <FULL_FARE>String</FULL_FARE>
      <GDS_CAR_TYPE_CODE>String</GDS_CAR_TYPE_CODE>
      <GDS_MASTER_SUPPLIER_CODE>String</GDS_MASTER_SUPPLIER_CODE>
      <GDS_RECLOC>String</GDS_RECLOC>
      <GDS_RM_TYPE_CODE>String</GDS_RM_TYPE_CODE>
      <GLOBALCUST_NO>String</GLOBALCUST_NO>
      <HOTEL_BOOKED_FLAG>String</HOTEL_BOOKED_FLAG>
      <HOTEL_BOOK_MODE>String</HOTEL_BOOK_MODE>
      <HOTEL_CHAIN_CODE>String</HOTEL_CHAIN_CODE>
      <HOTEL_COMM_AMT>String</HOTEL_COMM_AMT>
      <HOTEL_GDS_PARTNER_CD_USED>String</HOTEL_GDS_PARTNER_CD_USED>
      <HOTEL_NAME>String</HOTEL_NAME>
      <HOTEL_REASON_CODE>String</HOTEL_REASON_CODE>
      <HOTEL_VOUCHER_NO>String</HOTEL_VOUCHER_NO>
      <ITINERARY>String</ITINERARY>
      <ITINERARY_DATES>String</ITINERARY_DATES>
      <LOCALCUST_NO>String</LOCALCUST_NO>
      <LOC_CUR>String</LOC_CUR>
      <LOC_TAX>String</LOC_TAX>
      <LOW_FARE>String</LOW_FARE>
      <MANAGER_SUPERIOR>String</MANAGER_SUPERIOR>
      <NIGHT_STAYS>String</NIGHT_STAYS>
      <NO_OF_DOCUMENTS>0</NO_OF_DOCUMENTS>
      <OPR_FLT_NO>String</OPR_FLT_NO>
      <ORDER_REFERENCE>String</ORDER_REFERENCE>
      <ORIGINAL_DOCUMENT>String</ORIGINAL_DOCUMENT>
      <PAID_CAR_RENT_RATE_PER_DAY>String</PAID_CAR_RENT_RATE_PER_DAY>
      <PAID_ROOM_RATE_PER_NIGHT>String</PAID_ROOM_RATE_PER_NIGHT>
      <PICKUPDATE>String</PICKUPDATE>
      <PNR_SEGMENT_NO>0</PNR_SEGMENT_NO>
      <PROJECT_NUMBER>String</PROJECT_NUMBER>
      <RAIL_FERRY_BOOKED_FLAG>String</RAIL_FERRY_BOOKED_FLAG>
      <RATE_TYPE_CODE>String</RATE_TYPE_CODE>
      <REASON_CODE>String</REASON_CODE>
      <REASON_CODE_DENIED>String</REASON_CODE_DENIED>
      <REASON_OF_TRIP>String</REASON_OF_TRIP>
      <REFUNDED_FARE>String</REFUNDED_FARE>
      <RENTAL_DAYS>String</RENTAL_DAYS>
      <RESERVATION_DATE>0001-01-01T00:00:00</RESERVATION_DATE>
      <RM_TYPE>String</RM_TYPE>
      <ROOM_RATE_CUR>String</ROOM_RATE_CUR>
      <SALES_CHANNEL>String</SALES_CHANNEL>
      <STOPOVR_TRF_FLAG>String</STOPOVR_TRF_FLAG>
      <SUPPLIER_NAME>String</SUPPLIER_NAME>
      <TKT_NO>String</TKT_NO>
      <TKT_TYPE>String</TKT_TYPE>
      <TOUR_CODE>String</TOUR_CODE>
      <TRAVELLER_NAME>String</TRAVELLER_NAME>
      <TRAVELLER_STATUS>String</TRAVELLER_STATUS>
      <TRVL_MTH>0</TRVL_MTH>
      <TRVL_YR>0</TRVL_YR>
      <VALIDATING_CARRIER_CD>String</VALIDATING_CARRIER_CD>
    </Item>
  </ResponseReport>
  <ResponseError>
    <ErrorCode>String</ErrorCode>
    <Message>String</Message>
    <StatusCode>String</StatusCode>
    <VerboseMessage>String</VerboseMessage>
  </ResponseError>
</AgentivityResponse>