Agentivity API

<back to all web services

AirSegmentsWithVendorLocatorsByUser

import Foundation
import ServiceStack

// @DataContract(Namespace="schemas.agentivity.com/types")
public class AirSegmentsWithVendorLocatorsByUser : CompanyLevelRequestBase
{
    /**
    * Comma Delimited List of Accounts
    */
    // @DataMember
    public var account:[String]

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

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

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

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

    private enum CodingKeys : String, CodingKey {
        case account
        case departureDateStart
        case departureDateEnd
        case isVip
    }

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

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

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

// @DataContract(Name="AgentivityResponse", Namespace="schemas.agentivity.com/types")
public class AirSegmentsWithVendorLocatorsByUserResponse : CollectionResponse<AirSegmentWithVendorLocators>
{
    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="AirSegment", Namespace="schemas.agentivity.com/types")
public class AirSegmentWithVendorLocators : IBookingIdentifier, ITicketCouponStatusInfo, IOperatingCarrierName, IAirSegmentNbr, 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 account:String

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

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

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

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

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

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

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

    // @DataMember(Order=120)
    public var offPoint:String

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

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

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

    // @DataMember(Order=160)
    public var changeOfDay:String

    // @DataMember(Order=170)
    public var carrierCode:String

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

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

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

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

    // @DataMember(Order=220)
    public var checkInURL:String

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

    // @DataMember(Order=240)
    public var phoneNbr:String

    // @DataMember(Order=250)
    public var emailAddress:String

    // @DataMember(Order=260)
    public var ticketNumber:String

    // @DataMember(Order=270)
    public var ticketCouponStatus:String

    // @DataMember(Order=280)
    public var ticketCouponDateLastChecked:Date?

    // @DataMember(Order=290)
    public var operatingCarrierName:String

    required public init(){}
}

Swift AirSegmentsWithVendorLocatorsByUser DTOs

GET /AirSegmentsWithVendorLocators 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>
    <AirSegment>
      <RecordLocator>String</RecordLocator>
      <PNRCreationDate>0001-01-01T00:00:00</PNRCreationDate>
      <AgentivityRef>0</AgentivityRef>
      <Account>String</Account>
      <OwningConsultantID>String</OwningConsultantID>
      <OwningConsultant>String</OwningConsultant>
      <OwningAgencyLocationID>String</OwningAgencyLocationID>
      <PaxList>String</PaxList>
      <AirSegmentNbr>0</AirSegmentNbr>
      <SegmentStatus>String</SegmentStatus>
      <BoardPoint>String</BoardPoint>
      <OffPoint>String</OffPoint>
      <DepartureDate>String</DepartureDate>
      <DepartureTime>String</DepartureTime>
      <ArrivalTime>String</ArrivalTime>
      <ChangeOfDay>String</ChangeOfDay>
      <CarrierCode>String</CarrierCode>
      <FlightNbr>String</FlightNbr>
      <BookingCode>String</BookingCode>
      <PNRTicketed>String</PNRTicketed>
      <VendorLocator>String</VendorLocator>
      <CheckInURL>String</CheckInURL>
      <IsVip>false</IsVip>
      <PhoneNbr>String</PhoneNbr>
      <EmailAddress>String</EmailAddress>
      <TicketNumber>String</TicketNumber>
      <TicketCouponStatus>String</TicketCouponStatus>
      <TicketCouponDateLastChecked>0001-01-01T00:00:00</TicketCouponDateLastChecked>
      <OperatingCarrierName>String</OperatingCarrierName>
    </AirSegment>
  </ResponseReport>
  <ResponseError>
    <ErrorCode>String</ErrorCode>
    <Message>String</Message>
    <StatusCode>String</StatusCode>
    <VerboseMessage>String</VerboseMessage>
  </ResponseError>
</AgentivityResponse>