Agentivity API

<back to all web services

TicketCouponsIssued

import Foundation
import ServiceStack

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

    /**
    * UserName in form of an email address
    */
    // @DataMember
    public var userName:String

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

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

    /**
    * ID of a travel agent
    */
    // @DataMember
    public var travelAgentID:String

    /**
    * One letter code for flight coupon status
    */
    // @DataMember
    public var flightCouponStatus:String

    /**
    * Format style
    */
    // @DataMember
    public var formatStyle:String

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

    private enum CodingKeys : String, CodingKey {
        case account
        case userName
        case issueDateStart
        case issueDateEnd
        case travelAgentID
        case flightCouponStatus
        case formatStyle
    }

    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) ?? []
        userName = try container.decodeIfPresent(String.self, forKey: .userName)
        issueDateStart = try container.decodeIfPresent(String.self, forKey: .issueDateStart)
        issueDateEnd = try container.decodeIfPresent(String.self, forKey: .issueDateEnd)
        travelAgentID = try container.decodeIfPresent(String.self, forKey: .travelAgentID)
        flightCouponStatus = try container.decodeIfPresent(String.self, forKey: .flightCouponStatus)
        formatStyle = try container.decodeIfPresent(String.self, forKey: .formatStyle)
    }

    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 userName != nil { try container.encode(userName, forKey: .userName) }
        if issueDateStart != nil { try container.encode(issueDateStart, forKey: .issueDateStart) }
        if issueDateEnd != nil { try container.encode(issueDateEnd, forKey: .issueDateEnd) }
        if travelAgentID != nil { try container.encode(travelAgentID, forKey: .travelAgentID) }
        if flightCouponStatus != nil { try container.encode(flightCouponStatus, forKey: .flightCouponStatus) }
        if formatStyle != nil { try container.encode(formatStyle, forKey: .formatStyle) }
    }
}

// @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 TicketCouponsIssuedItemResponse : ItemResponse<TicketCouponIssued, TicketCouponsIssuedResponseReport>
{
    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="TicketCoupon", Namespace="schemas.agentivity.com/types")
public class TicketCouponIssued : Codable
{
    // @DataMember(Order=10)
    public var recordLocator:String

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

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

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

    // @DataMember(Order=50)
    public var vendorIssueDate:Date?

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

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

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

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

    // @DataMember(Order=100)
    public var flightDate:Date?

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

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

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

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

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

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

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

    // @DataMember(Order=180)
    public var dateLastChecked:Date

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

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

    required public init(){}
}

// @DataContract(Name="TicketCouponIssued", Namespace="schemas.agentivity.com/types")
public class TicketCouponsIssuedResponseReport : Report<TicketCouponsIssuedItemResponse, TicketCouponIssued>
{
    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 TicketCouponsIssued DTOs

GET /TicketCouponsIssued 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>
      <RecordLocator>String</RecordLocator>
      <PNRCreationDate>0001-01-01T00:00:00</PNRCreationDate>
      <TktNumber>String</TktNumber>
      <Passenger>String</Passenger>
      <VendorIssueDate>0001-01-01T00:00:00</VendorIssueDate>
      <FOP>String</FOP>
      <FOPCurrncy>String</FOPCurrncy>
      <FOPFare>String</FOPFare>
      <CouponSequenceNbr>String</CouponSequenceNbr>
      <FlightDate>0001-01-01T00:00:00</FlightDate>
      <Routing>String</Routing>
      <FlightServiceClass>String</FlightServiceClass>
      <FareBasis>String</FareBasis>
      <Carrier>String</Carrier>
      <Account>String</Account>
      <OwningAgencyLocationID>String</OwningAgencyLocationID>
      <FlightCouponStatus>String</FlightCouponStatus>
      <DateLastChecked>0001-01-01T00:00:00</DateLastChecked>
      <OwningConsultantID>String</OwningConsultantID>
      <TicketingAgent>String</TicketingAgent>
    </Item>
  </ResponseReport>
  <ResponseError>
    <ErrorCode>String</ErrorCode>
    <Message>String</Message>
    <StatusCode>String</StatusCode>
    <VerboseMessage>String</VerboseMessage>
  </ResponseError>
</AgentivityResponse>