Agentivity API

TicketSegmentsWithTaxByIssueDate

The following routes are available for this service:
GET	/TicketSegmentsWithTax

import Foundation
import ServiceStack

// @DataContract(Namespace="schemas.agentivity.com/types")
public class TicketSegmentsWithTaxByIssueDate : PagingMetadata
{
    /**
    * UserName in form of an email address
    */
    // @DataMember
    public var userName:String

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

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

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

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

    private enum CodingKeys : String, CodingKey {
        case userName
        case account
        case ticketIssueDateStart
        case ticketIssueDateEnd
    }

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

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

// @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 TicketSegmentsWithTaxByIssueDateResponse : CollectionResponse<TicketSegmentsWithTax>
{
    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="Ticket", Namespace="schemas.agentivity.com/types")
public class TicketSegmentsWithTax : Codable
{
    // @DataMember(Order=10)
    public var recordlocator:String

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    // @DataMember(Order=230)
    public var carrier:String

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

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

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

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

    // @DataMember(Order=280)
    public var fareBasis:String

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

    // @DataMember(Order=300)
    public var dateLastChecked:String

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

    required public init(){}
}

Swift TicketSegmentsWithTaxByIssueDate 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.

GET /TicketSegmentsWithTax 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>
    <Ticket>
      <Recordlocator>String</Recordlocator>
      <PNRCreationDate>String</PNRCreationDate>
      <TicketNumber>String</TicketNumber>
      <Account>String</Account>
      <PrimaryPassenger>String</PrimaryPassenger>
      <VndIssueDate>String</VndIssueDate>
      <TravelAgentID>String</TravelAgentID>
      <FOPFare>String</FOPFare>
      <FOP>String</FOP>
      <TotalTax>String</TotalTax>
      <Tax1Code>String</Tax1Code>
      <Tax1Amt>String</Tax1Amt>
      <Tax2Code>String</Tax2Code>
      <Tax2Amt>String</Tax2Amt>
      <Tax3Code>String</Tax3Code>
      <Tax3Amt>String</Tax3Amt>
      <Tax4Code>String</Tax4Code>
      <Tax4Amt>String</Tax4Amt>
      <Tax5Code>String</Tax5Code>
      <Tax5Amt>String</Tax5Amt>
      <ExchangedForTicket>String</ExchangedForTicket>
      <CouponSequenceNbr>String</CouponSequenceNbr>
      <Carrier>String</Carrier>
      <BoardPoint>String</BoardPoint>
      <OffPoint>String</OffPoint>
      <FlightDate>String</FlightDate>
      <FlightServiceClass>String</FlightServiceClass>
      <FareBasis>String</FareBasis>
      <FlightCouponStatus>String</FlightCouponStatus>
      <DateLastChecked>String</DateLastChecked>
      <OwningAgencyLocationID>String</OwningAgencyLocationID>
    </Ticket>
  </ResponseReport>
  <ResponseError>
    <ErrorCode>String</ErrorCode>
    <Message>String</Message>
    <StatusCode>String</StatusCode>
    <VerboseMessage>String</VerboseMessage>
  </ResponseError>
</AgentivityResponse>