Agentivity API

<back to all web services

GetConsultantPnrActivity

The following routes are available for this service:
GET/ConsultantPnrActivity
namespace AgentivityAPI.ServiceModel

open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<DataContract(Name="ConsultantPnrActivity", Namespace="schemas.agentivity.com/types")>]
    [<AllowNullLiteral>]
    type ConsultantPnrActivity() = 
        [<DataMember(Order=10)>]
        member val Consultant:String = null with get,set

        [<DataMember(Order=20)>]
        member val TransactionAgent:String = null with get,set

        [<DataMember(Order=30)>]
        member val Location:String = null with get,set

        [<DataMember(Order=40)>]
        member val Team:String = null with get,set

        [<DataMember(Order=50)>]
        member val TotalBookings:Int32 = new Int32() with get,set

        [<DataMember(Order=60)>]
        member val Domestic:Int32 = new Int32() with get,set

        [<DataMember(Order=70)>]
        member val International:Int32 = new Int32() with get,set

        [<DataMember(Order=80)>]
        member val Land:Int32 = new Int32() with get,set

        [<DataMember(Order=90)>]
        member val Cancelled:Int32 = new Int32() with get,set

        [<DataMember(Order=95)>]
        member val Complex:Int32 = new Int32() with get,set

        [<DataMember(Order=100)>]
        member val ChangedOwnDomestic:Int32 = new Int32() with get,set

        [<DataMember(Order=110)>]
        member val ChangedOwnInternational:Int32 = new Int32() with get,set

        [<DataMember(Order=120)>]
        member val ChangedOtherDomestic:Int32 = new Int32() with get,set

        [<DataMember(Order=130)>]
        member val ChangedOtherInternational:Int32 = new Int32() with get,set

        [<DataMember(Order=140)>]
        member val WithAir:Int32 = new Int32() with get,set

        [<DataMember(Order=150)>]
        member val WithHotel:Int32 = new Int32() with get,set

        [<DataMember(Order=160)>]
        member val WithPassiveHotel:Int32 = new Int32() with get,set

        [<DataMember(Order=170)>]
        member val WithCar:Int32 = new Int32() with get,set

        [<DataMember(Order=180)>]
        member val TotalChangedBookings:Int32 = new Int32() with get,set

        [<DataMember(Order=190)>]
        member val TotalServicesToBookings:Int32 = new Int32() with get,set

        [<DataMember(Order=200)>]
        member val TotalTicketedBookings:Int32 = new Int32() with get,set

        [<DataMember(Order=210)>]
        member val TotalTicketsIssued:Int32 = new Int32() with get,set

        [<DataMember(Order=220)>]
        member val OwningAgencyLocationID:String = null with get,set

    [<DataContract(Name="CacheMetadata", Namespace="schemas.agentivity.com/types")>]
    [<AllowNullLiteral>]
    type CacheMetadata() = 
        [<DataMember(Order=1)>]
        member val CachedAt:DateTime = new DateTime() with get,set

        [<DataMember(Order=2)>]
        member val CacheExpiresAt:DateTime = new DateTime() with get,set

        [<DataMember(Order=0)>]
        member val IsFromCache:Boolean = new Boolean() with get,set

    [<DataContract(Name="Metadata", Namespace="schemas.agentivity.com/types")>]
    [<AllowNullLiteral>]
    type PagingMetadata() = 
        ///<summary>
        ///Starting Record
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="Starting Record", Name="Offset", ParameterType="query")>]
        member val Offset:String = null with get,set

        ///<summary>
        ///Number of records to return (PageSize)
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="Number of records to return (PageSize)", Name="Limit", ParameterType="query")>]
        member val Limit:String = null with get,set

        ///<summary>
        ///Total Number of Records in a Full Reponse (if no paging)
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="Total Number of Records in a Full Reponse (if no paging)", Name="TotalRecords", ParameterType="query")>]
        member val TotalRecords:Int32 = new Int32() with get,set

        ///<summary>
        ///Total Number of Records in this Reponse (on this page)
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="Total Number of Records in this Reponse (on this page)", Name="ResponseRecords", ParameterType="query")>]
        member val ResponseRecords:Int32 = new Int32() with get,set

    [<DataContract(Name="ResponseMetadata", Namespace="schemas.agentivity.com/types")>]
    [<AllowNullLiteral>]
    type ResponseMetadata() = 
        [<DataMember(Order=0)>]
        member val Success:Boolean = new Boolean() with get,set

        [<DataMember(Order=1)>]
        member val HasCache:Boolean = new Boolean() with get,set

        [<DataMember(Order=2)>]
        member val HasPaging:Boolean = new Boolean() with get,set

        [<DataMember(Order=3, EmitDefaultValue=false)>]
        member val CacheMetadata:CacheMetadata = null with get,set

        [<DataMember(Order=4, EmitDefaultValue=false)>]
        member val PagingMetadata:PagingMetadata = null with get,set

    [<DataContract(Name="ApiRequestPerHour", Namespace="schemas.agentivity.com/types")>]
    [<AllowNullLiteral>]
    type ApiRequestPerHour() = 
        [<DataMember(Order=10)>]
        member val RequestDate:DateTime = new DateTime() with get,set

        [<DataMember(Order=100)>]
        member val Hour0:Int32 = new Int32() with get,set

        [<DataMember(Order=110)>]
        member val Hour1:Int32 = new Int32() with get,set

        [<DataMember(Order=120)>]
        member val Hour2:Int32 = new Int32() with get,set

        [<DataMember(Order=130)>]
        member val Hour3:Int32 = new Int32() with get,set

        [<DataMember(Order=140)>]
        member val Hour4:Int32 = new Int32() with get,set

        [<DataMember(Order=150)>]
        member val Hour5:Int32 = new Int32() with get,set

        [<DataMember(Order=160)>]
        member val Hour6:Int32 = new Int32() with get,set

        [<DataMember(Order=170)>]
        member val Hour7:Int32 = new Int32() with get,set

        [<DataMember(Order=180)>]
        member val Hour8:Int32 = new Int32() with get,set

        [<DataMember(Order=190)>]
        member val Hour9:Int32 = new Int32() with get,set

        [<DataMember(Order=200)>]
        member val Hour10:Int32 = new Int32() with get,set

        [<DataMember(Order=210)>]
        member val Hour11:Int32 = new Int32() with get,set

        [<DataMember(Order=220)>]
        member val Hour12:Int32 = new Int32() with get,set

        [<DataMember(Order=230)>]
        member val Hour13:Int32 = new Int32() with get,set

        [<DataMember(Order=240)>]
        member val Hour14:Int32 = new Int32() with get,set

        [<DataMember(Order=250)>]
        member val Hour15:Int32 = new Int32() with get,set

        [<DataMember(Order=260)>]
        member val Hour16:Int32 = new Int32() with get,set

        [<DataMember(Order=270)>]
        member val Hour17:Int32 = new Int32() with get,set

        [<DataMember(Order=280)>]
        member val Hour18:Int32 = new Int32() with get,set

        [<DataMember(Order=290)>]
        member val Hour19:Int32 = new Int32() with get,set

        [<DataMember(Order=300)>]
        member val Hour20:Int32 = new Int32() with get,set

        [<DataMember(Order=310)>]
        member val Hour21:Int32 = new Int32() with get,set

        [<DataMember(Order=320)>]
        member val Hour22:Int32 = new Int32() with get,set

        [<DataMember(Order=330)>]
        member val Hour23:Int32 = new Int32() with get,set

    [<DataContract(Name="ResponseMetadata", Namespace="schemas.agentivity.com/types")>]
    [<AllowNullLiteral>]
    type AgentivityError() = 
        [<DataMember>]
        member val ErrorCode:String = null with get,set

        [<DataMember>]
        member val Message:String = null with get,set

        [<DataMember>]
        member val StatusCode:String = null with get,set

        [<DataMember>]
        member val VerboseMessage:String = null with get,set

    [<DataContract(Name="AgentivityResponse", Namespace="schemas.agentivity.com/types")>]
    [<AllowNullLiteral>]
    type CollectionResponse<TItem>() = 
        [<DataMember(Order=1)>]
        member val ResponseMetadata:ResponseMetadata = null with get,set

        [<DataMember(Order=2, EmitDefaultValue=false)>]
        member val ResponseReport:ResizeArray<ApiRequestPerHour> = null with get,set

        [<DataMember(Order=3, EmitDefaultValue=false)>]
        member val ResponseError:AgentivityError = null with get,set

    [<DataContract(Name="AgentivityResponse", Namespace="schemas.agentivity.com/types")>]
    [<AllowNullLiteral>]
    type ConsultantPnrActivityResponse() = 
        inherit CollectionResponse<ConsultantPnrActivity>()

    [<DataContract(Namespace="schemas.agentivity.com/types")>]
    [<AllowNullLiteral>]
    type CompanyLevelRequestBase() = 
        inherit PagingMetadata()
        ///<summary>
        ///Comma Delimited List of Owning Company Codes
        ///</summary>
        [<DataMember>]
        member val OwningCompanyCode:String[] = null with get,set

        ///<summary>
        ///UserName in form of an email address
        ///</summary>
        [<DataMember>]
        member val UserName:String = null with get,set

    [<DataContract(Namespace="schemas.agentivity.com/types")>]
    [<AllowNullLiteral>]
    type GetConsultantPnrActivity() = 
        inherit CompanyLevelRequestBase()
        ///<summary>
        ///Date in format YYYYMMDD
        ///</summary>
        [<DataMember>]
        member val ActivityDateStart:String = null with get,set

        ///<summary>
        ///Date in format YYYYMMDD
        ///</summary>
        [<DataMember>]
        member val ActivityDateEnd:String = null with get,set

        ///<summary>
        ///Comma Delimited List of PCCs
        ///</summary>
        [<DataMember>]
        member val OwningAgencyLocationID:String[] = null with get,set

        ///<summary>
        ///Team name
        ///</summary>
        [<DataMember>]
        member val Team:String = null with get,set

        ///<summary>
        ///Qualifier
        ///</summary>
        [<DataMember>]
        member val Qualifier:String = null with get,set

        ///<summary>
        ///List only summary if selected true
        ///</summary>
        [<DataMember>]
        member val OnlySummary:Boolean = new Boolean() with get,set

        ///<summary>
        ///Return only segments that are flagged as VIP only
        ///</summary>
        [<DataMember>]
        member val VipOnly:Boolean = new Boolean() with get,set

