Agentivity API

<back to all web services

GetBookingsCreated

import Foundation
import ServiceStack

// @DataContract(Namespace="schemas.agentivity.com/types")
public class GetBookingsCreated : CompanyLevelRequestBase, IMemberAccount, IMemberPNRCreationDateStart, IMemberPNRCreationDateEnd, IMemberPNRCancelled, IMemberHasMobile, IMemberHasEmail, IMemberMissingEmailOrPhone, IMemberHasHotel, IMemberHasAccount, IMemberIncludeItinerary, IMemberMinSegments, IMemberIsVip, IMemberItineraryFormatting
{
    /**
    * Includes CTCM and CTCE in results
    */
    // @DataMember
    public var includeCTFields:Bool

    /**
    * Comma Delimited List of Accounts
    */
    // @DataMember
    public var account:[String]

    /**
    * Return only PNRs with/without an account
    */
    // @DataMember
    public var hasAccount:Bool?

    /**
    * Return only PNRs with/without an email address
    */
    // @DataMember
    public var hasEmail:Bool?

    /**
    * Return only PNRs with/without a hotel
    */
    // @DataMember
    public var hasHotel:Bool?

    /**
    * Return only PNRs with/without a mobile number
    */
    // @DataMember
    public var hasMobile:Bool?

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

    /**
    * Return only PNRs that are or are not flagged as VIP bookings
    */
    // @DataMember
    public var isVip:Bool?

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

    /**
    * Return only PNRs that equal or exceed a certain number of segments
    */
    // @DataMember
    public var minSegments:Int?

    /**
    * Return only PNRs with/without an email address OR a mobile number
    */
    // @DataMember
    public var missingEmailOrPhone:Bool?

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

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

    /**
    * Return only PNRs that are cancelled(Y)/not cancelled(N)/all
    */
    // @DataMember
    public var pnrCancelled:String

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

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

    private enum CodingKeys : String, CodingKey {
        case includeCTFields
        case account
        case hasAccount
        case hasEmail
        case hasHotel
        case hasMobile
        case includeItinerary
        case isVip
        case itineraryFormatting
        case minSegments
        case missingEmailOrPhone
        case pnrCreationDateEnd
        case pnrCreationDateStart
        case pnrCancelled
        case owningAgencyLocationID
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        includeCTFields = try container.decodeIfPresent(Bool.self, forKey: .includeCTFields)
        account = try container.decodeIfPresent([String].self, forKey: .account) ?? []
        hasAccount = try container.decodeIfPresent(Bool.self, forKey: .hasAccount)
        hasEmail = try container.decodeIfPresent(Bool.self, forKey: .hasEmail)
        hasHotel = try container.decodeIfPresent(Bool.self, forKey: .hasHotel)
        hasMobile = try container.decodeIfPresent(Bool.self, forKey: .hasMobile)
        includeItinerary = try container.decodeIfPresent(Bool.self, forKey: .includeItinerary)
        isVip = try container.decodeIfPresent(Bool.self, forKey: .isVip)
        itineraryFormatting = try container.decodeIfPresent(FormattingStyle.self, forKey: .itineraryFormatting)
        minSegments = try container.decodeIfPresent(Int.self, forKey: .minSegments)
        missingEmailOrPhone = try container.decodeIfPresent(Bool.self, forKey: .missingEmailOrPhone)
        pnrCreationDateEnd = try container.decodeIfPresent(String.self, forKey: .pnrCreationDateEnd)
        pnrCreationDateStart = try container.decodeIfPresent(String.self, forKey: .pnrCreationDateStart)
        pnrCancelled = try container.decodeIfPresent(String.self, forKey: .pnrCancelled)
        owningAgencyLocationID = try container.decodeIfPresent([String].self, forKey: .owningAgencyLocationID) ?? []
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if includeCTFields != nil { try container.encode(includeCTFields, forKey: .includeCTFields) }
        if account != nil { try container.encode(account, forKey: .account) }
        if hasAccount != nil { try container.encode(hasAccount, forKey: .hasAccount) }
        if hasEmail != nil { try container.encode(hasEmail, forKey: .hasEmail) }
        if hasHotel != nil { try container.encode(hasHotel, forKey: .hasHotel) }
        if hasMobile != nil { try container.encode(hasMobile, forKey: .hasMobile) }
        if includeItinerary != nil { try container.encode(includeItinerary, forKey: .includeItinerary) }
        if isVip != nil { try container.encode(isVip, forKey: .isVip) }
        if itineraryFormatting != nil { try container.encode(itineraryFormatting, forKey: .itineraryFormatting) }
        if minSegments != nil { try container.encode(minSegments, forKey: .minSegments) }
        if missingEmailOrPhone != nil { try container.encode(missingEmailOrPhone, forKey: .missingEmailOrPhone) }
        if pnrCreationDateEnd != nil { try container.encode(pnrCreationDateEnd, forKey: .pnrCreationDateEnd) }
        if pnrCreationDateStart != nil { try container.encode(pnrCreationDateStart, forKey: .pnrCreationDateStart) }
        if pnrCancelled != nil { try container.encode(pnrCancelled, forKey: .pnrCancelled) }
        if owningAgencyLocationID != nil { try container.encode(owningAgencyLocationID, forKey: .owningAgencyLocationID) }
    }
}

// @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 BookingsCreatedResponse : CollectionResponse<BookingCreated>
{
    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="BookingCreated", Namespace="schemas.agentivity.com/types")
public class BookingCreated : IBookingItinerary, ICarbonTonnage, Codable
{
    // @DataMember(Order=10)
    public var agentivityRef:Int

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

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

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

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

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

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

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

    // @DataMember(Order=90)
    public var pnrTicketedDate:Date?

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

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

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

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

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

    // @DataMember(Order=150)
    public var emails:String

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

    // @DataMember(Order=170)
    public var isVip:Bool

    // @DataMember(Order=180)
    public var ctcm:String

    // @DataMember(Order=190)
    public var ctce:String

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

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

    // @DataMember(Order=220)
    public var carbonTonnage:Double?

    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(){}
}

Swift GetBookingsCreated DTOs

GET /BookingsCreated 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>
    <BookingCreated>
      <AgentivityRef>0</AgentivityRef>
      <RecordLocator>String</RecordLocator>
      <PNRCreationDate>0001-01-01T00:00:00</PNRCreationDate>
      <OwningAgencyLocationID>String</OwningAgencyLocationID>
      <Account>String</Account>
      <OwningConsultantID>String</OwningConsultantID>
      <OwningConsultant>String</OwningConsultant>
      <PNRTicketed>String</PNRTicketed>
      <PNRTicketedDate>0001-01-01T00:00:00</PNRTicketedDate>
      <PNRCancelled>String</PNRCancelled>
      <TravelDate>0001-01-01T00:00:00</TravelDate>
      <CancelledTravelDate>0001-01-01T00:00:00</CancelledTravelDate>
      <Passengers>String</Passengers>
      <Mobile>String</Mobile>
      <Emails>String</Emails>
      <DestinationCount>0</DestinationCount>
      <IsVip>false</IsVip>
      <CTCM>String</CTCM>
      <CTCE>String</CTCE>
      <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>
      <CarbonTonnage>0</CarbonTonnage>
    </BookingCreated>
  </ResponseReport>
  <ResponseError>
    <ErrorCode>String</ErrorCode>
    <Message>String</Message>
    <StatusCode>String</StatusCode>
    <VerboseMessage>String</VerboseMessage>
  </ResponseError>
</AgentivityResponse>