Agentivity API

<back to all web services

GetConsultantWorkMissedHotelOpportunities

The following routes are available for this service:
All Verbs/ConsultantWorkMissedHotelOpportunities
import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*


@DataContract(Namespace="schemas.agentivity.com/types")
open class GetConsultantWorkMissedHotelOpportunities : CompanyLevelRequestBase(), IRequestConsultantID, IMemberOwningConsultantIDList
{
    /**
    * Date in format YYYYMMDD
    */
    @DataMember
    open var TravelDateStart:String? = null

    /**
    * Date in format YYYYMMDD
    */
    @DataMember
    open var TravelDateEnd:String? = null

    /**
    * Return only PNRs with/without a NoHotelReason specified
    */
    @DataMember
    open var HasNoHotelReason:Boolean? = null

    /**
    * Comma delimited list of owning consultants ids
    */
    @DataMember
    override var OwningConsultantID:ArrayList<String> = ArrayList<String>()

    /**
    * 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
}

@DataContract(Name="AgentivityResponse", Namespace="schemas.agentivity.com/types")
open class GetConsultantWorkMissedHotelOpportunitiesItemResponse : ItemResponse<ConsultantMissedHotelOpportunity, GetConsultantWorkMissedHotelOpportunitiesResponseReport>()
{
}

@DataContract(Name="AgentivityResponse", Namespace="schemas.agentivity.com/types")
open class ItemResponse<TItem, TReport>
{
    @DataMember(Order=1)
    open var ResponseMetadata:ResponseMetadata? = null

    @DataMember(Order=2, EmitDefaultValue=false)
    open var ResponseReport:TReport? = 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="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="ConsultantMissedHotelOpportunity", Namespace="schemas.agentivity.com/types")
open class ConsultantMissedHotelOpportunity
{
    @DataMember(Order=10)
    open var AgentivityRef:Int? = null

    @DataMember(Order=20)
    open var RecordLocator:String? = null

    @DataMember(Order=30)
    open var PNRCreationDate:Date? = null

    @DataMember(Order=40)
    open var CityCode:String? = null

    @DataMember(Order=50)
    open var Account:String? = null

    @DataMember(Order=60)
    open var Passengers:String? = null

    @DataMember(Order=70)
    open var OwningConsultant:String? = null

    @DataMember(Order=75)
    open var OwningConsultantID:String? = null

    @DataMember(Order=80)
    open var GdsCode:String? = null

    @DataMember(Order=90)
    open var From:Date? = null

    @DataMember(Order=100)
    open var To:Date? = null

    @DataMember(Order=110)
    open var NightsNumber:Int? = null

    @DataMember(Order=120)
    open var NoHotelReason:String? = null
}

@DataContract(Name="ConsultantMissedHotelOpportunity", Namespace="schemas.agentivity.com/types")
open class GetConsultantWorkMissedHotelOpportunitiesResponseReport : Report<GetConsultantWorkMissedHotelOpportunitiesItemResponse, ConsultantMissedHotelOpportunity>()
{
}

@DataContract(Namespace="schemas.agentivity.com/types")
open class Report<TItemResponse, TItem>
{
    @DataMember(Order=1, EmitDefaultValue=false)
    open var Item:TItem? = null
}

Kotlin GetConsultantWorkMissedHotelOpportunities 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 /ConsultantWorkMissedHotelOpportunities HTTP/1.1 
Host: api.agentivity.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"TravelDateStart":"String","TravelDateEnd":"String","HasNoHotelReason":false,"OwningConsultantID":["String"],"RequestConsultantID":"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":{"Item":{"AgentivityRef":0,"RecordLocator":"String","PNRCreationDate":"\/Date(-62135596800000-0000)\/","CityCode":"String","Account":"String","Passengers":"String","OwningConsultant":"String","OwningConsultantID":"String","GdsCode":"String","From":"\/Date(-62135596800000-0000)\/","To":"\/Date(-62135596800000-0000)\/","NightsNumber":0,"NoHotelReason":"String"}},"ResponseError":{"ErrorCode":"String","Message":"String","StatusCode":"String","VerboseMessage":"String"}}