Agentivity API

<back to all web services

GetConsultantWorkActiveUnsoldAir

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

// @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="ActiveUnsoldAirBooking", Namespace="schemas.agentivity.com/types")
export class ConsultantActiveUnsoldAirBooking
{
    // @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=90)
    public AgentivityRef: number;

    // @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;

    public constructor(init?: Partial<ConsultantActiveUnsoldAirBooking>) { (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="ConsultantWorkActiveUnsoldAir", Namespace="schemas.agentivity.com/types")
export class GetConsultantWorkActiveUnsoldAirResponseReport extends Report<GetConsultantWorkActiveUnsoldAirItemResponse, ConsultantActiveUnsoldAirBooking>
{

    public constructor(init?: Partial<GetConsultantWorkActiveUnsoldAirResponseReport>) { 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 GetConsultantWorkActiveUnsoldAirItemResponse extends ItemResponse<ConsultantActiveUnsoldAirBooking, GetConsultantWorkActiveUnsoldAirResponseReport>
{

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

// @DataContract(Namespace="schemas.agentivity.com/types")
export class GetConsultantWorkActiveUnsoldAir 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 Request Consultant ID (sign on) */
    // @DataMember
    public RequestConsultantID: string;

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

TypeScript GetConsultantWorkActiveUnsoldAir DTOs

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 /ConsultantWorkActiveUnsoldAir HTTP/1.1 
Host: api.agentivity.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<GetConsultantWorkActiveUnsoldAir 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>
  <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>
</GetConsultantWorkActiveUnsoldAir>

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>
      <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>
    </Item>
  </ResponseReport>
  <ResponseError>
    <ErrorCode>String</ErrorCode>
    <Message>String</Message>
    <StatusCode>String</StatusCode>
    <VerboseMessage>String</VerboseMessage>
  </ResponseError>
</AgentivityResponse>