| All Verbs | /ConsultantFocus |
|---|
import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*
@DataContract(Namespace="schemas.agentivity.com/types")
open class GetConsultantFocus : CompanyLevelRequestBase(), IRequestConsultantID
{
/**
* Date in format YYYYMMDD
*/
@DataMember
open var DateStart:String? = null
/**
* Date in format YYYYMMDD
*/
@DataMember
open var DateEnd:String? = null
/**
* Comma delimited list of owning consultants ids
*/
@DataMember
open var OwningConsultantID:ArrayList<String> = ArrayList<String>()
/**
* Comma delimited list of transaction agency location ids
*/
@DataMember
open var TransactionAgencyLocationID:ArrayList<String>? = null
/**
* Options to retrieve consultant focus data. Use All to include the Active Unsold Air Bookings.
*/
@DataMember
open var Options:ConsultantFocusOptions? = null
/**
* Request Consultant ID (sign on)
*/
@DataMember
override var RequestConsultantID:String? = null
}
@DataContract(Namespace="schemas.agentivity.com/types")
open class CompanyLevelRequestBase : PagingMetadata(), IMemberUsername, IMemberOwningCompanyCode
{
/**
* Comma Delimited List of Owning Company Codes
*/
@DataMember
override var OwningCompanyCode:ArrayList<String>? = null
/**
* UserName in form of an email address
*/
@DataMember
override var UserName:String? = null
}
@DataContract(Name="Metadata", Namespace="schemas.agentivity.com/types")
open class PagingMetadata
{
/**
* Starting Record
*/
@DataMember
@ApiMember(DataType="string", Description="Starting Record", Name="Offset", ParameterType="query")
open var Offset:String? = null
/**
* Number of records to return (PageSize)
*/
@DataMember
@ApiMember(DataType="string", Description="Number of records to return (PageSize)", Name="Limit", ParameterType="query")
open var Limit:String? = null
/**
* 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")
open var TotalRecords:Int? = null
/**
* 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")
open var ResponseRecords:Int? = null
}
@Flags()
enum class ConsultantFocusOptions(val value:Int)
{
@SerializedName("0") Default(0),
@SerializedName("1") ProblematicSegments(1),
@SerializedName("2") AirlineDemandsForTicketing(2),
@SerializedName("3") Standard(3),
@SerializedName("4") ActiveUnsoldAirBookings(4),
@SerializedName("8") BookingsWithWarnings(8),
@SerializedName("15") All(15),
}
@DataContract(Name="AgentivityResponse", Namespace="schemas.agentivity.com/types")
open class GetConsultantFocusResponse : CollectionResponse<ConsultantFocusResult>()
{
}
@DataContract(Name="AgentivityResponse", Namespace="schemas.agentivity.com/types")
open class CollectionResponse<TItem>
{
@DataMember(Order=1)
open var ResponseMetadata:ResponseMetadata? = null
@DataMember(Order=2, EmitDefaultValue=false)
open var ResponseReport:ArrayList<ApiRequestPerHour>? = null
@DataMember(Order=3, EmitDefaultValue=false)
open var ResponseError:AgentivityError? = null
}
@DataContract(Name="ResponseMetadata", Namespace="schemas.agentivity.com/types")
open class ResponseMetadata
{
@DataMember(Order=0)
open var Success:Boolean? = null
@DataMember(Order=1)
open var HasCache:Boolean? = null
@DataMember(Order=2)
open var HasPaging:Boolean? = null
@DataMember(Order=3, EmitDefaultValue=false)
open var CacheMetadata:CacheMetadata? = null
@DataMember(Order=4, EmitDefaultValue=false)
open var PagingMetadata:PagingMetadata? = null
}
@DataContract(Name="CacheMetadata", Namespace="schemas.agentivity.com/types")
open class CacheMetadata
{
@DataMember(Order=1)
open var CachedAt:Date? = null
@DataMember(Order=2)
open var CacheExpiresAt:Date? = null
@DataMember(Order=0)
open var IsFromCache:Boolean? = null
}
@DataContract(Name="ApiRequestPerHour", Namespace="schemas.agentivity.com/types")
open class ApiRequestPerHour
{
@DataMember(Order=10)
open var RequestDate:Date? = null
@DataMember(Order=100)
open var Hour0:Int? = null
@DataMember(Order=110)
open var Hour1:Int? = null
@DataMember(Order=120)
open var Hour2:Int? = null
@DataMember(Order=130)
open var Hour3:Int? = null
@DataMember(Order=140)
open var Hour4:Int? = null
@DataMember(Order=150)
open var Hour5:Int? = null
@DataMember(Order=160)
open var Hour6:Int? = null
@DataMember(Order=170)
open var Hour7:Int? = null
@DataMember(Order=180)
open var Hour8:Int? = null
@DataMember(Order=190)
open var Hour9:Int? = null
@DataMember(Order=200)
open var Hour10:Int? = null
@DataMember(Order=210)
open var Hour11:Int? = null
@DataMember(Order=220)
open var Hour12:Int? = null
@DataMember(Order=230)
open var Hour13:Int? = null
@DataMember(Order=240)
open var Hour14:Int? = null
@DataMember(Order=250)
open var Hour15:Int? = null
@DataMember(Order=260)
open var Hour16:Int? = null
@DataMember(Order=270)
open var Hour17:Int? = null
@DataMember(Order=280)
open var Hour18:Int? = null
@DataMember(Order=290)
open var Hour19:Int? = null
@DataMember(Order=300)
open var Hour20:Int? = null
@DataMember(Order=310)
open var Hour21:Int? = null
@DataMember(Order=320)
open var Hour22:Int? = null
@DataMember(Order=330)
open var Hour23:Int? = null
}
@DataContract(Name="ResponseMetadata", Namespace="schemas.agentivity.com/types")
open class AgentivityError
{
@DataMember
open var ErrorCode:String? = null
@DataMember
open var Message:String? = null
@DataMember
open var StatusCode:String? = null
@DataMember
open var VerboseMessage:String? = null
}
@DataContract(Name="ConsultantFocusResult", Namespace="schemas.agentivity.com/types")
open class ConsultantFocusResult
{
@DataMember(Order=10)
open var ProblematicSegments:ArrayList<ProblematicSegment>? = null
@DataMember(Order=20)
open var AirlineDemandsForTicketing:ArrayList<AirlineDemandsForTicketing>? = null
@DataMember(Order=30)
open var ActiveUnsoldAirBookings:ArrayList<ActiveUnsoldAirBookings>? = null
@DataMember(Order=40)
open var BookingsWithWarnings:ArrayList<BookingWithWarnings>? = null
}
@DataContract(Name="ProblematicSegment", Namespace="schemas.agentivity.com/types")
open class ProblematicSegment
{
@DataMember(Order=10)
open var RecordLocator:String? = null
@DataMember(Order=15)
open var PNRCreationDate:Date? = null
@DataMember(Order=20)
open var OwningConsultantID:String? = null
@DataMember(Order=25)
open var OwningConsultant:String? = null
@DataMember(Order=30)
open var PrimaryPax:String? = null
@DataMember(Order=50)
open var Account:String? = null
@DataMember(Order=60)
open var SegmentStatus:String? = null
@DataMember(Order=70)
open var Segment:String? = null
@DataMember(Order=80)
open var OwningAgencyLocationID:String? = null
@DataMember(Order=90)
open var GdsCode:String? = null
@DataMember(Order=100)
open var DepartureDate:Date? = null
@DataMember(Order=110)
open var AgentivityRef:String? = null
}
@DataContract(Name="AirlineDemandsForTicketing", Namespace="schemas.agentivity.com/types")
open class AirlineDemandsForTicketing
{
@DataMember(Order=10)
open var RecordLocator:String? = null
@DataMember(Order=15)
open var PNRCreationDate:Date? = null
@DataMember(Order=20)
open var PrimaryPax:String? = null
@DataMember(Order=30)
open var OwningConsultantID:String? = null
@DataMember(Order=35)
open var OwningConsultant:String? = null
@DataMember(Order=40)
open var Account:String? = null
@DataMember(Order=50)
open var AirlineCode:String? = null
@DataMember(Order=55)
open var DueDate:Date? = null
@DataMember(Order=60)
open var DueTime:String? = null
@DataMember(Order=70)
open var OwningAgencyLocationID:String? = null
@DataMember(Order=80)
open var GdsCode:String? = null
@DataMember(Order=90)
open var AgentivityRef:Int? = null
}
@DataContract(Name="ActiveUnsoldAirBookings", Namespace="schemas.agentivity.com/types")
open class ActiveUnsoldAirBookings : IBookingItinerary
{
@DataMember(Order=10)
open var RecordLocator:String? = null
@DataMember(Order=20)
open var PNRCreationDate:Date? = null
@DataMember(Order=30)
open var OwningAgencyLocationID:String? = null
@DataMember(Order=35)
open var GdsCode:String? = null
@DataMember(Order=40)
open var PrimaryPax:String? = null
@DataMember(Order=50)
open var OwningConsultant:String? = null
@DataMember(Order=55)
open var OwningConsultantID:String? = null
@DataMember(Order=60)
open var Account:String? = null
@DataMember(Order=100)
open var PrimaryCarrierCode:String? = null
@DataMember(Order=110)
open var FiledFare:String? = null
@DataMember(Order=120)
open var TravelDate:Date? = null
@DataMember(Order=130)
open var DestinationCities:String? = null
@DataMember(Order=140)
open var BookingClasses:String? = null
@DataMember(Order=90)
override var AgentivityRef:Int? = null
@DataMember(Order=200)
override var Itinerary:ItinerarySegmentsCollection? = null
@DataMember(Order=210)
override var ItineraryFormatted:String? = null
}
open class ItinerarySegmentsCollection : ArrayList<ItinerarySegment>()
{
}
@DataContract(Name="ItinerarySegment", Namespace="schemas.agentivity.com/types")
open class ItinerarySegment
{
@DataMember
open var SegmentType:String? = null
@DataMember
open var SegmentNbr:Int? = null
@DataMember
open var BoardPoint:String? = null
@DataMember
open var OffPoint:String? = null
@DataMember
open var OperatorCode:String? = null
@DataMember
open var OperatorService:String? = null
@DataMember
open var SegmentStatus:String? = null
@DataMember
open var DepartureTimeFormatted:String? = null
@DataMember
open var ArrivalTimeFormatted:String? = null
@DataMember
open var ChangeOfDayFormatted:String? = null
@DataMember
open var ServiceCode:String? = null
@DataMember
open var StartDate:String? = null
@DataMember
open var EndDate:String? = null
@DataMember
open var TicketNumber:String? = null
/**
* Comma separated list of vendor locators
*/
@DataMember
open var VendorLocators:String? = null
@DataMember
open var EquipmentCode:String? = null
@DataMember
open var Equipment:String? = null
}
@DataContract(Name="BookingWithWarnings", Namespace="schemas.agentivity.com/types")
open class BookingWithWarnings
{
@DataMember(Order=10)
open var RecordLocator:String? = null
@DataMember(Order=20)
open var PNRCreationDate:Date? = null
@DataMember(Order=30)
open var AgentivityRef:Int? = null
@DataMember(Order=40)
open var OwningConsultant:String? = null
@DataMember(Order=50)
open var Account:String? = null
@DataMember(Order=60)
open var OwningConsultantID:String? = null
@DataMember(Order=70)
open var OwningAgencyLocationID:String? = null
@DataMember(Order=75)
open var GdsCode:String? = null
@DataMember(Order=80)
open var TravelDate:Date? = null
@DataMember(Order=90)
open var PrimaryPax:String? = null
@DataMember(Order=1000)
open var WarningsList:ArrayList<BookingWarning>? = null
}
@DataContract(Name="Warning", Namespace="schemas.agentivity.com/types")
open class BookingWarning
{
@DataMember(Order=10)
open var WarningType:String? = null
@DataMember(Order=20)
open var Vendor:String? = null
@DataMember(Order=30)
open var VendorType:String? = null
@DataMember(Order=40)
open var WarningDateTime:Date? = null
@DataMember(Order=50)
open var LogDateTime:Date? = null
@DataMember(Order=60)
open var OriginalRemark:String? = null
@DataMember(Order=70)
open var PropertiesList:ArrayList<BookingWarningProperty>? = null
}
@DataContract(Name="Property", Namespace="schemas.agentivity.com/types")
open class BookingWarningProperty
{
@DataMember(Order=10)
open var Name:String? = null
@DataMember(Order=20)
open var Value:String? = null
}
Kotlin GetConsultantFocus DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /ConsultantFocus HTTP/1.1
Host: api.agentivity.com
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<GetConsultantFocus 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>
<DateEnd>String</DateEnd>
<DateStart>String</DateStart>
<Options>Default</Options>
<OwningConsultantID xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</OwningConsultantID>
<RequestConsultantID>String</RequestConsultantID>
<TransactionAgencyLocationID xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</TransactionAgencyLocationID>
</GetConsultantFocus>
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>
<ConsultantFocusResult>
<ProblematicSegments>
<ProblematicSegment>
<RecordLocator>String</RecordLocator>
<PNRCreationDate>0001-01-01T00:00:00</PNRCreationDate>
<OwningConsultantID>String</OwningConsultantID>
<OwningConsultant>String</OwningConsultant>
<PrimaryPax>String</PrimaryPax>
<Account>String</Account>
<SegmentStatus>String</SegmentStatus>
<Segment>String</Segment>
<OwningAgencyLocationID>String</OwningAgencyLocationID>
<GdsCode>String</GdsCode>
<DepartureDate>0001-01-01T00:00:00</DepartureDate>
<AgentivityRef>String</AgentivityRef>
</ProblematicSegment>
</ProblematicSegments>
<AirlineDemandsForTicketing>
<AirlineDemandsForTicketing>
<RecordLocator>String</RecordLocator>
<PNRCreationDate>0001-01-01T00:00:00</PNRCreationDate>
<PrimaryPax>String</PrimaryPax>
<OwningConsultantID>String</OwningConsultantID>
<OwningConsultant>String</OwningConsultant>
<Account>String</Account>
<AirlineCode>String</AirlineCode>
<DueDate>0001-01-01T00:00:00</DueDate>
<DueTime>String</DueTime>
<OwningAgencyLocationID>String</OwningAgencyLocationID>
<GdsCode>String</GdsCode>
<AgentivityRef>0</AgentivityRef>
</AirlineDemandsForTicketing>
</AirlineDemandsForTicketing>
<ActiveUnsoldAirBookings>
<ActiveUnsoldAirBookings>
<RecordLocator>String</RecordLocator>
<PNRCreationDate>0001-01-01T00:00:00</PNRCreationDate>
<OwningAgencyLocationID>String</OwningAgencyLocationID>
<GdsCode>String</GdsCode>
<PrimaryPax>String</PrimaryPax>
<OwningConsultant>String</OwningConsultant>
<OwningConsultantID>String</OwningConsultantID>
<Account>String</Account>
<AgentivityRef>0</AgentivityRef>
<PrimaryCarrierCode>String</PrimaryCarrierCode>
<FiledFare>String</FiledFare>
<TravelDate>0001-01-01T00:00:00</TravelDate>
<DestinationCities>String</DestinationCities>
<BookingClasses>String</BookingClasses>
<Itinerary>
<ItinerarySegment>
<ArrivalTimeFormatted>String</ArrivalTimeFormatted>
<BoardPoint>String</BoardPoint>
<ChangeOfDayFormatted>String</ChangeOfDayFormatted>
<DepartureTimeFormatted>String</DepartureTimeFormatted>
<EndDate>String</EndDate>
<Equipment>String</Equipment>
<EquipmentCode>String</EquipmentCode>
<OffPoint>String</OffPoint>
<OperatorCode>String</OperatorCode>
<OperatorService>String</OperatorService>
<SegmentNbr>0</SegmentNbr>
<SegmentStatus>String</SegmentStatus>
<SegmentType>String</SegmentType>
<ServiceCode>String</ServiceCode>
<StartDate>String</StartDate>
<TicketNumber>String</TicketNumber>
<VendorLocators>String</VendorLocators>
</ItinerarySegment>
</Itinerary>
<ItineraryFormatted>String</ItineraryFormatted>
</ActiveUnsoldAirBookings>
</ActiveUnsoldAirBookings>
<BookingsWithWarnings>
<BookingWithWarnings>
<RecordLocator>String</RecordLocator>
<PNRCreationDate>0001-01-01T00:00:00</PNRCreationDate>
<AgentivityRef>0</AgentivityRef>
<OwningConsultant>String</OwningConsultant>
<Account>String</Account>
<OwningConsultantID>String</OwningConsultantID>
<OwningAgencyLocationID>String</OwningAgencyLocationID>
<GdsCode>String</GdsCode>
<TravelDate>0001-01-01T00:00:00</TravelDate>
<PrimaryPax>String</PrimaryPax>
<WarningsList>
<Warning>
<WarningType>String</WarningType>
<Vendor>String</Vendor>
<VendorType>String</VendorType>
<WarningDateTime>0001-01-01T00:00:00</WarningDateTime>
<LogDateTime>0001-01-01T00:00:00</LogDateTime>
<OriginalRemark>String</OriginalRemark>
<PropertiesList>
<Property>
<Name>String</Name>
<Value>String</Value>
</Property>
</PropertiesList>
</Warning>
</WarningsList>
</BookingWithWarnings>
</BookingsWithWarnings>
</ConsultantFocusResult>
</ResponseReport>
<ResponseError>
<ErrorCode>String</ErrorCode>
<Message>String</Message>
<StatusCode>String</StatusCode>
<VerboseMessage>String</VerboseMessage>
</ResponseError>
</AgentivityResponse>