| GET | /BookingsByConsultant |
|---|
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 GetBookingsByConsultant extends CompanyLevelRequestBase
{
/**
* Date in format YYYYMMDD
*/
@DataMember
public String PNRCreationDateStart = null;
/**
* Date in format YYYYMMDD
*/
@DataMember
public String PNRCreationDateEnd = null;
/**
* Comma delimited list of owning consultants ids
*/
@DataMember
public ArrayList<String> OwningConsultantID = new ArrayList<String>();
/**
* Obsolete parameter; it will be removed in future versions
*/
@DataMember
public String OwningConsultant = null;
/**
* Include Itinerary in the response
*/
@DataMember
public Boolean IncludeItinerary = null;
/**
* Indicates the required formatting: 0=None(Default); 1= Html; 2 = Chart
*/
@DataMember
public FormattingStyle ItineraryFormatting = null;
public String getPnrCreationDateStart() { return PNRCreationDateStart; }
public GetBookingsByConsultant setPnrCreationDateStart(String value) { this.PNRCreationDateStart = value; return this; }
public String getPnrCreationDateEnd() { return PNRCreationDateEnd; }
public GetBookingsByConsultant setPnrCreationDateEnd(String value) { this.PNRCreationDateEnd = value; return this; }
public ArrayList<String> getOwningConsultantID() { return OwningConsultantID; }
public GetBookingsByConsultant setOwningConsultantID(ArrayList<String> value) { this.OwningConsultantID = value; return this; }
public String getOwningConsultant() { return OwningConsultant; }
public GetBookingsByConsultant setOwningConsultant(String value) { this.OwningConsultant = value; return this; }
public Boolean isIncludeItinerary() { return IncludeItinerary; }
public GetBookingsByConsultant setIncludeItinerary(Boolean value) { this.IncludeItinerary = value; return this; }
public FormattingStyle getItineraryFormatting() { return ItineraryFormatting; }
public GetBookingsByConsultant setItineraryFormatting(FormattingStyle value) { this.ItineraryFormatting = 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; }
}
@Flags()
public static enum FormattingStyle
{
@SerializedName("0") None(0),
@SerializedName("1") Html(1),
@SerializedName("2") Charting(2);
private final int value;
FormattingStyle(final int intValue) { value = intValue; }
public int getValue() { return value; }
}
@DataContract(Name="AgentivityResponse", Namespace="schemas.agentivity.com/types")
public static class BookingsByConsultantItemResponse extends ItemResponse<BookingByConsultant, BookingsByConsultantResponseReport>
{
}
@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="BookingByConsultant", Namespace="schemas.agentivity.com/types")
public static class BookingByConsultant implements IBookingItinerary
{
@DataMember(Order=20)
public String RecordLocator = null;
@DataMember(Order=30)
public Date PNRCreationDate = null;
@DataMember(Order=35)
public String CountryCountGroup = null;
@DataMember(Order=40)
public String Passenger = null;
@DataMember(Order=50)
public String Account = null;
@DataMember(Order=60)
public Date TravelDate = null;
@DataMember(Order=70)
public String PnrTicketed = null;
@DataMember(Order=80)
public String PnrCancelled = null;
@DataMember(Order=85)
public String AgentInitials = null;
@DataMember(Order=90)
public String IsChurned = null;
@DataMember(Order=10)
public Integer AgentivityRef = null;
@DataMember(Order=200)
public ItinerarySegmentsCollection Itinerary = null;
@DataMember(Order=210)
public String ItineraryFormatted = null;
public String getRecordLocator() { return RecordLocator; }
public BookingByConsultant setRecordLocator(String value) { this.RecordLocator = value; return this; }
public Date getPnrCreationDate() { return PNRCreationDate; }
public BookingByConsultant setPnrCreationDate(Date value) { this.PNRCreationDate = value; return this; }
public String getCountryCountGroup() { return CountryCountGroup; }
public BookingByConsultant setCountryCountGroup(String value) { this.CountryCountGroup = value; return this; }
public String getPassenger() { return Passenger; }
public BookingByConsultant setPassenger(String value) { this.Passenger = value; return this; }
public String getAccount() { return Account; }
public BookingByConsultant setAccount(String value) { this.Account = value; return this; }
public Date getTravelDate() { return TravelDate; }
public BookingByConsultant setTravelDate(Date value) { this.TravelDate = value; return this; }
public String getPnrTicketed() { return PnrTicketed; }
public BookingByConsultant setPnrTicketed(String value) { this.PnrTicketed = value; return this; }
public String getPnrCancelled() { return PnrCancelled; }
public BookingByConsultant setPnrCancelled(String value) { this.PnrCancelled = value; return this; }
public String getAgentInitials() { return AgentInitials; }
public BookingByConsultant setAgentInitials(String value) { this.AgentInitials = value; return this; }
public String getIsChurned() { return IsChurned; }
public BookingByConsultant setIsChurned(String value) { this.IsChurned = value; return this; }
public Integer getAgentivityRef() { return AgentivityRef; }
public BookingByConsultant setAgentivityRef(Integer value) { this.AgentivityRef = value; return this; }
public ItinerarySegmentsCollection getItinerary() { return Itinerary; }
public BookingByConsultant setItinerary(ItinerarySegmentsCollection value) { this.Itinerary = value; return this; }
public String getItineraryFormatted() { return ItineraryFormatted; }
public BookingByConsultant setItineraryFormatted(String value) { this.ItineraryFormatted = value; return this; }
}
public static class ItinerarySegmentsCollection extends ArrayList<ItinerarySegment>
{
}
@DataContract(Name="ItinerarySegment", Namespace="schemas.agentivity.com/types")
public static class ItinerarySegment
{
@DataMember
public String SegmentType = null;
@DataMember
public Integer SegmentNbr = null;
@DataMember
public String BoardPoint = null;
@DataMember
public String OffPoint = null;
@DataMember
public String OperatorCode = null;
@DataMember
public String OperatorService = null;
@DataMember
public String SegmentStatus = null;
@DataMember
public String DepartureTimeFormatted = null;
@DataMember
public String ArrivalTimeFormatted = null;
@DataMember
public String ChangeOfDayFormatted = null;
@DataMember
public String ServiceCode = null;
@DataMember
public String StartDate = null;
@DataMember
public String EndDate = null;
@DataMember
public String TicketNumber = null;
/**
* Comma separated list of vendor locators
*/
@DataMember
public String VendorLocators = null;
@DataMember
public String EquipmentCode = null;
@DataMember
public String Equipment = null;
public String getSegmentType() { return SegmentType; }
public ItinerarySegment setSegmentType(String value) { this.SegmentType = value; return this; }
public Integer getSegmentNbr() { return SegmentNbr; }
public ItinerarySegment setSegmentNbr(Integer value) { this.SegmentNbr = value; return this; }
public String getBoardPoint() { return BoardPoint; }
public ItinerarySegment setBoardPoint(String value) { this.BoardPoint = value; return this; }
public String getOffPoint() { return OffPoint; }
public ItinerarySegment setOffPoint(String value) { this.OffPoint = value; return this; }
public String getOperatorCode() { return OperatorCode; }
public ItinerarySegment setOperatorCode(String value) { this.OperatorCode = value; return this; }
public String getOperatorService() { return OperatorService; }
public ItinerarySegment setOperatorService(String value) { this.OperatorService = value; return this; }
public String getSegmentStatus() { return SegmentStatus; }
public ItinerarySegment setSegmentStatus(String value) { this.SegmentStatus = value; return this; }
public String getDepartureTimeFormatted() { return DepartureTimeFormatted; }
public ItinerarySegment setDepartureTimeFormatted(String value) { this.DepartureTimeFormatted = value; return this; }
public String getArrivalTimeFormatted() { return ArrivalTimeFormatted; }
public ItinerarySegment setArrivalTimeFormatted(String value) { this.ArrivalTimeFormatted = value; return this; }
public String getChangeOfDayFormatted() { return ChangeOfDayFormatted; }
public ItinerarySegment setChangeOfDayFormatted(String value) { this.ChangeOfDayFormatted = value; return this; }
public String getServiceCode() { return ServiceCode; }
public ItinerarySegment setServiceCode(String value) { this.ServiceCode = value; return this; }
public String getStartDate() { return StartDate; }
public ItinerarySegment setStartDate(String value) { this.StartDate = value; return this; }
public String getEndDate() { return EndDate; }
public ItinerarySegment setEndDate(String value) { this.EndDate = value; return this; }
public String getTicketNumber() { return TicketNumber; }
public ItinerarySegment setTicketNumber(String value) { this.TicketNumber = value; return this; }
public String getVendorLocators() { return VendorLocators; }
public ItinerarySegment setVendorLocators(String value) { this.VendorLocators = value; return this; }
public String getEquipmentCode() { return EquipmentCode; }
public ItinerarySegment setEquipmentCode(String value) { this.EquipmentCode = value; return this; }
public String getEquipment() { return Equipment; }
public ItinerarySegment setEquipment(String value) { this.Equipment = value; return this; }
}
@DataContract(Name="BookingByConsultant", Namespace="schemas.agentivity.com/types")
public static class BookingsByConsultantResponseReport extends Report<BookingsByConsultantItemResponse, BookingByConsultant>
{
}
@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 GetBookingsByConsultant DTOs
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 /BookingsByConsultant 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":0,"RecordLocator":"String","PNRCreationDate":"\/Date(-62135596800000-0000)\/","CountryCountGroup":"String","Passenger":"String","Account":"String","TravelDate":"\/Date(-62135596800000-0000)\/","PnrTicketed":"String","PnrCancelled":"String","AgentInitials":"String","IsChurned":"String","Itinerary":[{"SegmentType":"String","SegmentNbr":0,"BoardPoint":"String","OffPoint":"String","OperatorCode":"String","OperatorService":"String","SegmentStatus":"String","DepartureTimeFormatted":"String","ArrivalTimeFormatted":"String","ChangeOfDayFormatted":"String","ServiceCode":"String","StartDate":"String","EndDate":"String","TicketNumber":"String","VendorLocators":"String","EquipmentCode":"String","Equipment":"String"}],"ItineraryFormatted":"String"}},"ResponseError":{"ErrorCode":"String","Message":"String","StatusCode":"String","VerboseMessage":"String"}}