| GET | /CarSegmentsByDate |
|---|
import java.math.*;
import java.util.*;
import java.io.InputStream;
import net.servicestack.client.*;
public class dtos
{
@DataContract(Namespace="schemas.agentivity.com/types")
public static class CarSegmentsByDate extends CompanyLevelRequestBase
{
/**
* Type of segment
*/
@DataMember
public CarSegmentType SegmentType = null;
/**
* Date in format YYYYMMDD
*/
@DataMember
public String DateStart = null;
/**
* Date in format YYYYMMDD
*/
@DataMember
public String DateEnd = null;
/**
* Date search type option, a single character (T to search by segment start dates, C to search by booking creation dates).
*/
@DataMember
public String DateSearchType = null;
public CarSegmentType getSegmentType() { return SegmentType; }
public CarSegmentsByDate setSegmentType(CarSegmentType value) { this.SegmentType = value; return this; }
public String getDateStart() { return DateStart; }
public CarSegmentsByDate setDateStart(String value) { this.DateStart = value; return this; }
public String getDateEnd() { return DateEnd; }
public CarSegmentsByDate setDateEnd(String value) { this.DateEnd = value; return this; }
public String getDateSearchType() { return DateSearchType; }
public CarSegmentsByDate setDateSearchType(String value) { this.DateSearchType = value; return this; }
}
@DataContract(Namespace="schemas.agentivity.com/types")
public static class CompanyLevelRequestBase extends PagingMetadata implements IMemberUsername, IMemberOwningCompanyCode
{
/**
* Comma Delimited List of Owning Company Codes
*/
@DataMember
public ArrayList<String> OwningCompanyCode = null;
/**
* UserName in form of an email address
*/
@DataMember
public String UserName = null;
public ArrayList<String> getOwningCompanyCode() { return OwningCompanyCode; }
public CompanyLevelRequestBase setOwningCompanyCode(ArrayList<String> value) { this.OwningCompanyCode = value; return this; }
public String getUserName() { return UserName; }
public CompanyLevelRequestBase setUserName(String value) { this.UserName = value; return this; }
}
@DataContract(Name="Metadata", Namespace="schemas.agentivity.com/types")
public static class PagingMetadata
{
/**
* Starting Record
*/
@DataMember
@ApiMember(DataType="string", Description="Starting Record", Name="Offset", ParameterType="query")
public String Offset = null;
/**
* Number of records to return (PageSize)
*/
@DataMember
@ApiMember(DataType="string", Description="Number of records to return (PageSize)", Name="Limit", ParameterType="query")
public String Limit = 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")
public Integer TotalRecords = 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")
public Integer ResponseRecords = null;
public String getOffset() { return Offset; }
public PagingMetadata setOffset(String value) { this.Offset = value; return this; }
public String getLimit() { return Limit; }
public PagingMetadata setLimit(String value) { this.Limit = value; return this; }
public Integer getTotalRecords() { return TotalRecords; }
public PagingMetadata setTotalRecords(Integer value) { this.TotalRecords = value; return this; }
public Integer getResponseRecords() { return ResponseRecords; }
public PagingMetadata setResponseRecords(Integer value) { this.ResponseRecords = value; return this; }
}
public static enum CarSegmentType
{
Active,
Passive,
All;
}
@DataContract(Name="AgentivityResponse", Namespace="schemas.agentivity.com/types")
public static class CarSegmentsByDateItemResponse extends ItemResponse<CarSegmentByDate, CarSegmentsByDateResponseReport>
{
}
@DataContract(Name="AgentivityResponse", Namespace="schemas.agentivity.com/types")
public static class ItemResponse<TItem, TReport>
{
@DataMember(Order=1)
public ResponseMetadata ResponseMetadata = null;
@DataMember(Order=2, EmitDefaultValue=false)
public TReport ResponseReport = null;
@DataMember(Order=3, EmitDefaultValue=false)
public AgentivityError ResponseError = null;
public ResponseMetadata getResponseMetadata() { return ResponseMetadata; }
public ItemResponse<TItem, TReport> setResponseMetadata(ResponseMetadata value) { this.ResponseMetadata = value; return this; }
public TReport getResponseReport() { return ResponseReport; }
public ItemResponse<TItem, TReport> setResponseReport(TReport value) { this.ResponseReport = value; return this; }
public AgentivityError getResponseError() { return ResponseError; }
public ItemResponse<TItem, TReport> setResponseError(AgentivityError value) { this.ResponseError = value; return this; }
}
@DataContract(Name="ResponseMetadata", Namespace="schemas.agentivity.com/types")
public static class ResponseMetadata
{
@DataMember(Order=0)
public Boolean Success = null;
@DataMember(Order=1)
public Boolean HasCache = null;
@DataMember(Order=2)
public Boolean HasPaging = null;
@DataMember(Order=3, EmitDefaultValue=false)
public CacheMetadata CacheMetadata = null;
@DataMember(Order=4, EmitDefaultValue=false)
public PagingMetadata PagingMetadata = null;
public Boolean isSuccess() { return Success; }
public ResponseMetadata setSuccess(Boolean value) { this.Success = value; return this; }
public Boolean isHasCache() { return HasCache; }
public ResponseMetadata setHasCache(Boolean value) { this.HasCache = value; return this; }
public Boolean isHasPaging() { return HasPaging; }
public ResponseMetadata setHasPaging(Boolean value) { this.HasPaging = value; return this; }
public CacheMetadata getCacheMetadata() { return CacheMetadata; }
public ResponseMetadata setCacheMetadata(CacheMetadata value) { this.CacheMetadata = value; return this; }
public PagingMetadata getPagingMetadata() { return PagingMetadata; }
public ResponseMetadata setPagingMetadata(PagingMetadata value) { this.PagingMetadata = value; return this; }
}
@DataContract(Name="CacheMetadata", Namespace="schemas.agentivity.com/types")
public static class CacheMetadata
{
@DataMember(Order=1)
public Date CachedAt = null;
@DataMember(Order=2)
public Date CacheExpiresAt = null;
@DataMember(Order=0)
public Boolean IsFromCache = null;
public Date getCachedAt() { return CachedAt; }
public CacheMetadata setCachedAt(Date value) { this.CachedAt = value; return this; }
public Date getCacheExpiresAt() { return CacheExpiresAt; }
public CacheMetadata setCacheExpiresAt(Date value) { this.CacheExpiresAt = value; return this; }
public Boolean getIsFromCache() { return IsFromCache; }
public CacheMetadata setIsFromCache(Boolean value) { this.IsFromCache = value; return this; }
}
@DataContract(Name="ResponseMetadata", Namespace="schemas.agentivity.com/types")
public static class AgentivityError
{
@DataMember
public String ErrorCode = null;
@DataMember
public String Message = null;
@DataMember
public String StatusCode = null;
@DataMember
public String VerboseMessage = null;
public String getErrorCode() { return ErrorCode; }
public AgentivityError setErrorCode(String value) { this.ErrorCode = value; return this; }
public String getMessage() { return Message; }
public AgentivityError setMessage(String value) { this.Message = value; return this; }
public String getStatusCode() { return StatusCode; }
public AgentivityError setStatusCode(String value) { this.StatusCode = value; return this; }
public String getVerboseMessage() { return VerboseMessage; }
public AgentivityError setVerboseMessage(String value) { this.VerboseMessage = value; return this; }
}
@DataContract(Name="CarSegmentByDate", Namespace="schemas.agentivity.com/types")
public static class CarSegmentByDate
{
@DataMember(Order=10)
public String AgentivityRef = null;
@DataMember(Order=20)
public String RecordLocator = null;
@DataMember(Order=30)
public String OwningAgencyLocationID = null;
@DataMember(Order=40)
public String OwningConsultant = null;
@DataMember(Order=50)
public String Account = null;
@DataMember(Order=55)
public String Passengers = null;
@DataMember(Order=60)
public Date PickUpDate = null;
@DataMember(Order=70)
public Date DropOffDate = null;
@DataMember(Order=80)
public String CarVendorCode = null;
@DataMember(Order=90)
public String VendorName = null;
@DataMember(Order=100)
public String SegmentStatus = null;
@DataMember(Order=110)
public String AirportCode = null;
@DataMember(Order=120)
public String ConfirmationNbr = null;
@DataMember(Order=130)
public String CurrencyCode = null;
@DataMember(Order=140)
public String RateAmount = null;
@DataMember(Order=150)
public String NbrOfCars = null;
@DataMember(Order=160)
public String CarType = null;
@DataMember(Order=180)
public String ServiceInformation = null;
@DataMember(Order=190)
public String BRInformation = null;
@DataMember(Order=200)
public String CarSegmentType = null;
@DataMember(Order=210)
public String CreatingAgencyIata = null;
@DataMember(Order=220)
public String CityCode = null;
@DataMember(Order=230)
public String Text = null;
@DataMember(Order=240)
public String Vouchers = null;
@DataMember(Order=250)
public String CarRateCode = null;
public String getAgentivityRef() { return AgentivityRef; }
public CarSegmentByDate setAgentivityRef(String value) { this.AgentivityRef = value; return this; }
public String getRecordLocator() { return RecordLocator; }
public CarSegmentByDate setRecordLocator(String value) { this.RecordLocator = value; return this; }
public String getOwningAgencyLocationID() { return OwningAgencyLocationID; }
public CarSegmentByDate setOwningAgencyLocationID(String value) { this.OwningAgencyLocationID = value; return this; }
public String getOwningConsultant() { return OwningConsultant; }
public CarSegmentByDate setOwningConsultant(String value) { this.OwningConsultant = value; return this; }
public String getAccount() { return Account; }
public CarSegmentByDate setAccount(String value) { this.Account = value; return this; }
public String getPassengers() { return Passengers; }
public CarSegmentByDate setPassengers(String value) { this.Passengers = value; return this; }
public Date getPickUpDate() { return PickUpDate; }
public CarSegmentByDate setPickUpDate(Date value) { this.PickUpDate = value; return this; }
public Date getDropOffDate() { return DropOffDate; }
public CarSegmentByDate setDropOffDate(Date value) { this.DropOffDate = value; return this; }
public String getCarVendorCode() { return CarVendorCode; }
public CarSegmentByDate setCarVendorCode(String value) { this.CarVendorCode = value; return this; }
public String getVendorName() { return VendorName; }
public CarSegmentByDate setVendorName(String value) { this.VendorName = value; return this; }
public String getSegmentStatus() { return SegmentStatus; }
public CarSegmentByDate setSegmentStatus(String value) { this.SegmentStatus = value; return this; }
public String getAirportCode() { return AirportCode; }
public CarSegmentByDate setAirportCode(String value) { this.AirportCode = value; return this; }
public String getConfirmationNbr() { return ConfirmationNbr; }
public CarSegmentByDate setConfirmationNbr(String value) { this.ConfirmationNbr = value; return this; }
public String getCurrencyCode() { return CurrencyCode; }
public CarSegmentByDate setCurrencyCode(String value) { this.CurrencyCode = value; return this; }
public String getRateAmount() { return RateAmount; }
public CarSegmentByDate setRateAmount(String value) { this.RateAmount = value; return this; }
public String getNbrOfCars() { return NbrOfCars; }
public CarSegmentByDate setNbrOfCars(String value) { this.NbrOfCars = value; return this; }
public String getCarType() { return CarType; }
public CarSegmentByDate setCarType(String value) { this.CarType = value; return this; }
public String getServiceInformation() { return ServiceInformation; }
public CarSegmentByDate setServiceInformation(String value) { this.ServiceInformation = value; return this; }
public String getBrInformation() { return BRInformation; }
public CarSegmentByDate setBrInformation(String value) { this.BRInformation = value; return this; }
public String getCarSegmentType() { return CarSegmentType; }
public CarSegmentByDate setCarSegmentType(String value) { this.CarSegmentType = value; return this; }
public String getCreatingAgencyIata() { return CreatingAgencyIata; }
public CarSegmentByDate setCreatingAgencyIata(String value) { this.CreatingAgencyIata = value; return this; }
public String getCityCode() { return CityCode; }
public CarSegmentByDate setCityCode(String value) { this.CityCode = value; return this; }
public String getText() { return Text; }
public CarSegmentByDate setText(String value) { this.Text = value; return this; }
public String getVouchers() { return Vouchers; }
public CarSegmentByDate setVouchers(String value) { this.Vouchers = value; return this; }
public String getCarRateCode() { return CarRateCode; }
public CarSegmentByDate setCarRateCode(String value) { this.CarRateCode = value; return this; }
}
@DataContract(Name="CarSegmentByDate", Namespace="schemas.agentivity.com/types")
public static class CarSegmentsByDateResponseReport extends Report<CarSegmentsByDateItemResponse, CarSegmentByDate>
{
}
@DataContract(Namespace="schemas.agentivity.com/types")
public static class Report<TItemResponse, TItem>
{
@DataMember(Order=1, EmitDefaultValue=false)
public TItem Item = null;
public TItem getItem() { return Item; }
public Report<TItemResponse, TItem> setItem(TItem value) { this.Item = value; return this; }
}
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
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"}}