| GET | /SegmentsQC |
|---|
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 SegmentsQC extends CompanyLevelRequestBase
{
/**
* Comma Delimited List of Accounts
*/
@DataMember
public ArrayList<String> Account = null;
/**
* Date in format YYYYMMDD
*/
@DataMember
public String DepartureDateStart = null;
/**
* Date in format YYYYMMDD
*/
@DataMember
public String DepartureDateEnd = null;
/**
* Return only segments that are flagged as VIP only
*/
@DataMember
public Boolean VipOnly = null;
public ArrayList<String> getAccount() { return Account; }
public SegmentsQC setAccount(ArrayList<String> value) { this.Account = value; return this; }
public String getDepartureDateStart() { return DepartureDateStart; }
public SegmentsQC setDepartureDateStart(String value) { this.DepartureDateStart = value; return this; }
public String getDepartureDateEnd() { return DepartureDateEnd; }
public SegmentsQC setDepartureDateEnd(String value) { this.DepartureDateEnd = value; return this; }
public Boolean isVipOnly() { return VipOnly; }
public SegmentsQC setVipOnly(Boolean value) { this.VipOnly = 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 SegmentsQCItemResponse extends ItemResponse<SegmentQC, SegmentsQCResponseReport>
{
}
@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="SegmentQC", Namespace="schemas.agentivity.com/types")
public static class SegmentQC
{
@DataMember(Order=10)
public Integer AgentivityRef = null;
@DataMember(Order=20)
public String RecordLocator = null;
@DataMember(Order=30)
public String OwningConsultant = null;
@DataMember(Order=40)
public String Passenger = null;
@DataMember(Order=45)
public String Account = null;
@DataMember(Order=50)
public String BoardPoint = null;
@DataMember(Order=50)
public String OffPoint = null;
@DataMember(Order=60)
public String DepartureTime = null;
@DataMember(Order=70)
public String BookingClass = null;
@DataMember(Order=80)
public String SegmentStatus = null;
@DataMember(Order=90)
public String CarrierCode = null;
@DataMember(Order=100)
public String FlightNbr = null;
@DataMember(Order=105)
public String FlightNumberFromatted = null;
@DataMember(Order=110)
public QcCheck SeatCheck = null;
@DataMember(Order=120)
public String SeatFormatted = null;
@DataMember(Order=130)
public QcCheck MealCheck = null;
@DataMember(Order=155)
public String MealFormatted = null;
@DataMember(Order=160)
public String ChauffeurDesc = null;
@DataMember(Order=170)
public String TransferDesc = null;
@DataMember(Order=180)
public String CarsFormatted = null;
@DataMember(Order=190)
public QcCheck HoteCheck = null;
@DataMember(Order=200)
public String Hotels = null;
@DataMember(Order=210)
public String ShuttleDesc = null;
@DataMember(Order=220)
public String TourDesc = null;
@DataMember(Order=230)
public String FrequentFlyerNumbers = null;
@DataMember(Order=240)
public String PnrTicketed = null;
@DataMember(Order=250)
public String TicketNumber = null;
@DataMember(Order=260)
public String Comments = null;
@DataMember(Order=270)
public String OpsComments = null;
@DataMember(Order=280)
public Boolean IsVip = null;
@DataMember(Order=290)
public String CorporateFFs = null;
@DataMember(Order=300)
public String VendorLocator = null;
public Integer getAgentivityRef() { return AgentivityRef; }
public SegmentQC setAgentivityRef(Integer value) { this.AgentivityRef = value; return this; }
public String getRecordLocator() { return RecordLocator; }
public SegmentQC setRecordLocator(String value) { this.RecordLocator = value; return this; }
public String getOwningConsultant() { return OwningConsultant; }
public SegmentQC setOwningConsultant(String value) { this.OwningConsultant = value; return this; }
public String getPassenger() { return Passenger; }
public SegmentQC setPassenger(String value) { this.Passenger = value; return this; }
public String getAccount() { return Account; }
public SegmentQC setAccount(String value) { this.Account = value; return this; }
public String getBoardPoint() { return BoardPoint; }
public SegmentQC setBoardPoint(String value) { this.BoardPoint = value; return this; }
public String getOffPoint() { return OffPoint; }
public SegmentQC setOffPoint(String value) { this.OffPoint = value; return this; }
public String getDepartureTime() { return DepartureTime; }
public SegmentQC setDepartureTime(String value) { this.DepartureTime = value; return this; }
public String getBookingClass() { return BookingClass; }
public SegmentQC setBookingClass(String value) { this.BookingClass = value; return this; }
public String getSegmentStatus() { return SegmentStatus; }
public SegmentQC setSegmentStatus(String value) { this.SegmentStatus = value; return this; }
public String getCarrierCode() { return CarrierCode; }
public SegmentQC setCarrierCode(String value) { this.CarrierCode = value; return this; }
public String getFlightNbr() { return FlightNbr; }
public SegmentQC setFlightNbr(String value) { this.FlightNbr = value; return this; }
public String getFlightNumberFromatted() { return FlightNumberFromatted; }
public SegmentQC setFlightNumberFromatted(String value) { this.FlightNumberFromatted = value; return this; }
public QcCheck getSeatCheck() { return SeatCheck; }
public SegmentQC setSeatCheck(QcCheck value) { this.SeatCheck = value; return this; }
public String getSeatFormatted() { return SeatFormatted; }
public SegmentQC setSeatFormatted(String value) { this.SeatFormatted = value; return this; }
public QcCheck getMealCheck() { return MealCheck; }
public SegmentQC setMealCheck(QcCheck value) { this.MealCheck = value; return this; }
public String getMealFormatted() { return MealFormatted; }
public SegmentQC setMealFormatted(String value) { this.MealFormatted = value; return this; }
public String getChauffeurDesc() { return ChauffeurDesc; }
public SegmentQC setChauffeurDesc(String value) { this.ChauffeurDesc = value; return this; }
public String getTransferDesc() { return TransferDesc; }
public SegmentQC setTransferDesc(String value) { this.TransferDesc = value; return this; }
public String getCarsFormatted() { return CarsFormatted; }
public SegmentQC setCarsFormatted(String value) { this.CarsFormatted = value; return this; }
public QcCheck getHoteCheck() { return HoteCheck; }
public SegmentQC setHoteCheck(QcCheck value) { this.HoteCheck = value; return this; }
public String getHotels() { return Hotels; }
public SegmentQC setHotels(String value) { this.Hotels = value; return this; }
public String getShuttleDesc() { return ShuttleDesc; }
public SegmentQC setShuttleDesc(String value) { this.ShuttleDesc = value; return this; }
public String getTourDesc() { return TourDesc; }
public SegmentQC setTourDesc(String value) { this.TourDesc = value; return this; }
public String getFrequentFlyerNumbers() { return FrequentFlyerNumbers; }
public SegmentQC setFrequentFlyerNumbers(String value) { this.FrequentFlyerNumbers = value; return this; }
public String getPnrTicketed() { return PnrTicketed; }
public SegmentQC setPnrTicketed(String value) { this.PnrTicketed = value; return this; }
public String getTicketNumber() { return TicketNumber; }
public SegmentQC setTicketNumber(String value) { this.TicketNumber = value; return this; }
public String getComments() { return Comments; }
public SegmentQC setComments(String value) { this.Comments = value; return this; }
public String getOpsComments() { return OpsComments; }
public SegmentQC setOpsComments(String value) { this.OpsComments = value; return this; }
public Boolean getIsVip() { return IsVip; }
public SegmentQC setIsVip(Boolean value) { this.IsVip = value; return this; }
public String getCorporateFFs() { return CorporateFFs; }
public SegmentQC setCorporateFFs(String value) { this.CorporateFFs = value; return this; }
public String getVendorLocator() { return VendorLocator; }
public SegmentQC setVendorLocator(String value) { this.VendorLocator = value; return this; }
}
public static enum QcCheck
{
Missing,
Warning,
Valid,
Denied;
}
@DataContract(Name="SegmentQC", Namespace="schemas.agentivity.com/types")
public static class SegmentsQCResponseReport extends Report<SegmentsQCItemResponse, SegmentQC>
{
}
@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 .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /SegmentsQC HTTP/1.1 Host: api.agentivity.com Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<AgentivityResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="schemas.agentivity.com/types">
<ResponseMetadata>
<Success>false</Success>
<HasCache>false</HasCache>
<HasPaging>false</HasPaging>
<CacheMetadata>
<IsFromCache>false</IsFromCache>
<CachedAt>0001-01-01T00:00:00</CachedAt>
<CacheExpiresAt>0001-01-01T00:00:00</CacheExpiresAt>
</CacheMetadata>
<PagingMetadata>
<Limit>String</Limit>
<Offset>String</Offset>
<ResponseRecords>0</ResponseRecords>
<TotalRecords>0</TotalRecords>
</PagingMetadata>
</ResponseMetadata>
<ResponseReport>
<Item>
<AgentivityRef>0</AgentivityRef>
<RecordLocator>String</RecordLocator>
<OwningConsultant>String</OwningConsultant>
<Passenger>String</Passenger>
<Account>String</Account>
<BoardPoint>String</BoardPoint>
<OffPoint>String</OffPoint>
<DepartureTime>String</DepartureTime>
<BookingClass>String</BookingClass>
<SegmentStatus>String</SegmentStatus>
<CarrierCode>String</CarrierCode>
<FlightNbr>String</FlightNbr>
<FlightNumberFromatted>String</FlightNumberFromatted>
<SeatCheck>Missing</SeatCheck>
<SeatFormatted>String</SeatFormatted>
<MealCheck>Missing</MealCheck>
<MealFormatted>String</MealFormatted>
<ChauffeurDesc>String</ChauffeurDesc>
<TransferDesc>String</TransferDesc>
<CarsFormatted>String</CarsFormatted>
<HoteCheck>Missing</HoteCheck>
<Hotels>String</Hotels>
<ShuttleDesc>String</ShuttleDesc>
<TourDesc>String</TourDesc>
<FrequentFlyerNumbers>String</FrequentFlyerNumbers>
<PnrTicketed>String</PnrTicketed>
<TicketNumber>String</TicketNumber>
<Comments>String</Comments>
<OpsComments>String</OpsComments>
<IsVip>false</IsVip>
<CorporateFFs>String</CorporateFFs>
<VendorLocator>String</VendorLocator>
</Item>
</ResponseReport>
<ResponseError>
<ErrorCode>String</ErrorCode>
<Message>String</Message>
<StatusCode>String</StatusCode>
<VerboseMessage>String</VerboseMessage>
</ResponseError>
</AgentivityResponse>