Agentivity API

GetConsultantFocus

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

import Foundation
import ServiceStack

// @DataContract(Namespace="schemas.agentivity.com/types")
public class GetConsultantFocus : CompanyLevelRequestBase, IRequestConsultantID
{
    /**
    * Date in format YYYYMMDD
    */
    // @DataMember
    public var dateStart:String

    /**
    * Date in format YYYYMMDD
    */
    // @DataMember
    public var dateEnd:String

    /**
    * Comma delimited list of owning consultants ids
    */
    // @DataMember
    public var owningConsultantID:[String] = []

    /**
    * Comma delimited list of transaction agency location ids
    */
    // @DataMember
    public var transactionAgencyLocationID:[String]

    /**
    * Options to retrieve consultant focus data. Use All to include the Active Unsold Air Bookings.
    */
    // @DataMember
    public var options:ConsultantFocusOptions

    /**
    * Request Consultant ID (sign on)
    */
    // @DataMember
    public var requestConsultantID:String

    required public init(){ super.init() }

    private enum CodingKeys : String, CodingKey {
        case dateStart
        case dateEnd
        case owningConsultantID
        case transactionAgencyLocationID
        case options
        case requestConsultantID
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        dateStart = try container.decodeIfPresent(String.self, forKey: .dateStart)
        dateEnd = try container.decodeIfPresent(String.self, forKey: .dateEnd)
        owningConsultantID = try container.decodeIfPresent([String].self, forKey: .owningConsultantID) ?? []
        transactionAgencyLocationID = try container.decodeIfPresent([String].self, forKey: .transactionAgencyLocationID) ?? []
        options = try container.decodeIfPresent(ConsultantFocusOptions.self, forKey: .options)
        requestConsultantID = try container.decodeIfPresent(String.self, forKey: .requestConsultantID)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if dateStart != nil { try container.encode(dateStart, forKey: .dateStart) }
        if dateEnd != nil { try container.encode(dateEnd, forKey: .dateEnd) }
        if owningConsultantID.count > 0 { try container.encode(owningConsultantID, forKey: .owningConsultantID) }
        if transactionAgencyLocationID != nil { try container.encode(transactionAgencyLocationID, forKey: .transactionAgencyLocationID) }
        if options != nil { try container.encode(options, forKey: .options) }
        if requestConsultantID != nil { try container.encode(requestConsultantID, forKey: .requestConsultantID) }
    }
}

// @DataContract(Namespace="schemas.agentivity.com/types")
public class CompanyLevelRequestBase : PagingMetadata, IMemberUsername, IMemberOwningCompanyCode
{
    /**
    * Comma Delimited List of Owning Company Codes
    */
    // @DataMember
    public var owningCompanyCode:[String]

    /**
    * UserName in form of an email address
    */
    // @DataMember
    public var userName:String

    required public init(){ super.init() }

    private enum CodingKeys : String, CodingKey {
        case owningCompanyCode
        case userName
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        owningCompanyCode = try container.decodeIfPresent([String].self, forKey: .owningCompanyCode) ?? []
        userName = try container.decodeIfPresent(String.self, forKey: .userName)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if owningCompanyCode != nil { try container.encode(owningCompanyCode, forKey: .owningCompanyCode) }
        if userName != nil { try container.encode(userName, forKey: .userName) }
    }
}

