Agentivity API

<back to all web services

GetConsultantWorkGDSActions

"use strict";
export class PagingMetadata {
    /** @param {{Offset?:string,Limit?:string,TotalRecords?:number,ResponseRecords?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description Starting Record */
    Offset;
    /**
     * @type {string}
     * @description Number of records to return (PageSize) */
    Limit;
    /**
     * @type {number}
     * @description Total Number of Records in a Full Reponse (if no paging) */
    TotalRecords;
    /**
     * @type {number}
     * @description Total Number of Records in this Reponse (on this page) */
    ResponseRecords;
}
export class CompanyLevelRequestBase extends PagingMetadata {
    /** @param {{OwningCompanyCode?:string[],UserName?:string,Offset?:string,Limit?:string,TotalRecords?:number,ResponseRecords?:number}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /**
     * @type {string[]}
     * @description Comma Delimited List of Owning Company Codes */
    OwningCompanyCode;
    /**
     * @type {string}
     * @description UserName in form of an email address */
    UserName;
}
export class ProblematicSegment {
    /** @param {{RecordLocator?:string,PNRCreationDate?:string,OwningConsultantID?:string,OwningConsultant?:string,PrimaryPax?:string,Account?:string,SegmentStatus?:string,Segment?:string,OwningAgencyLocationID?:string,GdsCode?:string,DepartureDate?:string,AgentivityRef?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    RecordLocator;
    /** @type {?string} */
    PNRCreationDate;
    /** @type {string} */
    OwningConsultantID;
    /** @type {string} */
    OwningConsultant;
    /** @type {string} */
    PrimaryPax;
    /** @type {string} */
    Account;
    /** @type {string} */
    SegmentStatus;
    /** @type {string} */
    Segment;
    /** @type {string} */
    OwningAgencyLocationID;
    /** @type {string} */
    GdsCode;
    /** @type {?string} */
    DepartureDate;
    /** @type {string} */
    AgentivityRef;
}
export class ConsultantProblematicSegment extends ProblematicSegment {
    /** @param {{RecordLocator?:string,PNRCreationDate?:string,OwningConsultantID?:string,OwningConsultant?:string,PrimaryPax?:string,Account?:string,SegmentStatus?:string,Segment?:string,OwningAgencyLocationID?:string,GdsCode?:string,DepartureDate?:string,AgentivityRef?:string}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
}
export class AirlineDemandsForTicketing {
    /** @param {{RecordLocator?:string,PNRCreationDate?:string,PrimaryPax?:string,OwningConsultantID?:string,OwningConsultant?:string,Account?:string,AirlineCode?:string,DueDate?:string,DueTime?:string,OwningAgencyLocationID?:string,GdsCode?:string,AgentivityRef?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    RecordLocator;
    /** @type {?string} */
    PNRCreationDate;
    /** @type {string} */
    PrimaryPax;
    /** @type {string} */
    OwningConsultantID;
    /** @type {string} */
    OwningConsultant;
    /** @type {string} */
    Account;
    /** @type {string} */
    AirlineCode;
    /** @type {?string} */
    DueDate;
    /** @type {string} */
    DueTime;
    /** @type {string} */
    OwningAgencyLocationID;
    /** @type {string} */
    GdsCode;
    /** @type {?number} */
    AgentivityRef;
}
export class ConsultantAirlineDemandsForTicketing extends AirlineDemandsForTicketing {
    /** @param {{RecordLocator?:string,PNRCreationDate?:string,PrimaryPax?:string,OwningConsultantID?:string,OwningConsultant?:string,Account?:string,AirlineCode?:string,DueDate?:string,DueTime?:string,OwningAgencyLocationID?:string,GdsCode?:string,AgentivityRef?:number}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
}
export class BookingWarningProperty {
    /** @param {{Name?:string,Value?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Name;
    /** @type {string} */
    Value;
}
export class BookingWarning {
    /** @param {{WarningType?:string,Vendor?:string,VendorType?:string,WarningDateTime?:string,LogDateTime?:string,OriginalRemark?:string,PropertiesList?:BookingWarningProperty[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    WarningType;
    /** @type {string} */
    Vendor;
    /** @type {string} */
    VendorType;
    /** @type {?string} */
    WarningDateTime;
    /** @type {?string} */
    LogDateTime;
    /** @type {string} */
    OriginalRemark;
    /** @type {BookingWarningProperty[]} */
    PropertiesList;
}
export class BookingWithWarnings {
    /** @param {{RecordLocator?:string,PNRCreationDate?:string,AgentivityRef?:number,OwningConsultant?:string,Account?:string,OwningConsultantID?:string,OwningAgencyLocationID?:string,GdsCode?:string,TravelDate?:string,PrimaryPax?:string,WarningsList?:BookingWarning[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    RecordLocator;
    /** @type {string} */
    PNRCreationDate;
    /** @type {number} */
    AgentivityRef;
    /** @type {string} */
    OwningConsultant;
    /** @type {string} */
    Account;
    /** @type {string} */
    OwningConsultantID;
    /** @type {string} */
    OwningAgencyLocationID;
    /** @type {string} */
    GdsCode;
    /** @type {?string} */
    TravelDate;
    /** @type {string} */
    PrimaryPax;
    /** @type {BookingWarning[]} */
    WarningsList;
}
export class ConsultantWorkGDSAction {
    /** @param {{ProblematicSegmentList?:ConsultantProblematicSegment[],AirlineDemandsForTicketingList?:ConsultantAirlineDemandsForTicketing[],BookingsWithWarningsList?:BookingWithWarnings[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ConsultantProblematicSegment[]} */
    ProblematicSegmentList;
    /** @type {ConsultantAirlineDemandsForTicketing[]} */
    AirlineDemandsForTicketingList;
    /** @type {BookingWithWarnings[]} */
    BookingsWithWarningsList;
}
export class CacheMetadata {
    /** @param {{CachedAt?:string,CacheExpiresAt?:string,IsFromCache?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    CachedAt;
    /** @type {string} */
    CacheExpiresAt;
    /** @type {boolean} */
    IsFromCache;
}
export class ResponseMetadata {
    /** @param {{Success?:boolean,HasCache?:boolean,HasPaging?:boolean,CacheMetadata?:CacheMetadata,PagingMetadata?:PagingMetadata}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {boolean} */
    Success;
    /** @type {boolean} */
    HasCache;
    /** @type {boolean} */
    HasPaging;
    /** @type {CacheMetadata} */
    CacheMetadata;
    /** @type {PagingMetadata} */
    PagingMetadata;
}
export class ApiRequestPerHour {
    /** @param {{RequestDate?:string,Hour0?:number,Hour1?:number,Hour2?:number,Hour3?:number,Hour4?:number,Hour5?:number,Hour6?:number,Hour7?:number,Hour8?:number,Hour9?:number,Hour10?:number,Hour11?:number,Hour12?:number,Hour13?:number,Hour14?:number,Hour15?:number,Hour16?:number,Hour17?:number,Hour18?:number,Hour19?:number,Hour20?:number,Hour21?:number,Hour22?:number,Hour23?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    RequestDate;
    /** @type {number} */
    Hour0;
    /** @type {number} */
    Hour1;
    /** @type {number} */
    Hour2;
    /** @type {number} */
    Hour3;
    /** @type {number} */
    Hour4;
    /** @type {number} */
    Hour5;
    /** @type {number} */
    Hour6;
    /** @type {number} */
    Hour7;
    /** @type {number} */
    Hour8;
    /** @type {number} */
    Hour9;
    /** @type {number} */
    Hour10;
    /** @type {number} */
    Hour11;
    /** @type {number} */
    Hour12;
    /** @type {number} */
    Hour13;
    /** @type {number} */
    Hour14;
    /** @type {number} */
    Hour15;
    /** @type {number} */
    Hour16;
    /** @type {number} */
    Hour17;
    /** @type {number} */
    Hour18;
    /** @type {number} */
    Hour19;
    /** @type {number} */
    Hour20;
    /** @type {number} */
    Hour21;
    /** @type {number} */
    Hour22;
    /** @type {number} */
    Hour23;
}
export class AgentivityError {
    /** @param {{ErrorCode?:string,Message?:string,StatusCode?:string,VerboseMessage?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    ErrorCode;
    /** @type {string} */
    Message;
    /** @type {string} */
    StatusCode;
    /** @type {string} */
    VerboseMessage;
}
/** @typedef TItem {any} */
export class CollectionResponse {
    /** @param {{ResponseMetadata?:ResponseMetadata,ResponseReport?:ApiRequestPerHour[],ResponseError?:AgentivityError}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseMetadata} */
    ResponseMetadata;
    /** @type {ApiRequestPerHour[]} */
    ResponseReport;
    /** @type {AgentivityError} */
    ResponseError;
}
export class GetConsultantWorkGDSActionsResponse extends CollectionResponse {
    /** @param {{ResponseMetadata?:ResponseMetadata,ResponseReport?:ApiRequestPerHour[],ResponseError?:AgentivityError}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
}
export class GetConsultantWorkGDSActions extends CompanyLevelRequestBase {
    /** @param {{DateStart?:string,DateEnd?:string,OwningConsultantID?:string[],TransactionAgencyLocationID?:string[],RequestConsultantID?:string,OwningCompanyCode?:string[],UserName?:string,Offset?:string,Limit?:string,TotalRecords?:number,ResponseRecords?:number}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /**
     * @type {string}
     * @description Date in format YYYYMMDD */
    DateStart;
    /**
     * @type {string}
     * @description Date in format YYYYMMDD */
    DateEnd;
    /**
     * @type {string[]}
     * @description Comma delimited list of owning consultants ids */
    OwningConsultantID = [];
    /**
     * @type {string[]}
     * @description Comma delimited list of transaction agency location ids */
    TransactionAgencyLocationID;
    /**
     * @type {string}
     * @description Request Consultant ID (sign on) */
    RequestConsultantID;
}

