| GET | /ConsultantPnrActivity |
|---|
import Foundation
import ServiceStack
// @DataContract(Namespace="schemas.agentivity.com/types")
public class GetConsultantPnrActivity : CompanyLevelRequestBase
{
/**
* Date in format YYYYMMDD
*/
// @DataMember
public var activityDateStart:String
/**
* Date in format YYYYMMDD
*/
// @DataMember
public var activityDateEnd:String
/**
* Comma Delimited List of PCCs
*/
// @DataMember
public var owningAgencyLocationID:[String]
/**
* Team name
*/
// @DataMember
public var team:String
/**
* Qualifier
*/
// @DataMember
public var qualifier:String
/**
* List only summary if selected true
*/
// @DataMember
public var onlySummary:Bool
/**
* Return only segments that are flagged as VIP only
*/
// @DataMember
public var vipOnly:Bool
required public init(){ super.init() }
private enum CodingKeys : String, CodingKey {
case activityDateStart
case activityDateEnd
case owningAgencyLocationID
case team
case qualifier
case onlySummary
case vipOnly
}
required public init(from decoder: Decoder) throws {
try super.init(from: decoder)
let container = try decoder.container(keyedBy: CodingKeys.self)
activityDateStart = try container.decodeIfPresent(String.self, forKey: .activityDateStart)
activityDateEnd = try container.decodeIfPresent(String.self, forKey: .activityDateEnd)
owningAgencyLocationID = try container.decodeIfPresent([String].self, forKey: .owningAgencyLocationID) ?? []
team = try container.decodeIfPresent(String.self, forKey: .team)
qualifier = try container.decodeIfPresent(String.self, forKey: .qualifier)
onlySummary = try container.decodeIfPresent(Bool.self, forKey: .onlySummary)
vipOnly = try container.decodeIfPresent(Bool.self, forKey: .vipOnly)
}
public override func encode(to encoder: Encoder) throws {
try super.encode(to: encoder)
var container = encoder.container(keyedBy: CodingKeys.self)
if activityDateStart != nil { try container.encode(activityDateStart, forKey: .activityDateStart) }
if activityDateEnd != nil { try container.encode(activityDateEnd, forKey: .activityDateEnd) }
if owningAgencyLocationID != nil { try container.encode(owningAgencyLocationID, forKey: .owningAgencyLocationID) }
if team != nil { try container.encode(team, forKey: .team) }
if qualifier != nil { try container.encode(qualifier, forKey: .qualifier) }
if onlySummary != nil { try container.encode(onlySummary, forKey: .onlySummary) }
if vipOnly != nil { try container.encode(vipOnly, forKey: .vipOnly) }
}
}
// @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 ConsultantPnrActivityResponse : CollectionResponse<ConsultantPnrActivity>
{
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="ConsultantPnrActivity", Namespace="schemas.agentivity.com/types")
public class ConsultantPnrActivity : Codable
{
// @DataMember(Order=10)
public var consultant:String
// @DataMember(Order=20)
public var transactionAgent:String
// @DataMember(Order=30)
public var location:String
// @DataMember(Order=40)
public var team:String
// @DataMember(Order=50)
public var totalBookings:Int
// @DataMember(Order=60)
public var domestic:Int
// @DataMember(Order=70)
public var international:Int
// @DataMember(Order=80)
public var land:Int
// @DataMember(Order=90)
public var cancelled:Int
// @DataMember(Order=95)
public var complex:Int
// @DataMember(Order=100)
public var changedOwnDomestic:Int
// @DataMember(Order=110)
public var changedOwnInternational:Int
// @DataMember(Order=120)
public var changedOtherDomestic:Int
// @DataMember(Order=130)
public var changedOtherInternational:Int
// @DataMember(Order=140)
public var withAir:Int
// @DataMember(Order=150)
public var withHotel:Int
// @DataMember(Order=160)
public var withPassiveHotel:Int
// @DataMember(Order=170)
public var withCar:Int
// @DataMember(Order=180)
public var totalChangedBookings:Int
// @DataMember(Order=190)
public var totalServicesToBookings:Int
// @DataMember(Order=200)
public var totalTicketedBookings:Int
// @DataMember(Order=210)
public var totalTicketsIssued:Int
// @DataMember(Order=220)
public var owningAgencyLocationID:String
required public init(){}
}
Swift GetConsultantPnrActivity 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
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /ConsultantPnrActivity HTTP/1.1 Host: api.agentivity.com Accept: application/json
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":[{"Consultant":"String","TransactionAgent":"String","Location":"String","Team":"String","TotalBookings":0,"Domestic":0,"International":0,"Land":0,"Cancelled":0,"Complex":0,"ChangedOwnDomestic":0,"ChangedOwnInternational":0,"ChangedOtherDomestic":0,"ChangedOtherInternational":0,"WithAir":0,"WithHotel":0,"WithPassiveHotel":0,"WithCar":0,"TotalChangedBookings":0,"TotalServicesToBookings":0,"TotalTicketedBookings":0,"TotalTicketsIssued":0,"OwningAgencyLocationID":"String"}],"ResponseError":{"ErrorCode":"String","Message":"String","StatusCode":"String","VerboseMessage":"String"}}