Agentivity API

<back to all web services

GetConsultantFocus

// @DataContract(Name="Metadata", Namespace="schemas.agentivity.com/types")
export class PagingMetadata
{
    /** @description Starting Record */
    // @DataMember
    // @ApiMember(DataType="string", Description="Starting Record", Name="Offset", ParameterType="query")
    public Offset: string;

    /** @description Number of records to return (PageSize) */
    // @DataMember
    // @ApiMember(DataType="string", Description="Number of records to return (PageSize)", Name="Limit", ParameterType="query")
    public Limit: string;

    /** @description Total Number of Records in a Full Reponse (if no paging) */
    // @DataMember
    // @ApiMember(DataType="string", Description="Total Number of Records in a Full Reponse (if no paging)", Name="TotalRecords", ParameterType="query")
    public TotalRecords: number;

    /** @description Total Number of Records in this Reponse (on this page) */
    // @DataMember
    // @ApiMember(DataType="string", Description="Total Number of Records in this Reponse (on this page)", Name="ResponseRecords", ParameterType="query")
    public ResponseRecords: number;

    public constructor(init?: Partial<PagingMetadata>) { (Object as any).assign(this, init); }
}

// @DataContract(Namespace="schemas.agentivity.com/types")
export class CompanyLevelRequestBase extends PagingMetadata implements IMemberUsername, IMemberOwningCompanyCode
{
    /** @description Comma Delimited List of Owning Company Codes */
    // @DataMember
    public OwningCompanyCode: string[];

    /** @description UserName in form of an email address */
    // @DataMember
    public UserName: string;

    public constructor(init?: Partial<CompanyLevelRequestBase>) { super(init); (Object as any).assign(this, init); }
}

// @DataContract(Name="ProblematicSegment", Namespace="schemas.agentivity.com/types")
export class ProblematicSegment
{
    // @DataMember(Order=10)
    public RecordLocator: string;

    // @DataMember(Order=15)
    public PNRCreationDate?: string;

    // @DataMember(Order=20)
    public OwningConsultantID: string;

    // @DataMember(Order=25)
    public OwningConsultant: string;

    // @DataMember(Order=30)
    public PrimaryPax: string;

    // @DataMember(Order=50)
    public Account: string;

    // @DataMember(Order=60)
    public SegmentStatus: string;

    // @DataMember(Order=70)
    public Segment: string;

    // @DataMember(Order=80)
    public OwningAgencyLocationID: string;

    // @DataMember(Order=90)
    public GdsCode: string;

    // @DataMember(Order=100)
    public DepartureDate?: string;

    // @DataMember(Order=110)
    public AgentivityRef: string;

    public constructor(init?: Partial<ProblematicSegment>) { (Object as any).assign(this, init); }
}

// @DataContract(Name="AirlineDemandsForTicketing", Namespace="schemas.agentivity.com/types")
export class AirlineDemandsForTicketing
{
    // @DataMember(Order=10)
    public RecordLocator: string;

    // @DataMember(Order=15)
    public PNRCreationDate?: string;

    // @DataMember(Order=20)
    public PrimaryPax: string;

    // @DataMember(Order=30)
    public OwningConsultantID: string;

    // @DataMember(Order=35)
    public OwningConsultant: string;

    // @DataMember(Order=40)
    public Account: string;

    // @DataMember(Order=50)
    public AirlineCode: string;

    // @DataMember(Order=55)
    public DueDate?: string;

    // @DataMember(Order=60)
    public DueTime: string;

    // @DataMember(Order=70)
    public OwningAgencyLocationID: string;

    // @DataMember(Order=80)
    public GdsCode: string;

    // @DataMember(Order=90)
    public AgentivityRef?: number;

    public constructor(init?: Partial<AirlineDemandsForTicketing>) { (Object as any).assign(this, init); }
}

// @DataContract(Name="ItinerarySegment", Namespace="schemas.agentivity.com/types")
export class ItinerarySegment
{
    // @DataMember
    public SegmentType: string;

    // @DataMember
    public SegmentNbr: number;

    // @DataMember
    public BoardPoint: string;

    // @DataMember
    public OffPoint: string;

    // @DataMember
    public OperatorCode: string;

    // @DataMember
    public OperatorService: string;

    // @DataMember
    public SegmentStatus: string;

    // @DataMember
    public DepartureTimeFormatted: string;

    // @DataMember
    public ArrivalTimeFormatted: string;

    // @DataMember
    public ChangeOfDayFormatted: string;

    // @DataMember
    public ServiceCode: string;

    // @DataMember
    public StartDate: string;

    // @DataMember
    public EndDate: string;

    // @DataMember
    public TicketNumber: string;

    /** @description Comma separated list of vendor locators */
    // @DataMember
    public VendorLocators: string;

    // @DataMember
    public EquipmentCode: string;

    // @DataMember
    public Equipment: string;

