Agentivity API

<back to all web services

AirSegmentsByDate

The following routes are available for this service:
GET/AirSegmentsByDate/userDepreciated, please use AirSegmentsByDate
GET/AirSegmentsByDate
import Foundation
import ServiceStack

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

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

    /**
    * Date search type option, a single character (T to search by segment start dates, C to search by booking creation dates).
    */
    // @DataMember
    public var dateSearchType:String

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

    private enum CodingKeys : String, CodingKey {
        case dateStart
        case dateEnd
        case dateSearchType
    }

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

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

// @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 AirSegmentsByDateItemResponse : ItemResponse<AirSegmentByDate, AirSegmentsByDateResponseReport>
{
    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="AirSegment", Namespace="schemas.agentivity.com/types")
public class AirSegmentByDate : Codable
{
    // @DataMember(Order=10)
    public var agentivityRef:String

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

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

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

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

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

    // @DataMember(Order=70)
    public var departureDate:Date?

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

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

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

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

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

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

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

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

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

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

    required public init(){}
}

// @DataContract(Name="AirSegmentsByDate", Namespace="schemas.agentivity.com/types")
public class AirSegmentsByDateResponseReport : Report<AirSegmentsByDateItemResponse, AirSegmentByDate>
{
    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 AirSegmentsByDate DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other

HTTP + OTHER

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /AirSegmentsByDate/user HTTP/1.1 
Host: api.agentivity.com 
Accept: text/jsonl

HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"ResponseMetadata":{"Success":false,"HasCache":false,"HasPaging":false,"CacheMetadata":{"IsFromCache":false,"CachedAt":"\/Date(-62135596800000-0000)\/","CacheExpiresAt":"\/Date(-62135596800000-0000)\/"},"PagingMetadata":{"Offset":"String","Limit":"String","TotalRecords":0,"ResponseRecords":0}},"ResponseReport":{"Item":{"AgentivityRef":"String","RecordLocator":"String","OwningAgencyLocationID":"String","OwningConsultant":"String","Account":"String","Passengers":"String","DepartureDate":"\/Date(-62135596800000-0000)\/","DepartureTime":"String","ArrivalDate":"\/Date(-62135596800000-0000)\/","ArrivalTime":"String","CarrierCode":"String","BoardPoint":"String","OffPoint":"String","FlightNbr":"String","BookingCode":"String","CreatingAgencyIata":"String","SegmentStatus":"String"}},"ResponseError":{"ErrorCode":"String","Message":"String","StatusCode":"String","VerboseMessage":"String"}}