Agentivity API

<back to all web services

GetTravellersByCrm

The following routes are available for this service:
All Verbs/TravellersByCRM
import Foundation
import ServiceStack

// @DataContract(Namespace="schemas.agentivity.com/types")
public class GetTravellersByCrm : CompanyLevelRequestBase
{
    // @DataMember
    public var crmCode:Int

    // @DataMember
    public var crmTravellerId:String

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

    private enum CodingKeys : String, CodingKey {
        case crmCode
        case crmTravellerId
    }

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

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

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

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

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

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

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

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

    // @DataMember(Order=70)
    public var aliases:[Aliases]

    // @DataMember(Order=80)
    public var accounts:[Accounts]

    // @DataMember(Order=90)
    public var bars:[BARS]

    // @DataMember(Order=100)
    public var mars:[MARS]

    // @DataMember(Order=110)
    public var pars:[PARS]

    // @DataMember(Order=120)
    public var pnrStats:PNRStats

    required public init(){}
}

// @DataContract(Name="AliasesItem", Namespace="schemas.agentivity.com/types")
public class Aliases : Codable
{
    // @DataMember
    public var firstName:String

    // @DataMember
    public var lastName:String

    required public init(){}
}

// @DataContract(Name="Account", Namespace="schemas.agentivity.com/types")
public class Accounts : Codable
{
    // @DataMember
    public var accountID:String

    // @DataMember
    public var accountName:String

    // @DataMember
    public var pnrStats:PNRStats

    required public init(){}
}

// @DataContract(Name="PNRStatsItem", Namespace="schemas.agentivity.com/types")
public class PNRStats : Codable
{
    // @DataMember
    public var pnRsCreatedPreviousThreeYears:Int

    required public init(){}
}

// @DataContract(Name="BARItem", Namespace="schemas.agentivity.com/types")
public class BARS : Codable
{
    // @DataMember
    public var bar:String

    required public init(){}
}

// @DataContract(Name="MARItem", Namespace="schemas.agentivity.com/types")
public class MARS : Codable
{
    // @DataMember
    public var mar:String

    required public init(){}
}

// @DataContract(Name="PARitem", Namespace="schemas.agentivity.com/types")
public class PARS : Codable
{
    // @DataMember
    public var par:String

    required public init(){}
}

Swift GetTravellersByCrm DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

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

{"CrmCode":0,"CrmTravellerId":"String","OwningCompanyCode":["String"],"UserName":"String","Offset":"String","Limit":"String","TotalRecords":0,"ResponseRecords":0}

HTTP/1.1 200 OK
Content-Type: application/json
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":[{"TravellerGUID":"String","FirstName":"String","LastName":"String","BAR":"String","MAR":"String","PAR":"String","Aliases":[{"FirstName":"String","LastName":"String"}],"Accounts":[{"AccountID":"String","AccountName":"String","PNRStats":{"PNRsCreatedPreviousThreeYears":0}}],"BARS":[{"BAR":"String"}],"MARS":[{"MAR":"String"}],"PARS":[{"PAR":"String"}],"PNRStats":{"PNRsCreatedPreviousThreeYears":0}}],"ResponseError":{"ErrorCode":"String","Message":"String","StatusCode":"String","VerboseMessage":"String"}}