    public constructor(init?: Partial<ItinerarySegment>) { (Object as any).assign(this, init); }
}

export class ItinerarySegmentsCollection extends Array<ItinerarySegment>
{

    public constructor(init?: Partial<ItinerarySegmentsCollection>) { super(); (Object as any).assign(this, init); }
}

// @DataContract(Name="ActiveUnsoldAirBookings", Namespace="schemas.agentivity.com/types")
export class ActiveUnsoldAirBookings implements IBookingItinerary
{
    // @DataMember(Order=10)
    public RecordLocator: string;

    // @DataMember(Order=20)
    public PNRCreationDate?: string;

    // @DataMember(Order=30)
    public OwningAgencyLocationID: string;

    // @DataMember(Order=35)
    public GdsCode: string;

    // @DataMember(Order=40)
    public PrimaryPax: string;

    // @DataMember(Order=50)
    public OwningConsultant: string;

    // @DataMember(Order=55)
    public OwningConsultantID: string;

    // @DataMember(Order=60)
    public Account: string;

    // @DataMember(Order=100)
    public PrimaryCarrierCode: string;

    // @DataMember(Order=110)
    public FiledFare: string;

    // @DataMember(Order=120)
    public TravelDate?: string;

    // @DataMember(Order=130)
    public DestinationCities: string;

    // @DataMember(Order=140)
    public BookingClasses: string;

    // @DataMember(Order=90)
    public AgentivityRef: number;

    // @DataMember(Order=200)
    public Itinerary: ItinerarySegmentsCollection;

    // @DataMember(Order=210)
    public ItineraryFormatted: string;

    public constructor(init?: Partial<ActiveUnsoldAirBookings>) { (Object as any).assign(this, init); }
}

// @DataContract(Name="Property", Namespace="schemas.agentivity.com/types")
export class BookingWarningProperty
{
    // @DataMember(Order=10)
    public Name: string;

    // @DataMember(Order=20)
    public Value: string;

    public constructor(init?: Partial<BookingWarningProperty>) { (Object as any).assign(this, init); }
}

// @DataContract(Name="Warning", Namespace="schemas.agentivity.com/types")
export class BookingWarning
{
    // @DataMember(Order=10)
    public WarningType: string;

    // @DataMember(Order=20)
    public Vendor: string;

    // @DataMember(Order=30)
    public VendorType: string;

    // @DataMember(Order=40)
    public WarningDateTime?: string;

    // @DataMember(Order=50)
    public LogDateTime?: string;

    // @DataMember(Order=60)
    public OriginalRemark: string;

    // @DataMember(Order=70)
    public PropertiesList: BookingWarningProperty[];

    public constructor(init?: Partial<BookingWarning>) { (Object as any).assign(this, init); }
}

// @DataContract(Name="BookingWithWarnings", Namespace="schemas.agentivity.com/types")
export class BookingWithWarnings
{
    // @DataMember(Order=10)
    public RecordLocator: string;

    // @DataMember(Order=20)
    public PNRCreationDate: string;

    // @DataMember(Order=30)
    public AgentivityRef: number;

    // @DataMember(Order=40)
    public OwningConsultant: string;

    // @DataMember(Order=50)
    public Account: string;

    // @DataMember(Order=60)
    public OwningConsultantID: string;

    // @DataMember(Order=70)
    public OwningAgencyLocationID: string;

    // @DataMember(Order=75)
    public GdsCode: string;

    // @DataMember(Order=80)
    public TravelDate?: string;

    // @DataMember(Order=90)
    public PrimaryPax: string;

    // @DataMember(Order=1000)
    public WarningsList: BookingWarning[];

    public constructor(init?: Partial<BookingWithWarnings>) { (Object as any).assign(this, init); }
}

// @DataContract(Name="ConsultantFocusResult", Namespace="schemas.agentivity.com/types")
export class ConsultantFocusResult
{
    // @DataMember(Order=10)
    public ProblematicSegments: ProblematicSegment[];

    // @DataMember(Order=20)
    public AirlineDemandsForTicketing: AirlineDemandsForTicketing[];

    // @DataMember(Order=30)
    public ActiveUnsoldAirBookings: ActiveUnsoldAirBookings[];

    // @DataMember(Order=40)
    public BookingsWithWarnings: BookingWithWarnings[];

    public constructor(init?: Partial<ConsultantFocusResult>) { (Object as any).assign(this, init); }
}

// @DataContract(Name="CacheMetadata", Namespace="schemas.agentivity.com/types")
export class CacheMetadata
{
    // @DataMember(Order=1)
    public CachedAt: string;

    // @DataMember(Order=2)
    public CacheExpiresAt: string;

    // @DataMember(Order=0)
    public IsFromCache: boolean;

    public constructor(init?: Partial<CacheMetadata>) { (Object as any).assign(this, init); }
}

// @DataContract(Name="ResponseMetadata", Namespace="schemas.agentivity.com/types")
export class ResponseMetadata
{
    // @DataMember(Order=0)
    public Success: boolean;