JavaScript GetConsultantWorkGDSActions DTOs

POST /ConsultantWorkGDSActions HTTP/1.1 
Host: servicestack.agentivity.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

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

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>
    <ConsultantWorkGDSAction>
      <ProblematicSegmentList>
        <ProblematicSegment>
          <RecordLocator>String</RecordLocator>
          <PNRCreationDate>0001-01-01T00:00:00</PNRCreationDate>
          <OwningConsultantID>String</OwningConsultantID>
          <OwningConsultant>String</OwningConsultant>
          <PrimaryPax>String</PrimaryPax>
          <Account>String</Account>
          <SegmentStatus>String</SegmentStatus>
          <Segment>String</Segment>
          <OwningAgencyLocationID>String</OwningAgencyLocationID>
          <GdsCode>String</GdsCode>
          <DepartureDate>0001-01-01T00:00:00</DepartureDate>
          <AgentivityRef>String</AgentivityRef>
        </ProblematicSegment>
      </ProblematicSegmentList>
      <AirlineDemandsForTicketingList>
        <AirlineDemandsForTicketing>
          <RecordLocator>String</RecordLocator>
          <PNRCreationDate>0001-01-01T00:00:00</PNRCreationDate>
          <PrimaryPax>String</PrimaryPax>
          <OwningConsultantID>String</OwningConsultantID>
          <OwningConsultant>String</OwningConsultant>
          <Account>String</Account>
          <AirlineCode>String</AirlineCode>
          <DueDate>0001-01-01T00:00:00</DueDate>
          <DueTime>String</DueTime>
          <OwningAgencyLocationID>String</OwningAgencyLocationID>
          <GdsCode>String</GdsCode>
          <AgentivityRef>0</AgentivityRef>
        </AirlineDemandsForTicketing>
      </AirlineDemandsForTicketingList>
      <BookingsWithWarningsList>
        <BookingWithWarnings>
          <RecordLocator>String</RecordLocator>
          <PNRCreationDate>0001-01-01T00:00:00</PNRCreationDate>
          <AgentivityRef>0</AgentivityRef>
          <OwningConsultant>String</OwningConsultant>
          <Account>String</Account>
          <OwningConsultantID>String</OwningConsultantID>
          <OwningAgencyLocationID>String</OwningAgencyLocationID>
          <GdsCode>String</GdsCode>
          <TravelDate>0001-01-01T00:00:00</TravelDate>
          <PrimaryPax>String</PrimaryPax>
          <WarningsList>
            <Warning>
              <WarningType>String</WarningType>
              <Vendor>String</Vendor>
              <VendorType>String</VendorType>
              <WarningDateTime>0001-01-01T00:00:00</WarningDateTime>
              <LogDateTime>0001-01-01T00:00:00</LogDateTime>
              <OriginalRemark>String</OriginalRemark>
              <PropertiesList>
                <Property>
                  <Name>String</Name>
                  <Value>String</Value>
                </Property>
              </PropertiesList>
            </Warning>
          </WarningsList>
        </BookingWithWarnings>
      </BookingsWithWarningsList>
    </ConsultantWorkGDSAction>
  </ResponseReport>
  <ResponseError>
    <ErrorCode>String</ErrorCode>
    <Message>String</Message>
    <StatusCode>String</StatusCode>
    <VerboseMessage>String</VerboseMessage>
  </ResponseError>
</AgentivityResponse>