Agentivity API

<back to all web services

GetCancelledHotelSegments

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    // @DataMember(Order=150)
    public Currency: string;

    // @DataMember(Order=160)
    public Rate: string;

    // @DataMember(Order=170)
    public RoomBookingCode: string;

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

    // @DataMember(Order=190)
    public MultiLevelRateCode: string;

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

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

    // @DataMember(Order=220)
    public ServiceInformation: string;

    // @DataMember(Order=230)
    public CancellationDate?: string;

    // @DataMember(Order=240)
    public CancellationRemark: string;

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

    public constructor(init?: Partial<GetCancelledHotelSegmentsResponseReport>) { 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 GetCancelledHotelSegmentsItemResponse extends ItemResponse<CancelledHotelSegment, GetCancelledHotelSegmentsResponseReport>
{

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

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

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

    /** @description Comma Delimited List of CountryCodes */
    // @DataMember
    public OwningAgencyCountryCode: string[];

    /** @description Return only PNRs with/without an Cancellation Reference */
    // @DataMember
    public HasCancellationRemark?: boolean;

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

TypeScript GetCancelledHotelSegments 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 /CancelledHotelSegments 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":{"RecordLocator":"String","PNRCreationDate":"\/Date(-62135596800000-0000)\/","OwningAgencyLocationID":"String","Account":"String","OwningConsultantID":"String","OwningConsultant":"String","StatusCode":"String","ArrivalDate":"\/Date(-62135596800000-0000)\/","DepartureDate":"\/Date(-62135596800000-0000)\/","PropertyName":"String","Chain":"String","City":"String","Passenger":"String","ConfirmationNbr":"String","Currency":"String","Rate":"String","RoomBookingCode":"String","NbrNights":0,"MultiLevelRateCode":"String","NbrRooms":0,"BookedInName":"String","ServiceInformation":"String","CancellationDate":"\/Date(-62135596800000-0000)\/","CancellationRemark":"String"}},"ResponseError":{"ErrorCode":"String","Message":"String","StatusCode":"String","VerboseMessage":"String"}}