// @DataContract(Name="Metadata", Namespace="schemas.agentivity.com/types")
public class PagingMetadata : Codable
{
    /**
    * Starting Record
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="Starting Record", Name="Offset", ParameterType="query")
    public var offset:String

    /**
    * Number of records to return (PageSize)
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="Number of records to return (PageSize)", Name="Limit", ParameterType="query")
    public var limit:String

    /**
    * 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 var totalRecords:Int

    /**
    * 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 var responseRecords:Int

    required public init(){}
}

// @Flags()
public enum ConsultantFocusOptions : Int, Codable
{
    case Default = 0
    case ProblematicSegments = 1
    case AirlineDemandsForTicketing = 2
    case Standard = 3
    case ActiveUnsoldAirBookings = 4
    case BookingsWithWarnings = 8
    case All = 15
}

// @DataContract(Name="AgentivityResponse", Namespace="schemas.agentivity.com/types")
public class GetConsultantFocusResponse : CollectionResponse<ConsultantFocusResult>
{
    required public init(){ super.init() }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
    }
}

// @DataContract(Name="AgentivityResponse", Namespace="schemas.agentivity.com/types")
public class CollectionResponse<TItem : Codable> : Codable
{
    // @DataMember(Order=1)
    public var responseMetadata:ResponseMetadata

    // @DataMember(Order=2, EmitDefaultValue=false)
    public var responseReport:[ApiRequestPerHour]

    // @DataMember(Order=3, EmitDefaultValue=false)
    public var responseError:AgentivityError

    required public init(){}
}

// @DataContract(Name="ResponseMetadata", Namespace="schemas.agentivity.com/types")
public class ResponseMetadata : Codable
{
    // @DataMember(Order=0)
    public var success:Bool

    // @DataMember(Order=1)
    public var hasCache:Bool

    // @DataMember(Order=2)
    public var hasPaging:Bool

    // @DataMember(Order=3, EmitDefaultValue=false)
    public var cacheMetadata:CacheMetadata

    // @DataMember(Order=4, EmitDefaultValue=false)
    public var pagingMetadata:PagingMetadata

    required public init(){}
}

// @DataContract(Name="CacheMetadata", Namespace="schemas.agentivity.com/types")
public class CacheMetadata : Codable
{
    // @DataMember(Order=1)
    public var cachedAt:Date

    // @DataMember(Order=2)
    public var cacheExpiresAt:Date

    // @DataMember(Order=0)
    public var isFromCache:Bool

    required public init(){}
}

// @DataContract(Name="ApiRequestPerHour", Namespace="schemas.agentivity.com/types")
public class ApiRequestPerHour : Codable
{
    // @DataMember(Order=10)
    public var requestDate:Date

    // @DataMember(Order=100)
    public var hour0:Int

    // @DataMember(Order=110)
    public var hour1:Int

    // @DataMember(Order=120)
    public var hour2:Int

    // @DataMember(Order=130)
    public var hour3:Int

    // @DataMember(Order=140)
    public var hour4:Int

    // @DataMember(Order=150)
    public var hour5:Int

    // @DataMember(Order=160)
    public var hour6:Int

    // @DataMember(Order=170)
    public var hour7:Int

    // @DataMember(Order=180)
    public var hour8:Int

    // @DataMember(Order=190)
    public var hour9:Int

    // @DataMember(Order=200)
    public var hour10:Int

    // @DataMember(Order=210)
    public var hour11:Int

    // @DataMember(Order=220)
    public var hour12:Int

    // @DataMember(Order=230)
    public var hour13:Int

    // @DataMember(Order=240)
    public var hour14:Int

    // @DataMember(Order=250)
    public var hour15:Int

    // @DataMember(Order=260)
    public var hour16:Int

    // @DataMember(Order=270)
    public var hour17:Int

    // @DataMember(Order=280)
    public var hour18:Int

    // @DataMember(Order=290)
    public var hour19:Int

    // @DataMember(Order=300)
    public var hour20:Int

    // @DataMember(Order=310)
    public var hour21:Int

    // @DataMember(Order=320)
    public var hour22:Int

    // @DataMember(Order=330)
    public var hour23:Int

    required public init(){}
}

// @DataContract(Name="ResponseMetadata", Namespace="schemas.agentivity.com/types")
public class AgentivityError : Codable
{
    // @DataMember
    public var errorCode:String

    // @DataMember
    public var message:String

    // @DataMember
    public var statusCode:String

    // @DataMember
    public var verboseMessage:String

    required public init(){}
}

// @DataContract(Name="ConsultantFocusResult", Namespace="schemas.agentivity.com/types")
public class ConsultantFocusResult : Codable
{
    // @DataMember(Order=10)
    public var problematicSegments:[ProblematicSegment]

    // @DataMember(Order=20)
    public var airlineDemandsForTicketing:[AirlineDemandsForTicketing]

    // @DataMember(Order=30)
    public var activeUnsoldAirBookings:[ActiveUnsoldAirBookings]

    // @DataMember(Order=40)
    public var bookingsWithWarnings:[BookingWithWarnings]

    required public init(){}
}

// @DataContract(Name="ProblematicSegment", Namespace="schemas.agentivity.com/types")
public class ProblematicSegment : Codable
{
    // @DataMember(Order=10)
    public var recordLocator:String

    // @DataMember(Order=15)
    public var pnrCreationDate:Date?

    // @DataMember(Order=20)
    public var owningConsultantID:String

    // @DataMember(Order=25)
    public var owningConsultant:String

    // @DataMember(Order=30)
    public var primaryPax:String

    // @DataMember(Order=50)
    public var account:String

    // @DataMember(Order=60)
    public var segmentStatus:String

    // @DataMember(Order=70)
    public var segment:String

    // @DataMember(Order=80)
    public var owningAgencyLocationID:String

    // @DataMember(Order=90)
    public var gdsCode:String

    // @DataMember(Order=100)
    public var departureDate:Date?

    // @DataMember(Order=110)
    public var agentivityRef:String

    required public init(){}
}

// @DataContract(Name="AirlineDemandsForTicketing", Namespace="schemas.agentivity.com/types")
public class AirlineDemandsForTicketing : Codable
{
    // @DataMember(Order=10)
    public var recordLocator:String

    // @DataMember(Order=15)
    public var pnrCreationDate:Date?

    // @DataMember(Order=20)
    public var primaryPax:String

    // @DataMember(Order=30)
    public var owningConsultantID:String

    // @DataMember(Order=35)
    public var owningConsultant:String

    // @DataMember(Order=40)
    public var account:String

    // @DataMember(Order=50)
    public var airlineCode:String

    // @DataMember(Order=55)
    public var dueDate:Date?

    // @DataMember(Order=60)
    public var dueTime:String

    // @DataMember(Order=70)
    public var owningAgencyLocationID:String

    // @DataMember(Order=80)
    public var gdsCode:String

    // @DataMember(Order=90)
    public var agentivityRef:Int?

    required public init(){}
}

// @DataContract(Name="ActiveUnsoldAirBookings", Namespace="schemas.agentivity.com/types")
public class ActiveUnsoldAirBookings : IBookingItinerary, Codable
{
    // @DataMember(Order=10)
    public var recordLocator:String

    // @DataMember(Order=20)
    public var pnrCreationDate:Date?

    // @DataMember(Order=30)
    public var owningAgencyLocationID:String

    // @DataMember(Order=35)
    public var gdsCode:String

    // @DataMember(Order=40)
    public var primaryPax:String

    // @DataMember(Order=50)
    public var owningConsultant:String

    // @DataMember(Order=55)
    public var owningConsultantID:String

    // @DataMember(Order=60)
    public var account:String

    // @DataMember(Order=100)
    public var primaryCarrierCode:String

    // @DataMember(Order=110)
    public var filedFare:String

    // @DataMember(Order=120)
    public var travelDate:Date?

    // @DataMember(Order=130)
    public var destinationCities:String

    // @DataMember(Order=140)
    public var bookingClasses:String

    // @DataMember(Order=90)
    public var agentivityRef:Int

    // @DataMember(Order=200)
    public var itinerary:ItinerarySegmentsCollection

    // @DataMember(Order=210)
    public var itineraryFormatted:String

    required public init(){}
}

public class ItinerarySegmentsCollection : List<ItinerarySegment>
{
    required public init(){ super.init() }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
    }
}

// @DataContract(Name="ItinerarySegment", Namespace="schemas.agentivity.com/types")
public class ItinerarySegment : Codable
{
    // @DataMember
    public var segmentType:String

    // @DataMember
    public var segmentNbr:Int

    // @DataMember
    public var boardPoint:String

    // @DataMember
    public var offPoint:String

    // @DataMember
    public var operatorCode:String

    // @DataMember
    public var operatorService:String

    // @DataMember
    public var segmentStatus:String

    // @DataMember
    public var departureTimeFormatted:String

    // @DataMember
    public var arrivalTimeFormatted:String

    // @DataMember
    public var changeOfDayFormatted:String

    // @DataMember
    public var serviceCode:String

    // @DataMember
    public var startDate:String

    // @DataMember
    public var endDate:String

    // @DataMember
    public var ticketNumber:String

    /**
    * Comma separated list of vendor locators
    */
    // @DataMember
    public var vendorLocators:String

