| GET | /PassiveSegments |
|---|
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 PassiveSegmentsByUser extends CompanyLevelRequestBase
{
/**
* Date in format YYYYMMDD
*/
@DataMember
public String ArrivalDateEnd = null;
/**
* Date in format YYYYMMDD
*/
@DataMember
public String ArrivalDateStart = null;
/**
* Type of segment
*/
@DataMember
public String SegmentType = null;
/**
* Account
*/
@DataMember
public String Account = null;
/**
* 3 letter city code
*/
@DataMember
public String CityCode = 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 String getArrivalDateEnd() { return ArrivalDateEnd; }
public PassiveSegmentsByUser setArrivalDateEnd(String value) { this.ArrivalDateEnd = value; return this; }
public String getArrivalDateStart() { return ArrivalDateStart; }
public PassiveSegmentsByUser setArrivalDateStart(String value) { this.ArrivalDateStart = value; return this; }
public String getSegmentType() { return SegmentType; }
public PassiveSegmentsByUser setSegmentType(String value) { this.SegmentType = value; return this; }
public String getAccount() { return Account; }
public PassiveSegmentsByUser setAccount(String value) { this.Account = value; return this; }
public String getCityCode() { return CityCode; }
public PassiveSegmentsByUser setCityCode(String value) { this.CityCode = value; return this; }
public String getDateSearchType() { return DateSearchType; }
public PassiveSegmentsByUser 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; }
}
@DataContract(Name="AgentivityResponse", Namespace="schemas.agentivity.com/types")
public static class PassiveSegmentsResponse extends ItemResponse<PassiveSegmentWithOwningInformation, PassiveSegmentsByUserResponseReport>
{
}
@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="PassiveSegmentWithOwningInformation", Namespace="schemas.agentivity.com/types")
public static class PassiveSegmentWithOwningInformation
{
@DataMember
public Integer AgentivityRef = null;
@DataMember(Order=20)
public String OwningAgencyLocationID = null;
@DataMember(Order=10)
public String RecordLocator = null;
@DataMember
public String OwningConsultantID = null;
@DataMember(Order=30)
public String OwningConsultant = null;
@DataMember(Order=40)
public String Account = null;
@DataMember(Order=70)
public String SegmentStatus = null;
@DataMember
public String StartDate = null;
@DataMember(Order=60)
public String DepartureDate = null;
@DataMember
public String NbrNights = null;
@DataMember
public String VendorCode = null;
@DataMember
public String CityCode = null;
@DataMember
public String SegmentType = null;
@DataMember
public String Text = null;
@DataMember(Order=50)
public String Passenger = null;
@DataMember
public String Address = null;
@DataMember
public String BookingReasonCode = null;
@DataMember
public String BookingSource = null;
@DataMember
public String CommissionInformation = null;
@DataMember
public String ConfirmationNumber = null;
@DataMember
public String RateCode = null;
@DataMember
public String RateQuoted = null;
@DataMember
public String RateAccessCode = null;
@DataMember
public String PropertyName = null;
@DataMember
public String PropertyNumber = null;
@DataMember
public String ServiceInformation = null;
@DataMember
public String TotalAirSegs = null;
@DataMember
public String HotelCommission = null;
@DataMember
public String CountryName = null;
public Integer getAgentivityRef() { return AgentivityRef; }
public PassiveSegmentWithOwningInformation setAgentivityRef(Integer value) { this.AgentivityRef = value; return this; }
public String getOwningAgencyLocationID() { return OwningAgencyLocationID; }
public PassiveSegmentWithOwningInformation setOwningAgencyLocationID(String value) { this.OwningAgencyLocationID = value; return this; }
public String getRecordLocator() { return RecordLocator; }
public PassiveSegmentWithOwningInformation setRecordLocator(String value) { this.RecordLocator = value; return this; }
public String getOwningConsultantID() { return OwningConsultantID; }
public PassiveSegmentWithOwningInformation setOwningConsultantID(String value) { this.OwningConsultantID = value; return this; }
public String getOwningConsultant() { return OwningConsultant; }
public PassiveSegmentWithOwningInformation setOwningConsultant(String value) { this.OwningConsultant = value; return this; }
public String getAccount() { return Account; }
public PassiveSegmentWithOwningInformation setAccount(String value) { this.Account = value; return this; }
public String getSegmentStatus() { return SegmentStatus; }
public PassiveSegmentWithOwningInformation setSegmentStatus(String value) { this.SegmentStatus = value; return this; }
public String getStartDate() { return StartDate; }
public PassiveSegmentWithOwningInformation setStartDate(String value) { this.StartDate = value; return this; }
public String getDepartureDate() { return DepartureDate; }
public PassiveSegmentWithOwningInformation setDepartureDate(String value) { this.DepartureDate = value; return this; }
public String getNbrNights() { return NbrNights; }
public PassiveSegmentWithOwningInformation setNbrNights(String value) { this.NbrNights = value; return this; }
public String getVendorCode() { return VendorCode; }
public PassiveSegmentWithOwningInformation setVendorCode(String value) { this.VendorCode = value; return this; }
public String getCityCode() { return CityCode; }
public PassiveSegmentWithOwningInformation setCityCode(String value) { this.CityCode = value; return this; }
public String getSegmentType() { return SegmentType; }
public PassiveSegmentWithOwningInformation setSegmentType(String value) { this.SegmentType = value; return this; }
public String getText() { return Text; }
public PassiveSegmentWithOwningInformation setText(String value) { this.Text = value; return this; }
public String getPassenger() { return Passenger; }
public PassiveSegmentWithOwningInformation setPassenger(String value) { this.Passenger = value; return this; }
public String getAddress() { return Address; }
public PassiveSegmentWithOwningInformation setAddress(String value) { this.Address = value; return this; }
public String getBookingReasonCode() { return BookingReasonCode; }
public PassiveSegmentWithOwningInformation setBookingReasonCode(String value) { this.BookingReasonCode = value; return this; }
public String getBookingSource() { return BookingSource; }
public PassiveSegmentWithOwningInformation setBookingSource(String value) { this.BookingSource = value; return this; }
public String getCommissionInformation() { return CommissionInformation; }
public PassiveSegmentWithOwningInformation setCommissionInformation(String value) { this.CommissionInformation = value; return this; }
public String getConfirmationNumber() { return ConfirmationNumber; }
public PassiveSegmentWithOwningInformation setConfirmationNumber(String value) { this.ConfirmationNumber = value; return this; }
public String getRateCode() { return RateCode; }
public PassiveSegmentWithOwningInformation setRateCode(String value) { this.RateCode = value; return this; }
public String getRateQuoted() { return RateQuoted; }
public PassiveSegmentWithOwningInformation setRateQuoted(String value) { this.RateQuoted = value; return this; }
public String getRateAccessCode() { return RateAccessCode; }
public PassiveSegmentWithOwningInformation setRateAccessCode(String value) { this.RateAccessCode = value; return this; }
public String getPropertyName() { return PropertyName; }
public PassiveSegmentWithOwningInformation setPropertyName(String value) { this.PropertyName = value; return this; }
public String getPropertyNumber() { return PropertyNumber; }
public PassiveSegmentWithOwningInformation setPropertyNumber(String value) { this.PropertyNumber = value; return this; }
public String getServiceInformation() { return ServiceInformation; }
public PassiveSegmentWithOwningInformation setServiceInformation(String value) { this.ServiceInformation = value; return this; }
public String getTotalAirSegs() { return TotalAirSegs; }
public PassiveSegmentWithOwningInformation setTotalAirSegs(String value) { this.TotalAirSegs = value; return this; }
public String getHotelCommission() { return HotelCommission; }
public PassiveSegmentWithOwningInformation setHotelCommission(String value) { this.HotelCommission = value; return this; }
public String getCountryName() { return CountryName; }
public PassiveSegmentWithOwningInformation setCountryName(String value) { this.CountryName = value; return this; }
}
@DataContract(Name="PassiveSegmentWithOwningInformation", Namespace="schemas.agentivity.com/types")
public static class PassiveSegmentsByUserResponseReport extends Report<PassiveSegmentsResponse, PassiveSegmentWithOwningInformation>
{
}
@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; }
}
}
Java PassiveSegmentsByUser DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /PassiveSegments HTTP/1.1 Host: api.agentivity.com Accept: text/jsonl
HTTP/1.1 200 OK
Content-Type: text/jsonl
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":0,"OwningConsultantID":"String","StartDate":"String","NbrNights":"String","VendorCode":"String","CityCode":"String","SegmentType":"String","Text":"String","Address":"String","BookingReasonCode":"String","BookingSource":"String","CommissionInformation":"String","ConfirmationNumber":"String","RateCode":"String","RateQuoted":"String","RateAccessCode":"String","PropertyName":"String","PropertyNumber":"String","ServiceInformation":"String","TotalAirSegs":"String","HotelCommission":"String","CountryName":"String","RecordLocator":"String","OwningAgencyLocationID":"String","OwningConsultant":"String","Account":"String","Passenger":"String","DepartureDate":"String","SegmentStatus":"String"}},"ResponseError":{"ErrorCode":"String","Message":"String","StatusCode":"String","VerboseMessage":"String"}}