| GET | /CarSegments |
|---|
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 GetCarSegments extends CompanyLevelRequestBase
{
@DataMember
public String PickUpDateStart = null;
@DataMember
public String PickUpDateEnd = null;
public String getPickUpDateStart() { return PickUpDateStart; }
public GetCarSegments setPickUpDateStart(String value) { this.PickUpDateStart = value; return this; }
public String getPickUpDateEnd() { return PickUpDateEnd; }
public GetCarSegments setPickUpDateEnd(String value) { this.PickUpDateEnd = 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; }
}
@DataContract(Name="AgentivityResponse", Namespace="schemas.agentivity.com/types")
public static class CarSegmentsByUserResponse extends CollectionResponse<CarSegmentAndVendor>
{
}
@DataContract(Name="AgentivityResponse", Namespace="schemas.agentivity.com/types")
public static class CollectionResponse<TItem>
{
@DataMember(Order=1)
public ResponseMetadata ResponseMetadata = null;
@DataMember(Order=2, EmitDefaultValue=false)
public ArrayList<ApiRequestPerHour> ResponseReport = null;
@DataMember(Order=3, EmitDefaultValue=false)
public AgentivityError ResponseError = null;
public ResponseMetadata getResponseMetadata() { return ResponseMetadata; }
public CollectionResponse<TItem> setResponseMetadata(ResponseMetadata value) { this.ResponseMetadata = value; return this; }
public ArrayList<ApiRequestPerHour> getResponseReport() { return ResponseReport; }
public CollectionResponse<TItem> setResponseReport(ArrayList<ApiRequestPerHour> value) { this.ResponseReport = value; return this; }
public AgentivityError getResponseError() { return ResponseError; }
public CollectionResponse<TItem> 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="ApiRequestPerHour", Namespace="schemas.agentivity.com/types")
public static class ApiRequestPerHour
{
@DataMember(Order=10)
public Date RequestDate = null;
@DataMember(Order=100)
public Integer Hour0 = null;
@DataMember(Order=110)
public Integer Hour1 = null;
@DataMember(Order=120)
public Integer Hour2 = null;
@DataMember(Order=130)
public Integer Hour3 = null;
@DataMember(Order=140)
public Integer Hour4 = null;
@DataMember(Order=150)
public Integer Hour5 = null;
@DataMember(Order=160)
public Integer Hour6 = null;
@DataMember(Order=170)
public Integer Hour7 = null;
@DataMember(Order=180)
public Integer Hour8 = null;
@DataMember(Order=190)
public Integer Hour9 = null;
@DataMember(Order=200)
public Integer Hour10 = null;
@DataMember(Order=210)
public Integer Hour11 = null;
@DataMember(Order=220)
public Integer Hour12 = null;
@DataMember(Order=230)
public Integer Hour13 = null;
@DataMember(Order=240)
public Integer Hour14 = null;
@DataMember(Order=250)
public Integer Hour15 = null;
@DataMember(Order=260)
public Integer Hour16 = null;
@DataMember(Order=270)
public Integer Hour17 = null;
@DataMember(Order=280)
public Integer Hour18 = null;
@DataMember(Order=290)
public Integer Hour19 = null;
@DataMember(Order=300)
public Integer Hour20 = null;
@DataMember(Order=310)
public Integer Hour21 = null;
@DataMember(Order=320)
public Integer Hour22 = null;
@DataMember(Order=330)
public Integer Hour23 = null;
public Date getRequestDate() { return RequestDate; }
public ApiRequestPerHour setRequestDate(Date value) { this.RequestDate = value; return this; }
public Integer getHour0() { return Hour0; }
public ApiRequestPerHour setHour0(Integer value) { this.Hour0 = value; return this; }
public Integer getHour1() { return Hour1; }
public ApiRequestPerHour setHour1(Integer value) { this.Hour1 = value; return this; }
public Integer getHour2() { return Hour2; }
public ApiRequestPerHour setHour2(Integer value) { this.Hour2 = value; return this; }
public Integer getHour3() { return Hour3; }
public ApiRequestPerHour setHour3(Integer value) { this.Hour3 = value; return this; }
public Integer getHour4() { return Hour4; }
public ApiRequestPerHour setHour4(Integer value) { this.Hour4 = value; return this; }
public Integer getHour5() { return Hour5; }
public ApiRequestPerHour setHour5(Integer value) { this.Hour5 = value; return this; }
public Integer getHour6() { return Hour6; }
public ApiRequestPerHour setHour6(Integer value) { this.Hour6 = value; return this; }
public Integer getHour7() { return Hour7; }
public ApiRequestPerHour setHour7(Integer value) { this.Hour7 = value; return this; }
public Integer getHour8() { return Hour8; }
public ApiRequestPerHour setHour8(Integer value) { this.Hour8 = value; return this; }
public Integer getHour9() { return Hour9; }
public ApiRequestPerHour setHour9(Integer value) { this.Hour9 = value; return this; }
public Integer getHour10() { return Hour10; }
public ApiRequestPerHour setHour10(Integer value) { this.Hour10 = value; return this; }
public Integer getHour11() { return Hour11; }
public ApiRequestPerHour setHour11(Integer value) { this.Hour11 = value; return this; }
public Integer getHour12() { return Hour12; }
public ApiRequestPerHour setHour12(Integer value) { this.Hour12 = value; return this; }
public Integer getHour13() { return Hour13; }
public ApiRequestPerHour setHour13(Integer value) { this.Hour13 = value; return this; }
public Integer getHour14() { return Hour14; }
public ApiRequestPerHour setHour14(Integer value) { this.Hour14 = value; return this; }
public Integer getHour15() { return Hour15; }
public ApiRequestPerHour setHour15(Integer value) { this.Hour15 = value; return this; }
public Integer getHour16() { return Hour16; }
public ApiRequestPerHour setHour16(Integer value) { this.Hour16 = value; return this; }
public Integer getHour17() { return Hour17; }
public ApiRequestPerHour setHour17(Integer value) { this.Hour17 = value; return this; }
public Integer getHour18() { return Hour18; }
public ApiRequestPerHour setHour18(Integer value) { this.Hour18 = value; return this; }
public Integer getHour19() { return Hour19; }
public ApiRequestPerHour setHour19(Integer value) { this.Hour19 = value; return this; }
public Integer getHour20() { return Hour20; }
public ApiRequestPerHour setHour20(Integer value) { this.Hour20 = value; return this; }
public Integer getHour21() { return Hour21; }
public ApiRequestPerHour setHour21(Integer value) { this.Hour21 = value; return this; }
public Integer getHour22() { return Hour22; }
public ApiRequestPerHour setHour22(Integer value) { this.Hour22 = value; return this; }
public Integer getHour23() { return Hour23; }
public ApiRequestPerHour setHour23(Integer value) { this.Hour23 = 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="Segment", Namespace="schemas.agentivity.com/types")
public static class CarSegmentAndVendor
{
@DataMember(Order=1)
public String OwningAgencyLocation = null;
@DataMember(Order=2)
public String PNR = null;
@DataMember(Order=3)
public String Consultant = null;
@DataMember(Order=4)
public String SegmentStatus = null;
@DataMember(Order=5)
public String PickUpDate = null;
@DataMember(Order=6)
public String DropOffDate = null;
@DataMember(Order=7)
public String CarVendorCode = null;
@DataMember(Order=8)
public String VendorName = null;
@DataMember(Order=9)
public String AirportCode = null;
@DataMember(Order=10)
public String Passenger = null;
@DataMember(Order=11)
public String Account = null;
@DataMember(Order=12)
public String ConfirmationNbr = null;
@DataMember(Order=13)
public String CurrencyCode = null;
@DataMember(Order=14)
public String RateAmount = null;
@DataMember(Order=15)
public String CarType = null;
@DataMember(Order=16)
public String NbrOfCars = null;
@DataMember(Order=17)
public String BookedInName = null;
@DataMember(Order=18)
public String ServiceInformation = null;
@DataMember(Order=19)
public String BRInformation = null;
public String getOwningAgencyLocation() { return OwningAgencyLocation; }
public CarSegmentAndVendor setOwningAgencyLocation(String value) { this.OwningAgencyLocation = value; return this; }
public String getPnr() { return PNR; }
public CarSegmentAndVendor setPnr(String value) { this.PNR = value; return this; }
public String getConsultant() { return Consultant; }
public CarSegmentAndVendor setConsultant(String value) { this.Consultant = value; return this; }
public String getSegmentStatus() { return SegmentStatus; }
public CarSegmentAndVendor setSegmentStatus(String value) { this.SegmentStatus = value; return this; }
public String getPickUpDate() { return PickUpDate; }
public CarSegmentAndVendor setPickUpDate(String value) { this.PickUpDate = value; return this; }
public String getDropOffDate() { return DropOffDate; }
public CarSegmentAndVendor setDropOffDate(String value) { this.DropOffDate = value; return this; }
public String getCarVendorCode() { return CarVendorCode; }
public CarSegmentAndVendor setCarVendorCode(String value) { this.CarVendorCode = value; return this; }
public String getVendorName() { return VendorName; }
public CarSegmentAndVendor setVendorName(String value) { this.VendorName = value; return this; }
public String getAirportCode() { return AirportCode; }
public CarSegmentAndVendor setAirportCode(String value) { this.AirportCode = value; return this; }
public String getPassenger() { return Passenger; }
public CarSegmentAndVendor setPassenger(String value) { this.Passenger = value; return this; }
public String getAccount() { return Account; }
public CarSegmentAndVendor setAccount(String value) { this.Account = value; return this; }
public String getConfirmationNbr() { return ConfirmationNbr; }
public CarSegmentAndVendor setConfirmationNbr(String value) { this.ConfirmationNbr = value; return this; }
public String getCurrencyCode() { return CurrencyCode; }
public CarSegmentAndVendor setCurrencyCode(String value) { this.CurrencyCode = value; return this; }
public String getRateAmount() { return RateAmount; }
public CarSegmentAndVendor setRateAmount(String value) { this.RateAmount = value; return this; }
public String getCarType() { return CarType; }
public CarSegmentAndVendor setCarType(String value) { this.CarType = value; return this; }
public String getNbrOfCars() { return NbrOfCars; }
public CarSegmentAndVendor setNbrOfCars(String value) { this.NbrOfCars = value; return this; }
public String getBookedInName() { return BookedInName; }
public CarSegmentAndVendor setBookedInName(String value) { this.BookedInName = value; return this; }
public String getServiceInformation() { return ServiceInformation; }
public CarSegmentAndVendor setServiceInformation(String value) { this.ServiceInformation = value; return this; }
public String getBrInformation() { return BRInformation; }
public CarSegmentAndVendor setBrInformation(String value) { this.BRInformation = value; return this; }
}
}
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
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /CarSegments HTTP/1.1 Host: api.agentivity.com Accept: application/json
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":[{"OwningAgencyLocation":"String","PNR":"String","Consultant":"String","SegmentStatus":"String","PickUpDate":"String","DropOffDate":"String","CarVendorCode":"String","VendorName":"String","AirportCode":"String","Passenger":"String","Account":"String","ConfirmationNbr":"String","CurrencyCode":"String","RateAmount":"String","CarType":"String","NbrOfCars":"String","BookedInName":"String","ServiceInformation":"String","BRInformation":"String"}],"ResponseError":{"ErrorCode":"String","Message":"String","StatusCode":"String","VerboseMessage":"String"}}