    // @DataMember
    public var equipmentCode:String

    // @DataMember
    public var equipment:String

    required public init(){}
}

// @DataContract(Name="BookingWithWarnings", Namespace="schemas.agentivity.com/types")
public class BookingWithWarnings : Codable
{
    // @DataMember(Order=10)
    public var recordLocator:String

    // @DataMember(Order=20)
    public var pnrCreationDate:Date

    // @DataMember(Order=30)
    public var agentivityRef:Int

    // @DataMember(Order=40)
    public var owningConsultant:String

    // @DataMember(Order=50)
    public var account:String

    // @DataMember(Order=60)
    public var owningConsultantID:String

    // @DataMember(Order=70)
    public var owningAgencyLocationID:String

    // @DataMember(Order=75)
    public var gdsCode:String

    // @DataMember(Order=80)
    public var travelDate:Date?

    // @DataMember(Order=90)
    public var primaryPax:String

    // @DataMember(Order=1000)
    public var warningsList:[BookingWarning]

    required public init(){}
}

// @DataContract(Name="Warning", Namespace="schemas.agentivity.com/types")
public class BookingWarning : Codable
{
    // @DataMember(Order=10)
    public var warningType:String

    // @DataMember(Order=20)
    public var vendor:String

    // @DataMember(Order=30)
    public var vendorType:String

