Agentivity API

<back to all web services

PassiveSegmentsByItinChangeEvent

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

    // @DataMember
    public Address: string;

    // @DataMember
    public BookingReasonCode: string;

    // @DataMember
    public BookingSource: string;

    // @DataMember
    public CityName: string;

    // @DataMember
    public ConfirmationNumber: string;

    // @DataMember
    public CommissionInformation: string;

    // @DataMember
    public EventDateTime: string;

    // @DataMember
    public NbrNights: string;

    // @DataMember
    public OwningAgencyLocationID: string;

    // @DataMember
    public OwningConsultant: string;

    // @DataMember
    public OwningConsultantID: string;

    // @DataMember
    public PNRCreationDate: string;

    // @DataMember
    public PrimaryPassenger: string;

    // @DataMember
    public PropertyName: string;

    // @DataMember
    public PropertyNumber: string;

    // @DataMember
    public RateAccessCode: string;

    // @DataMember
    public RateCode: string;

    // @DataMember
    public RateQuoted: string;

    // @DataMember
    public RecordLocator: string;

    // @DataMember
    public SegmentStatus: string;

    // @DataMember
    public SegmentType: string;

    // @DataMember
    public ServiceInformation: string;

    // @DataMember
    public StartDate: string;

    // @DataMember
    public Text: string;

    // @DataMember
    public VendorCode: string;

    public constructor(init?: Partial<PassiveSegmentItineraryChange>) { (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 PassiveSegmentsByItinChangeEventResponse extends CollectionResponse<PassiveSegmentItineraryChange>
{

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

// @DataContract(Namespace="schemas.agentivity.com/types")
export class PassiveSegmentsByItinChangeEvent extends CompanyLevelRequestBase
{
    /** @description Type of event */
    // @DataMember
    public EventType: string;

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

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

    /** @description Time in format HHMM */
    // @DataMember
    public EventTimeStart: string;

    /** @description Time in format HHMM */
    // @DataMember
    public EventTimeEnd: string;

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

TypeScript PassiveSegmentsByItinChangeEvent DTOs

GET /PassiveSegmentsByItinChangeEvent 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>
    <PassiveSegmentItineraryChange>
      <Account>String</Account>
      <Address>String</Address>
      <BookingReasonCode>String</BookingReasonCode>
      <BookingSource>String</BookingSource>
      <CityName>String</CityName>
      <CommissionInformation>String</CommissionInformation>
      <ConfirmationNumber>String</ConfirmationNumber>
      <EventDateTime>0001-01-01T00:00:00</EventDateTime>
      <NbrNights>String</NbrNights>
      <OwningAgencyLocationID>String</OwningAgencyLocationID>
      <OwningConsultant>String</OwningConsultant>
      <OwningConsultantID>String</OwningConsultantID>
      <PNRCreationDate>String</PNRCreationDate>
      <PrimaryPassenger>String</PrimaryPassenger>
      <PropertyName>String</PropertyName>
      <PropertyNumber>String</PropertyNumber>
      <RateAccessCode>String</RateAccessCode>
      <RateCode>String</RateCode>
      <RateQuoted>String</RateQuoted>
      <RecordLocator>String</RecordLocator>
      <SegmentStatus>String</SegmentStatus>
      <SegmentType>String</SegmentType>
      <ServiceInformation>String</ServiceInformation>
      <StartDate>String</StartDate>
      <Text>String</Text>
      <VendorCode>String</VendorCode>
    </PassiveSegmentItineraryChange>
  </ResponseReport>
  <ResponseError>
    <ErrorCode>String</ErrorCode>
    <Message>String</Message>
    <StatusCode>String</StatusCode>
    <VerboseMessage>String</VerboseMessage>
  </ResponseError>
</AgentivityResponse>