Agentivity API

<back to all web services

ConsultantsGdsSegmentPerformance

// @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="ConsultantGdsSegmentPerformance", Namespace="schemas.agentivity.com/types")
export class ConsultantGdsSegmentPerformance
{
    // @DataMember(Order=10)
    public OwningConsultantID: string;

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

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

    // @DataMember(Order=40)
    public AirCount: number;

    // @DataMember(Order=42)
    public AirCountOnline: number;

    // @DataMember(Order=50)
    public HotelCount: number;

    // @DataMember(Order=52)
    public HotelCountOnline: number;

    // @DataMember(Order=60)
    public CarCount: number;

    // @DataMember(Order=62)
    public CarCountOnline: number;

    // @DataMember(Order=70)
    public PassiveHotelCount: number;

    // @DataMember(Order=72)
    public PassiveHotelCountOnline: number;

    // @DataMember(Order=80)
    public PassiveCarCount: number;

    // @DataMember(Order=82)
    public PassiveCarCountOnline: number;

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

    // @DataMember(Order=92)
    public TURCountOnline: number;

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

    // @DataMember(Order=102)
    public OtherCountOnline: number;

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

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

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

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

// @DataContract(Namespace="schemas.agentivity.com/types")
export class Report<TItemResponse, TItem>
{
    // @DataMember(Order=1, EmitDefaultValue=false)
    public Item: TItem;

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

// @DataContract(Name="ConsultantGdsSegmentPerformance", Namespace="schemas.agentivity.com/types")
export class ConsultantsGdsSegmentPerformanceResponseReport extends Report<ConsultantsGdsSegmentPerformanceItemResponse, ConsultantGdsSegmentPerformance>
{

    public constructor(init?: Partial<ConsultantsGdsSegmentPerformanceResponseReport>) { super(init); (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="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 ItemResponse<TItem, TReport>
{
    // @DataMember(Order=1)
    public ResponseMetadata: ResponseMetadata;

    // @DataMember(Order=2, EmitDefaultValue=false)
    public ResponseReport: TReport;

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

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

// @DataContract(Name="AgentivityResponse", Namespace="schemas.agentivity.com/types")
export class ConsultantsGdsSegmentPerformanceItemResponse extends ItemResponse<ConsultantGdsSegmentPerformance, ConsultantsGdsSegmentPerformanceResponseReport>
{

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

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

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

    /** @description Comma Delimited List of PCCs */
    // @DataMember
    public OwningAgencyLocationID: string[] = [];

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

TypeScript ConsultantsGdsSegmentPerformance DTOs

GET /ConsultantsGdsSegmentPerformance 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>
      <OwningConsultantID>String</OwningConsultantID>
      <OwningConsultant>String</OwningConsultant>
      <OwningAgencyLocationID>String</OwningAgencyLocationID>
      <AirCount>0</AirCount>
      <AirCountOnline>0</AirCountOnline>
      <HotelCount>0</HotelCount>
      <HotelCountOnline>0</HotelCountOnline>
      <CarCount>0</CarCount>
      <CarCountOnline>0</CarCountOnline>
      <PassiveHotelCount>0</PassiveHotelCount>
      <PassiveHotelCountOnline>0</PassiveHotelCountOnline>
      <PassiveCarCount>0</PassiveCarCount>
      <PassiveCarCountOnline>0</PassiveCarCountOnline>
      <TURCount>0</TURCount>
      <TURCountOnline>0</TURCountOnline>
      <OtherCount>0</OtherCount>
      <OtherCountOnline>0</OtherCountOnline>
      <TotalBookings>0</TotalBookings>
      <OwningAgencyLocationCountryCode>String</OwningAgencyLocationCountryCode>
      <OwningAgencyLocationCountryName>String</OwningAgencyLocationCountryName>
    </Item>
  </ResponseReport>
  <ResponseError>
    <ErrorCode>String</ErrorCode>
    <Message>String</Message>
    <StatusCode>String</StatusCode>
    <VerboseMessage>String</VerboseMessage>
  </ResponseError>
</AgentivityResponse>