    // @DataMember(Order=1)
    public HasCache: boolean;

    // @DataMember(Order=2)
    public HasPaging: boolean;

    // @DataMember(Order=3, EmitDefaultValue=false)
    public CacheMetadata: CacheMetadata;

    // @DataMember(Order=4, EmitDefaultValue=false)
    public PagingMetadata: PagingMetadata;

    public constructor(init?: Partial<ResponseMetadata>) { (Object as any).assign(this, init); }
}

// @DataContract(Name="ApiRequestPerHour", Namespace="schemas.agentivity.com/types")
export class ApiRequestPerHour
{
    // @DataMember(Order=10)
    public RequestDate: string;

    // @DataMember(Order=100)
    public Hour0: number;

    // @DataMember(Order=110)
    public Hour1: number;

    // @DataMember(Order=120)
    public Hour2: number;

    // @DataMember(Order=130)
    public Hour3: number;

    // @DataMember(Order=140)
    public Hour4: number;

    // @DataMember(Order=150)
    public Hour5: number;

    // @DataMember(Order=160)
    public Hour6: number;

    // @DataMember(Order=170)
    public Hour7: number;

    // @DataMember(Order=180)
    public Hour8: number;

    // @DataMember(Order=190)
    public Hour9: number;

    // @DataMember(Order=200)
    public Hour10: number;

    // @DataMember(Order=210)
    public Hour11: number;

    // @DataMember(Order=220)
    public Hour12: number;

    // @DataMember(Order=230)
    public Hour13: number;

    // @DataMember(Order=240)
    public Hour14: number;

    // @DataMember(Order=250)
    public Hour15: number;

    // @DataMember(Order=260)
    public Hour16: number;

    // @DataMember(Order=270)
    public Hour17: number;

    // @DataMember(Order=280)
    public Hour18: number;

    // @DataMember(Order=290)
    public Hour19: number;

    // @DataMember(Order=300)
    public Hour20: number;

    // @DataMember(Order=310)
    public Hour21: number;

    // @DataMember(Order=320)
    public Hour22: number;

    // @DataMember(Order=330)
    public Hour23: number;

    public constructor(init?: Partial<ApiRequestPerHour>) { (Object as any).assign(this, init); }
}

// @DataContract(Name="ResponseMetadata", Namespace="schemas.agentivity.com/types")
export class AgentivityError
{
    // @DataMember
    public ErrorCode: string;

    // @DataMember
    public Message: string;

    // @DataMember
    public StatusCode: string;

    // @DataMember
    public VerboseMessage: string;

    public constructor(init?: Partial<AgentivityError>) { (Object as any).assign(this, init); }
}

// @DataContract(Name="AgentivityResponse", Namespace="schemas.agentivity.com/types")
export class CollectionResponse<TItem>
{
    // @DataMember(Order=1)
    public ResponseMetadata: ResponseMetadata;

    // @DataMember(Order=2, EmitDefaultValue=false)
    public ResponseReport: ApiRequestPerHour[];

    // @DataMember(Order=3, EmitDefaultValue=false)
    public ResponseError: AgentivityError;

    public constructor(init?: Partial<CollectionResponse<TItem>>) { (Object as any).assign(this, init); }
}

// @DataContract(Name="AgentivityResponse", Namespace="schemas.agentivity.com/types")
export class GetConsultantFocusResponse extends CollectionResponse<ConsultantFocusResult>
{

    public constructor(init?: Partial<GetConsultantFocusResponse>) { super(init); (Object as any).assign(this, init); }
}

// @Flags()
export enum ConsultantFocusOptions
{
    Default = 0,
    ProblematicSegments = 1,
    AirlineDemandsForTicketing = 2,
    Standard = 3,
    ActiveUnsoldAirBookings = 4,
    BookingsWithWarnings = 8,
    All = 15,
}

// @DataContract(Namespace="schemas.agentivity.com/types")
export class GetConsultantFocus extends CompanyLevelRequestBase implements IRequestConsultantID
{
    /** @description Date in format YYYYMMDD */
    // @DataMember
    public DateStart: string;

    /** @description Date in format YYYYMMDD */
    // @DataMember
    public DateEnd: string;

    /** @description Comma delimited list of owning consultants ids */
    // @DataMember
    public OwningConsultantID: string[] = [];

    /** @description Comma delimited list of transaction agency location ids */
    // @DataMember
    public TransactionAgencyLocationID: string[];

    /** @description Options to retrieve consultant focus data. Use All to include the Active Unsold Air Bookings. */
    // @DataMember
    public Options: ConsultantFocusOptions;

    /** @description Request Consultant ID (sign on) */
    // @DataMember
    public RequestConsultantID: string;

    public constructor(init?: Partial<GetConsultantFocus>) { super(init); (Object as any).assign(this, init); }
}

TypeScript GetConsultantFocus DTOs

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>