Agentivity API

GetConsultantFocus

The following routes are available for this service:
All Verbs	/ConsultantFocus

**GetConsultantFocus** Parameters:
Name	Parameter	Data Type	Required	Description
DateStart	query	string	Yes	Date in format YYYYMMDD
DateEnd	query	string	Yes	Date in format YYYYMMDD
OwningConsultantID	query	string	Yes	Comma delimited list of owning consultants ids
TransactionAgencyLocationID	query	string	No	Comma delimited list of transaction agency location ids
Options	query	string	No	Options to retrieve consultant focus data. Use All to include the Active Unsold Air Bookings.
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

**ConsultantFocusResult** Parameters:
Name	Parameter	Data Type	Required
ProblematicSegments	form	List<ProblematicSegment>	No
AirlineDemandsForTicketing	form	List<AirlineDemandsForTicketing>	No
ActiveUnsoldAirBookings	form	List<ActiveUnsoldAirBookings>	No
BookingsWithWarnings	form	List<BookingWithWarnings>	No

**ProblematicSegment** Parameters:
Name	Parameter	Data Type	Required
RecordLocator	form	string	No
PNRCreationDate	form	DateTime?	No
OwningConsultantID	form	string	No
OwningConsultant	form	string	No
PrimaryPax	form	string	No
Account	form	string	No
SegmentStatus	form	string	No
Segment	form	string	No
OwningAgencyLocationID	form	string	No
GdsCode	form	string	No
DepartureDate	form	DateTime?	No
AgentivityRef	form	string	No

**AirlineDemandsForTicketing** Parameters:
Name	Parameter	Data Type	Required
RecordLocator	form	string	No
PNRCreationDate	form	DateTime?	No
PrimaryPax	form	string	No
OwningConsultantID	form	string	No
OwningConsultant	form	string	No
Account	form	string	No
AirlineCode	form	string	No
DueDate	form	DateTime?	No
DueTime	form	string	No
OwningAgencyLocationID	form	string	No
GdsCode	form	string	No
AgentivityRef	form	int?	No

**ActiveUnsoldAirBookings** Parameters:
Name	Parameter	Data Type	Required
RecordLocator	form	string	No
PNRCreationDate	form	DateTime?	No
OwningAgencyLocationID	form	string	No
GdsCode	form	string	No
PrimaryPax	form	string	No
OwningConsultant	form	string	No
OwningConsultantID	form	string	No
Account	form	string	No
PrimaryCarrierCode	form	string	No
FiledFare	form	string	No
TravelDate	form	DateTime?	No
DestinationCities	form	string	No
BookingClasses	form	string	No
AgentivityRef	form	int	No
Itinerary	form	ItinerarySegmentsCollection	No
ItineraryFormatted	form	string	No

**ItinerarySegment** Parameters:
Name	Parameter	Data Type	Required	Description
SegmentType	form	string	No
SegmentNbr	form	int	No
BoardPoint	form	string	No
OffPoint	form	string	No
OperatorCode	form	string	No
OperatorService	form	string	No
SegmentStatus	form	string	No
DepartureTimeFormatted	form	string	No
ArrivalTimeFormatted	form	string	No
ChangeOfDayFormatted	form	string	No
ServiceCode	form	string	No
StartDate	form	string	No
EndDate	form	string	No
TicketNumber	form	string	No
VendorLocators	query	string	No	Comma separated list of vendor locators
EquipmentCode	form	string	No
Equipment	form	string	No

**BookingWithWarnings** Parameters:
Name	Parameter	Data Type	Required
RecordLocator	form	string	No
PNRCreationDate	form	DateTime	No
AgentivityRef	form	int	No
OwningConsultant	form	string	No
Account	form	string	No
OwningConsultantID	form	string	No
OwningAgencyLocationID	form	string	No
GdsCode	form	string	No
TravelDate	form	DateTime?	No
PrimaryPax	form	string	No
WarningsList	form	List<BookingWarning>	No

**BookingWarning** Parameters:
Name	Parameter	Data Type	Required
WarningType	form	string	No
Vendor	form	string	No
VendorType	form	string	No
WarningDateTime	form	DateTime?	No
LogDateTime	form	DateTime?	No
OriginalRemark	form	string	No
PropertiesList	form	List<BookingWarningProperty>	No

**BookingWarningProperty** Parameters:
Name	Parameter	Data Type	Required	Description
Name	form	string	No
Value	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.

POST //ConsultantFocus HTTP/1.1 
Host: api.agentivity.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<GetConsultantFocus xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="schemas.agentivity.com/types">
  <Limit>String</Limit>
  <Offset>String</Offset>
  <ResponseRecords>0</ResponseRecords>
  <TotalRecords>0</TotalRecords>
  <OwningCompanyCode xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </OwningCompanyCode>
  <UserName>String</UserName>
  <DateEnd>String</DateEnd>
  <DateStart>String</DateStart>
  <Options>Default</Options>
  <OwningConsultantID xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </OwningConsultantID>
  <RequestConsultantID>String</RequestConsultantID>
  <TransactionAgencyLocationID xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </TransactionAgencyLocationID>
