Agentivity API

<back to all web services

BookingsCountsPerConsultant

import Foundation
import ServiceStack

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

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

    /**
    * Comma Delimited List of PCCs
    */
    // @DataMember
    public var owningAgencyLocationID:[String]

    /**
    * Team name
    */
    // @DataMember
    public var team:String

    /**
    * Qualifier
    */
    // @DataMember
    public var qualifier:String

    /**
    * List only summary if selected true
    */
    // @DataMember
    public var onlySummary:Bool

    /**
    * Include Itinerary in the response
    */
    // @DataMember
    public var includeItinerary:Bool

    /**
    * Indicates the required formatting: 0=None(Default); 1= Html; 2 = Chart
    */
    // @DataMember
    public var itineraryFormatting:FormattingStyle

    /**
    * Repeat
    */
    // @DataMember
    public var repeat:Bool

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

    private enum CodingKeys : String, CodingKey {
        case pnrCreationDateStart
        case pnrCreationDateEnd
        case owningAgencyLocationID
        case team
        case qualifier
        case onlySummary
        case includeItinerary
        case itineraryFormatting
        case repeat
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        pnrCreationDateStart = try container.decodeIfPresent(String.self, forKey: .pnrCreationDateStart)
        pnrCreationDateEnd = try container.decodeIfPresent(String.self, forKey: .pnrCreationDateEnd)
        owningAgencyLocationID = try container.decodeIfPresent([String].self, forKey: .owningAgencyLocationID) ?? []
        team = try container.decodeIfPresent(String.self, forKey: .team)
        qualifier = try container.decodeIfPresent(String.self, forKey: .qualifier)
        onlySummary = try container.decodeIfPresent(Bool.self, forKey: .onlySummary)
        includeItinerary = try container.decodeIfPresent(Bool.self, forKey: .includeItinerary)
        itineraryFormatting = try container.decodeIfPresent(FormattingStyle.self, forKey: .itineraryFormatting)
        repeat = try container.decodeIfPresent(Bool.self, forKey: .repeat)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if pnrCreationDateStart != nil { try container.encode(pnrCreationDateStart, forKey: .pnrCreationDateStart) }
        if pnrCreationDateEnd != nil { try container.encode(pnrCreationDateEnd, forKey: .pnrCreationDateEnd) }
        if owningAgencyLocationID != nil { try container.encode(owningAgencyLocationID, forKey: .owningAgencyLocationID) }
        if team != nil { try container.encode(team, forKey: .team) }
        if qualifier != nil { try container.encode(qualifier, forKey: .qualifier) }
        if onlySummary != nil { try container.encode(onlySummary, forKey: .onlySummary) }
        if includeItinerary != nil { try container.encode(includeItinerary, forKey: .includeItinerary) }
        if itineraryFormatting != nil { try container.encode(itineraryFormatting, forKey: .itineraryFormatting) }
        if repeat != nil { try container.encode(repeat, forKey: .repeat) }
    }
}

// @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 FormattingStyle : Int, Codable
{
    case None = 0
    case Html = 1
    case Charting = 2
}

// @DataContract(Name="AgentivityResponse", Namespace="schemas.agentivity.com/types")
public class BookingsCountsPerConsultantItemResponse : ItemResponse<BookingCountsPerConsultant, BookingsCountsPerConsultantResponseReport>
{
    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 ItemResponse<TItem : Codable, TReport : Codable> : Codable
{
    // @DataMember(Order=1)
    public var responseMetadata:ResponseMetadata

    // @DataMember(Order=2, EmitDefaultValue=false)
    public var responseReport:TReport

    // @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="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="BookingCountsPerConsultant", Namespace="schemas.agentivity.com/types")
public class BookingCountsPerConsultant : IBookingItinerary, Codable
{
    // @DataMember(Order=10)
    public var owningConsultant:String

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

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

    // @DataMember(Order=40)
    public var cancelledCount:Int

    // @DataMember(Order=50)
    public var containingAirCount:Int

    // @DataMember(Order=60)
    public var gdsTicketedCount:Int

    // @DataMember(Order=70)
    public var lowCostCarrierCount:Int

    // @DataMember(Order=75)
    public var assumedTicketedCount:Int

    // @DataMember(Order=80)
    public var churnCount:Int

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

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

    // @DataMember(Order=105)
    public var roboticTicketingCount:Int

    // @DataMember(Order=107)
    public var recordLocator:String

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

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

    // @DataMember(Order=113)
    public var remark:String

    // @DataMember(Order=115)
    public var passangers:String

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

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

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

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

    // @DataMember(Order=1010)
    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="BookingCountsPerConsultant", Namespace="schemas.agentivity.com/types")
public class BookingsCountsPerConsultantResponseReport : Report<BookingsCountsPerConsultantItemResponse, BookingCountsPerConsultant>
{
    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(Namespace="schemas.agentivity.com/types")
public class Report<TItemResponse : Codable, TItem : Codable> : Codable
{
    // @DataMember(Order=1, EmitDefaultValue=false)
    public var item:TItem

    required public init(){}
}

Swift BookingsCountsPerConsultant DTOs

GET /BookingsCountsPerConsultant 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>
    <Item>
      <OwningConsultant>String</OwningConsultant>
      <OwningConsultantID>String</OwningConsultantID>
      <TotalBookings>0</TotalBookings>
      <CancelledCount>0</CancelledCount>
      <ContainingAirCount>0</ContainingAirCount>
      <GDSTicketedCount>0</GDSTicketedCount>
      <LowCostCarrierCount>0</LowCostCarrierCount>
      <AssumedTicketedCount>0</AssumedTicketedCount>
      <ChurnCount>0</ChurnCount>
      <QualifierCount>0</QualifierCount>
      <CountryCount>String</CountryCount>
      <RoboticTicketingCount>0</RoboticTicketingCount>
      <RecordLocator>String</RecordLocator>
      <Account>String</Account>
      <TravelDate>0001-01-01T00:00:00</TravelDate>
      <Remark>String</Remark>
      <Passangers>String</Passangers>
      <AgentivityRef>0</AgentivityRef>
      <PNRCreationDate>0001-01-01T00:00:00</PNRCreationDate>
      <AgentInitials>String</AgentInitials>
      <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>
    </Item>
  </ResponseReport>
  <ResponseError>
    <ErrorCode>String</ErrorCode>
    <Message>String</Message>
    <StatusCode>String</StatusCode>
    <VerboseMessage>String</VerboseMessage>
  </ResponseError>
</AgentivityResponse>