F# GetConsultantPnrActivity DTOs

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

HTTP + XML

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/xml
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>
    <ConsultantPnrActivity>
      <Consultant>String</Consultant>
      <TransactionAgent>String</TransactionAgent>
      <Location>String</Location>
      <Team>String</Team>
      <TotalBookings>0</TotalBookings>
      <Domestic>0</Domestic>
      <International>0</International>
      <Land>0</Land>
      <Cancelled>0</Cancelled>
      <Complex>0</Complex>
      <ChangedOwnDomestic>0</ChangedOwnDomestic>
      <ChangedOwnInternational>0</ChangedOwnInternational>
      <ChangedOtherDomestic>0</ChangedOtherDomestic>
      <ChangedOtherInternational>0</ChangedOtherInternational>
      <WithAir>0</WithAir>
      <WithHotel>0</WithHotel>
      <WithPassiveHotel>0</WithPassiveHotel>
      <WithCar>0</WithCar>
      <TotalChangedBookings>0</TotalChangedBookings>
      <TotalServicesToBookings>0</TotalServicesToBookings>
      <TotalTicketedBookings>0</TotalTicketedBookings>
      <TotalTicketsIssued>0</TotalTicketsIssued>
      <OwningAgencyLocationID>String</OwningAgencyLocationID>
    </ConsultantPnrActivity>
  </ResponseReport>
  <ResponseError>
    <ErrorCode>String</ErrorCode>
    <Message>String</Message>
    <StatusCode>String</StatusCode>
    <VerboseMessage>String</VerboseMessage>
  </ResponseError>
</AgentivityResponse>