</GetConsultantFocus>

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>
    <ConsultantFocusResult>
      <ProblematicSegments>
        <ProblematicSegment>
          <RecordLocator>String</RecordLocator>
          <PNRCreationDate>0001-01-01T00:00:00</PNRCreationDate>
          <OwningConsultantID>String</OwningConsultantID>
          <OwningConsultant>String</OwningConsultant>
          <PrimaryPax>String</PrimaryPax>
          <Account>String</Account>
          <SegmentStatus>String</SegmentStatus>
          <Segment>String</Segment>
          <OwningAgencyLocationID>String</OwningAgencyLocationID>
          <GdsCode>String</GdsCode>
          <DepartureDate>0001-01-01T00:00:00</DepartureDate>
          <AgentivityRef>String</AgentivityRef>
        </ProblematicSegment>
      </ProblematicSegments>
      <AirlineDemandsForTicketing>
        <AirlineDemandsForTicketing>
          <RecordLocator>String</RecordLocator>
          <PNRCreationDate>0001-01-01T00:00:00</PNRCreationDate>
          <PrimaryPax>String</PrimaryPax>
          <OwningConsultantID>String</OwningConsultantID>
          <OwningConsultant>String</OwningConsultant>
          <Account>String</Account>
          <AirlineCode>String</AirlineCode>
          <DueDate>0001-01-01T00:00:00</DueDate>
          <DueTime>String</DueTime>
          <OwningAgencyLocationID>String</OwningAgencyLocationID>
          <GdsCode>String</GdsCode>
          <AgentivityRef>0</AgentivityRef>
        </AirlineDemandsForTicketing>
      </AirlineDemandsForTicketing>
      <ActiveUnsoldAirBookings>
        <ActiveUnsoldAirBookings>
          <RecordLocator>String</RecordLocator>
          <PNRCreationDate>0001-01-01T00:00:00</PNRCreationDate>
          <OwningAgencyLocationID>String</OwningAgencyLocationID>
          <GdsCode>String</GdsCode>
          <PrimaryPax>String</PrimaryPax>
          <OwningConsultant>String</OwningConsultant>
          <OwningConsultantID>String</OwningConsultantID>
          <Account>String</Account>
          <AgentivityRef>0</AgentivityRef>
          <PrimaryCarrierCode>String</PrimaryCarrierCode>
          <FiledFare>String</FiledFare>
          <TravelDate>0001-01-01T00:00:00</TravelDate>
          <DestinationCities>String</DestinationCities>
          <BookingClasses>String</BookingClasses>
          <Itinerary>
            <ItinerarySegment>
              <ArrivalTimeFormatted>String</ArrivalTimeFormatted>
              <BoardPoint>String</BoardPoint>
              <ChangeOfDayFormatted>String</ChangeOfDayFormatted>
              <DepartureTimeFormatted>String</DepartureTimeFormatted>
              <EndDate>String</EndDate>
              <Equipment>String</Equipment>
              <EquipmentCode>String</EquipmentCode>
              <OffPoint>String</OffPoint>
              <OperatorCode>String</OperatorCode>
              <OperatorService>String</OperatorService>
              <SegmentNbr>0</SegmentNbr>
              <SegmentStatus>String</SegmentStatus>
              <SegmentType>String</SegmentType>
              <ServiceCode>String</ServiceCode>
              <StartDate>String</StartDate>
              <TicketNumber>String</TicketNumber>
              <VendorLocators>String</VendorLocators>
            </ItinerarySegment>
          </Itinerary>
          <ItineraryFormatted>String</ItineraryFormatted>
        </ActiveUnsoldAirBookings>
      </ActiveUnsoldAirBookings>
      <BookingsWithWarnings>
        <BookingWithWarnings>
          <RecordLocator>String</RecordLocator>
          <PNRCreationDate>0001-01-01T00:00:00</PNRCreationDate>
          <AgentivityRef>0</AgentivityRef>
          <OwningConsultant>String</OwningConsultant>
          <Account>String</Account>
          <OwningConsultantID>String</OwningConsultantID>
          <OwningAgencyLocationID>String</OwningAgencyLocationID>
          <GdsCode>String</GdsCode>
          <TravelDate>0001-01-01T00:00:00</TravelDate>
          <PrimaryPax>String</PrimaryPax>
          <WarningsList>
            <Warning>
              <WarningType>String</WarningType>
              <Vendor>String</Vendor>
              <VendorType>String</VendorType>
              <WarningDateTime>0001-01-01T00:00:00</WarningDateTime>
              <LogDateTime>0001-01-01T00:00:00</LogDateTime>
              <OriginalRemark>String</OriginalRemark>
              <PropertiesList>
                <Property>
                  <Name>String</Name>
                  <Value>String</Value>
                </Property>
              </PropertiesList>
            </Warning>
          </WarningsList>
        </BookingWithWarnings>
      </BookingsWithWarnings>
    </ConsultantFocusResult>
  </ResponseReport>
  <ResponseError>
    <ErrorCode>String</ErrorCode>
    <Message>String</Message>
    <StatusCode>String</StatusCode>
    <VerboseMessage>String</VerboseMessage>
  </ResponseError>
</AgentivityResponse>