Agentivity API

<back to all web services

CarSegmentsByDate

using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using AgentivityAPI.ServiceModel.Types;
using AgentivityAPI.ServiceModel.Base;
using AgentivityAPI.ServiceModel;

namespace AgentivityAPI.ServiceModel
{
    [DataContract(Name="AgentivityResponse", Namespace="schemas.agentivity.com/types")]
    public partial class ItemResponse<TItem, TReport>
    {
        [DataMember(Order=1)]
        public virtual ResponseMetadata ResponseMetadata { get; set; }

        [DataMember(Order=2, EmitDefaultValue=false)]
        public virtual TReport ResponseReport { get; set; }

        [DataMember(Order=3, EmitDefaultValue=false)]
        public virtual AgentivityError ResponseError { get; set; }
    }

    [DataContract(Namespace="schemas.agentivity.com/types")]
    public partial class Report<TItemResponse, TItem>
    {
        [DataMember(Order=1, EmitDefaultValue=false)]
        public virtual TItem Item { get; set; }
    }

}

namespace AgentivityAPI.ServiceModel.Base
{
    [DataContract(Namespace="schemas.agentivity.com/types")]
    public partial class CompanyLevelRequestBase
        : PagingMetadata, IMemberUsername, IMemberOwningCompanyCode
    {
        ///<summary>
        ///Comma Delimited List of Owning Company Codes
        ///</summary>
        [DataMember]
        public virtual string[] OwningCompanyCode { get; set; }

        ///<summary>
        ///UserName in form of an email address
        ///</summary>
        [DataMember]
        public virtual string UserName { get; set; }
    }

}

namespace AgentivityAPI.ServiceModel.Types
{
    [DataContract(Name="ResponseMetadata", Namespace="schemas.agentivity.com/types")]
    public partial class AgentivityError
    {
        [DataMember]
        public virtual string ErrorCode { get; set; }

        [DataMember]
        public virtual string Message { get; set; }

        [DataMember]
        public virtual string StatusCode { get; set; }

        [DataMember]
        public virtual string VerboseMessage { get; set; }
    }

    [DataContract(Name="CacheMetadata", Namespace="schemas.agentivity.com/types")]
    public partial class CacheMetadata
    {
        [DataMember(Order=1)]
        public virtual DateTime CachedAt { get; set; }

        [DataMember(Order=2)]
        public virtual DateTime CacheExpiresAt { get; set; }

        [DataMember(Order=0)]
        public virtual bool IsFromCache { get; set; }
    }

    [DataContract(Name="CarSegmentByDate", Namespace="schemas.agentivity.com/types")]
    public partial class CarSegmentByDate
    {
        [DataMember(Order=10)]
        public virtual string AgentivityRef { get; set; }

        [DataMember(Order=20)]
        public virtual string RecordLocator { get; set; }

        [DataMember(Order=30)]
        public virtual string OwningAgencyLocationID { get; set; }

        [DataMember(Order=40)]
        public virtual string OwningConsultant { get; set; }

        [DataMember(Order=50)]
        public virtual string Account { get; set; }

        [DataMember(Order=55)]
        public virtual string Passengers { get; set; }

        [DataMember(Order=60)]
        public virtual DateTime? PickUpDate { get; set; }

        [DataMember(Order=70)]
        public virtual DateTime? DropOffDate { get; set; }

        [DataMember(Order=80)]
        public virtual string CarVendorCode { get; set; }

        [DataMember(Order=90)]
        public virtual string VendorName { get; set; }

        [DataMember(Order=100)]
        public virtual string SegmentStatus { get; set; }

        [DataMember(Order=110)]
        public virtual string AirportCode { get; set; }

        [DataMember(Order=120)]
        public virtual string ConfirmationNbr { get; set; }

        [DataMember(Order=130)]
        public virtual string CurrencyCode { get; set; }

        [DataMember(Order=140)]
        public virtual string RateAmount { get; set; }

        [DataMember(Order=150)]
        public virtual string NbrOfCars { get; set; }

        [DataMember(Order=160)]
        public virtual string CarType { get; set; }

        [DataMember(Order=180)]
        public virtual string ServiceInformation { get; set; }