    // @DataMember(Order=40)
    public var warningDateTime:Date?

    // @DataMember(Order=50)
    public var logDateTime:Date?

    // @DataMember(Order=60)
    public var originalRemark:String

    // @DataMember(Order=70)
    public var propertiesList:[BookingWarningProperty]

    required public init(){}
}

// @DataContract(Name="Property", Namespace="schemas.agentivity.com/types")
public class BookingWarningProperty : Codable
{
    // @DataMember(Order=10)
    public var name:String

    // @DataMember(Order=20)
    public var value:String

    required public init(){}
}

Swift GetConsultantFocus 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 /ConsultantFocus HTTP/1.1 
Host: servicestack.agentivity.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<GetConsultantFocus 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>
  <Options>Default</Options>
  <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>
</GetConsultantFocus>

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>
    <ConsultantFocusResult>
      <ProblematicSegments>
        <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>
      </ProblematicSegments>
      <AirlineDemandsForTicketing>
        <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>
      </AirlineDemandsForTicketing>
      <ActiveUnsoldAirBookings>
        <ActiveUnsoldAirBookings>
          <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>
          <Itinerary>
            <ItinerarySegment>
              <ArrivalTimeFormatted>String</ArrivalTimeFormatted>
              <BoardPoint>String</BoardPoint>
              <ChangeOfDayFormatted>String</ChangeOfDayFormatted>
              <DepartureTimeFormatted>String</DepartureTimeFormatted>
              <EndDate>String</EndDate>
              <Equipment>String</Equipment>
              <EquipmentCode>String</EquipmentCode>
              <OffPoint>String</OffPoint>
              <OperatorCode>String</OperatorCode>
              <OperatorService>String</OperatorService>
              <SegmentNbr>0</SegmentNbr>
              <SegmentStatus>String</SegmentStatus>
              <SegmentType>String</SegmentType>
              <ServiceCode>String</ServiceCode>
              <StartDate>String</StartDate>
              <TicketNumber>String</TicketNumber>
              <VendorLocators>String</VendorLocators>
            </ItinerarySegment>
          </Itinerary>
          <ItineraryFormatted>String</ItineraryFormatted>
        </ActiveUnsoldAirBookings>
      </ActiveUnsoldAirBookings>
      <BookingsWithWarnings>
        <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>
      </BookingsWithWarnings>
    </ConsultantFocusResult>
  </ResponseReport>
  <ResponseError>
    <ErrorCode>String</ErrorCode>
    <Message>String</Message>
    <StatusCode>String</StatusCode>
    <VerboseMessage>String</VerboseMessage>
  </ResponseError>
</AgentivityResponse>