Agentivity API

<back to all web services

GetBookingsCreatedAndSegments

import Foundation
import ServiceStack

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

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

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

    /**
    * When set to true, filters the results to only include air segments where the associated PNR has been ticketed. Other segments types are unaffected by this filter
    */
    // @DataMember
    public var airSegmentsMustBeTicketed:Bool

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

    private enum CodingKeys : String, CodingKey {
        case owningAgencyLocationID
        case pnrCreationDateStart
        case pnrCreationDateEnd
        case airSegmentsMustBeTicketed
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        owningAgencyLocationID = try container.decodeIfPresent([String].self, forKey: .owningAgencyLocationID) ?? []
        pnrCreationDateStart = try container.decodeIfPresent(String.self, forKey: .pnrCreationDateStart)
        pnrCreationDateEnd = try container.decodeIfPresent(String.self, forKey: .pnrCreationDateEnd)
        airSegmentsMustBeTicketed = try container.decodeIfPresent(Bool.self, forKey: .airSegmentsMustBeTicketed)
    }

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

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

Swift GetBookingsCreatedAndSegments DTOs

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

<GetBookingsCreatedAndSegments 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>
  <AirSegmentsMustBeTicketed>false</AirSegmentsMustBeTicketed>
  <OwningAgencyLocationID xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </OwningAgencyLocationID>
  <PNRCreationDateEnd>String</PNRCreationDateEnd>
  <PNRCreationDateStart>String</PNRCreationDateStart>
</GetBookingsCreatedAndSegments>