        [DataMember(Order=190)]
        public virtual string BRInformation { get; set; }

        [DataMember(Order=200)]
        public virtual string CarSegmentType { get; set; }

        [DataMember(Order=210)]
        public virtual string CreatingAgencyIata { get; set; }

        [DataMember(Order=220)]
        public virtual string CityCode { get; set; }

        [DataMember(Order=230)]
        public virtual string Text { get; set; }

        [DataMember(Order=240)]
        public virtual string Vouchers { get; set; }

        [DataMember(Order=250)]
        public virtual string CarRateCode { get; set; }
    }

    [DataContract(Namespace="schemas.agentivity.com/types")]
    public partial class CarSegmentsByDate
        : CompanyLevelRequestBase
    {
        ///<summary>
        ///Type of segment
        ///</summary>
        [DataMember]
        public virtual CarSegmentType SegmentType { get; set; }

        ///<summary>
        ///Date in format YYYYMMDD
        ///</summary>
        [DataMember]
        public virtual string DateStart { get; set; }

        ///<summary>
        ///Date in format YYYYMMDD
        ///</summary>
        [DataMember]
        public virtual string DateEnd { get; set; }

        ///<summary>
        ///Date search type option, a single character (T to search by segment start dates, C to search by booking creation dates).
        ///</summary>
        [DataMember]
        public virtual string DateSearchType { get; set; }
    }

    [DataContract(Name="AgentivityResponse", Namespace="schemas.agentivity.com/types")]
    public partial class CarSegmentsByDateItemResponse
        : ItemResponse<CarSegmentByDate, CarSegmentsByDateResponseReport>
    {
    }

    [DataContract(Name="CarSegmentByDate", Namespace="schemas.agentivity.com/types")]
    public partial class CarSegmentsByDateResponseReport
        : Report<CarSegmentsByDateItemResponse, CarSegmentByDate>
    {
    }

    public enum CarSegmentType
    {
        Active,
        Passive,
        All,
    }

    [DataContract(Name="Metadata", Namespace="schemas.agentivity.com/types")]
    public partial class PagingMetadata
    {
        ///<summary>
        ///Starting Record
        ///</summary>
        [DataMember]
        [ApiMember(DataType="string", Description="Starting Record", Name="Offset", ParameterType="query")]
        public virtual string Offset { 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")]
        public virtual string Limit { 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")]
        public virtual int TotalRecords { 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")]
        public virtual int ResponseRecords { get; set; }
    }

    [DataContract(Name="ResponseMetadata", Namespace="schemas.agentivity.com/types")]
    public partial class ResponseMetadata
    {
        [DataMember(Order=0)]
        public virtual bool Success { get; set; }

        [DataMember(Order=1)]
        public virtual bool HasCache { get; set; }

        [DataMember(Order=2)]
        public virtual bool HasPaging { get; set; }

        [DataMember(Order=3, EmitDefaultValue=false)]
        public virtual CacheMetadata CacheMetadata { get; set; }

        [DataMember(Order=4, EmitDefaultValue=false)]
        public virtual PagingMetadata PagingMetadata { get; set; }
    }

}

C# CarSegmentsByDate DTOs

GET /CarSegmentsByDate HTTP/1.1 
Host: api.agentivity.com 
Accept: text/csv

HTTP/1.1 200 OK
Content-Type: text/csv
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":"String","RecordLocator":"String","OwningAgencyLocationID":"String","OwningConsultant":"String","Account":"String","Passengers":"String","PickUpDate":"\/Date(-62135596800000-0000)\/","DropOffDate":"\/Date(-62135596800000-0000)\/","CarVendorCode":"String","VendorName":"String","SegmentStatus":"String","AirportCode":"String","ConfirmationNbr":"String","CurrencyCode":"String","RateAmount":"String","NbrOfCars":"String","CarType":"String","ServiceInformation":"String","BRInformation":"String","CarSegmentType":"String","CreatingAgencyIata":"String","CityCode":"String","Text":"String","Vouchers":"String","CarRateCode":"String"}},"ResponseError":{"ErrorCode":"String","Message":"String","StatusCode":"String","VerboseMessage":"String"}}