Agentivity API

<back to all web services

PassiveSegmentsByUser

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

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

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

    // @DataMember(Order=10)
    public RecordLocator: string;

    // @DataMember
    public OwningConsultantID: string;

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

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

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

    // @DataMember
    public StartDate: string;

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

    // @DataMember
    public NbrNights: string;

    // @DataMember
    public VendorCode: string;

    // @DataMember
    public CityCode: string;

    // @DataMember
    public SegmentType: string;

    // @DataMember
    public Text: string;

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

    // @DataMember
    public Address: string;

    // @DataMember
    public BookingReasonCode: string;

    // @DataMember
    public BookingSource: string;

    // @DataMember
    public CommissionInformation: string;

    // @DataMember
    public ConfirmationNumber: string;

    // @DataMember
    public RateCode: string;

    // @DataMember
    public RateQuoted: string;

    // @DataMember
    public RateAccessCode: string;

    // @DataMember
    public PropertyName: string;

    // @DataMember
    public PropertyNumber: string;

    // @DataMember
    public ServiceInformation: string;

    // @DataMember
    public TotalAirSegs: string;

    // @DataMember
    public HotelCommission: string;

    // @DataMember
    public CountryName: string;

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

    public constructor(init?: Partial<PassiveSegmentsByUserResponseReport>) { 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 PassiveSegmentsResponse extends ItemResponse<PassiveSegmentWithOwningInformation, PassiveSegmentsByUserResponseReport>
{

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

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

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

    /** @description Type of segment */
    // @DataMember
    public SegmentType: string;

    /** @description Account */
    // @DataMember
    public Account: string;

    /** @description 3 letter city code */
    // @DataMember
    public CityCode: string;

    /** @description Date search type option, a single character (T to search by segment start dates, C to search by booking creation dates). */
    // @DataMember
    public DateSearchType: string;

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

TypeScript PassiveSegmentsByUser DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /PassiveSegments HTTP/1.1 
Host: api.agentivity.com 
Accept: application/json

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"ResponseMetadata":{"Success":false,"HasCache":false,"HasPaging":false,"CacheMetadata":{"IsFromCache":false,"CachedAt":"\/Date(-62135596800000-0000)\/","CacheExpiresAt":"\/Date(-62135596800000-0000)\/"},"PagingMetadata":{"Offset":"String","Limit":"String","TotalRecords":0,"ResponseRecords":0}},"ResponseReport":{"Item":{"AgentivityRef":0,"OwningConsultantID":"String","StartDate":"String","NbrNights":"String","VendorCode":"String","CityCode":"String","SegmentType":"String","Text":"String","Address":"String","BookingReasonCode":"String","BookingSource":"String","CommissionInformation":"String","ConfirmationNumber":"String","RateCode":"String","RateQuoted":"String","RateAccessCode":"String","PropertyName":"String","PropertyNumber":"String","ServiceInformation":"String","TotalAirSegs":"String","HotelCommission":"String","CountryName":"String","RecordLocator":"String","OwningAgencyLocationID":"String","OwningConsultant":"String","Account":"String","Passenger":"String","DepartureDate":"String","SegmentStatus":"String"}},"ResponseError":{"ErrorCode":"String","Message":"String","StatusCode":"String","VerboseMessage":"String"}}