Agentivity API

<back to all web services

GetBookingEventsDetails

import Foundation
import ServiceStack

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

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

    /**
    * Comma Delimited List of Event Types
    */
    // @DataMember
    public var eventType:[String]

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

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

    private enum CodingKeys : String, CodingKey {
        case eventDateStart
        case eventDateEnd
        case eventType
        case owningAgencyLocationID
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        eventDateStart = try container.decodeIfPresent(String.self, forKey: .eventDateStart)
        eventDateEnd = try container.decodeIfPresent(String.self, forKey: .eventDateEnd)
        eventType = try container.decodeIfPresent([String].self, forKey: .eventType) ?? []
        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 eventDateStart != nil { try container.encode(eventDateStart, forKey: .eventDateStart) }
        if eventDateEnd != nil { try container.encode(eventDateEnd, forKey: .eventDateEnd) }
        if eventType != nil { try container.encode(eventType, forKey: .eventType) }
        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(){}
}

// @DataContract(Name="AgentivityResponse", Namespace="schemas.agentivity.com/types")
public class GetBookingEventsDetailsResponse : CollectionResponse<BookingEventsDetail>
{
    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="BookingEvents", Namespace="schemas.agentivity.com/types")
public class BookingEventsDetail : IBookingIdentifier, IBookingExtItinerary, ITicketNumbers, Codable
{
    // @DataMember(Order=10)
    public var recordLocator:String

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

    // @DataMember(Order=30)
    public var events:[EventTypeItem]

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

    // @DataMember(Order=50)
    public var itinerary:[BookingExtItinerarySegment]

    // @DataMember(Order=60)
    public var ticketNumbers:[String]

    required public init(){}
}

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

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

    required public init(){}
}

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

    // @DataMember
    public var serviceCodeName:String

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

    private enum CodingKeys : String, CodingKey {
        case operatorCodeName
        case serviceCodeName
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        operatorCodeName = try container.decodeIfPresent(String.self, forKey: .operatorCodeName)
        serviceCodeName = try container.decodeIfPresent(String.self, forKey: .serviceCodeName)
    }

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

// @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 GetBookingEventsDetails DTOs

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

<GetBookingEventsDetails 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>
  <EventDateEnd>String</EventDateEnd>
  <EventDateStart>String</EventDateStart>
  <EventType xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </EventType>
  <OwningAgencyLocationID xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </OwningAgencyLocationID>
</GetBookingEventsDetails>

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>
    <BookingEvents>
      <RecordLocator>String</RecordLocator>
      <PNRCreationDate>0001-01-01T00:00:00</PNRCreationDate>
      <Events>
        <Event>
          <EventType>String</EventType>
          <EventDateTime>0001-01-01T00:00:00</EventDateTime>
        </Event>
      </Events>
      <AgentivityRef>0</AgentivityRef>
      <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>
          <OperatorCodeName>String</OperatorCodeName>
          <ServiceCodeName>String</ServiceCodeName>
        </ItinerarySegment>
      </Itinerary>
      <TicketNumbers xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>String</d4p1:string>
      </TicketNumbers>
    </BookingEvents>
  </ResponseReport>
  <ResponseError>
    <ErrorCode>String</ErrorCode>
    <Message>String</Message>
    <StatusCode>String</StatusCode>
    <VerboseMessage>String</VerboseMessage>
  </ResponseError>
</AgentivityResponse>