Agentivity API

<back to all web services

GetConsultantWorkGDSActions

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


@DataContract(Namespace="schemas.agentivity.com/types")
open class GetConsultantWorkGDSActions : 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

    /**
    * 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 GetConsultantWorkGDSActionsResponse : CollectionResponse<ConsultantWorkGDSAction>()
{
}

@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="ConsultantWorkGDSAction", Namespace="schemas.agentivity.com/types")
open class ConsultantWorkGDSAction
{
    @DataMember(Order=10)
    open var ProblematicSegmentList:ArrayList<ConsultantProblematicSegment>? = null

    @DataMember(Order=20)
    open var AirlineDemandsForTicketingList:ArrayList<ConsultantAirlineDemandsForTicketing>? = null

    @DataMember(Order=30)
    open var BookingsWithWarningsList:ArrayList<BookingWithWarnings>? = null
}

@DataContract(Name="ProblematicSegment", Namespace="schemas.agentivity.com/types")
open class ConsultantProblematicSegment : ProblematicSegment()
{
}

@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 ConsultantAirlineDemandsForTicketing : AirlineDemandsForTicketing()
{
}

@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="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 GetConsultantWorkGDSActions 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 /ConsultantWorkGDSActions HTTP/1.1 
Host: api.agentivity.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"DateStart":"String","DateEnd":"String","OwningConsultantID":["String"],"TransactionAgencyLocationID":["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":[{"ProblematicSegmentList":[{"RecordLocator":"String","PNRCreationDate":"\/Date(-62135596800000-0000)\/","OwningConsultantID":"String","OwningConsultant":"String","PrimaryPax":"String","Account":"String","SegmentStatus":"String","Segment":"String","OwningAgencyLocationID":"String","GdsCode":"String","DepartureDate":"\/Date(-62135596800000-0000)\/","AgentivityRef":"String"}],"AirlineDemandsForTicketingList":[{"RecordLocator":"String","PNRCreationDate":"\/Date(-62135596800000-0000)\/","PrimaryPax":"String","OwningConsultantID":"String","OwningConsultant":"String","Account":"String","AirlineCode":"String","DueDate":"\/Date(-62135596800000-0000)\/","DueTime":"String","OwningAgencyLocationID":"String","GdsCode":"String","AgentivityRef":0}],"BookingsWithWarningsList":[{"RecordLocator":"String","PNRCreationDate":"\/Date(-62135596800000-0000)\/","AgentivityRef":0,"OwningConsultant":"String","Account":"String","OwningConsultantID":"String","OwningAgencyLocationID":"String","GdsCode":"String","TravelDate":"\/Date(-62135596800000-0000)\/","PrimaryPax":"String","WarningsList":[{"WarningType":"String","Vendor":"String","VendorType":"String","WarningDateTime":"\/Date(-62135596800000-0000)\/","LogDateTime":"\/Date(-62135596800000-0000)\/","OriginalRemark":"String","PropertiesList":[{"Name":"String","Value":"String"}]}]}]}],"ResponseError":{"ErrorCode":"String","Message":"String","StatusCode":"String","VerboseMessage":"String"}}