Agentivity API

<back to all web services

TicketCouponsIssued

The following routes are available for this service:
GET/TicketCouponsIssued
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 TicketCouponsIssued extends PagingMetadata
    {
        /**
        * Comma Delimited List of Accounts
        */
        @DataMember
        public ArrayList<String> Account = null;

        /**
        * UserName in form of an email address
        */
        @DataMember
        public String UserName = null;

        /**
        * Date in format YYYYMMDD
        */
        @DataMember
        public String IssueDateStart = null;

        /**
        * Date in format YYYYMMDD
        */
        @DataMember
        public String IssueDateEnd = null;

        /**
        * ID of a travel agent
        */
        @DataMember
        public String TravelAgentID = null;

        /**
        * One letter code for flight coupon status
        */
        @DataMember
        public String FlightCouponStatus = null;

        /**
        * Format style
        */
        @DataMember
        public String FormatStyle = null;
        
        public ArrayList<String> getAccount() { return Account; }
        public TicketCouponsIssued setAccount(ArrayList<String> value) { this.Account = value; return this; }
        public String getUserName() { return UserName; }
        public TicketCouponsIssued setUserName(String value) { this.UserName = value; return this; }
        public String getIssueDateStart() { return IssueDateStart; }
        public TicketCouponsIssued setIssueDateStart(String value) { this.IssueDateStart = value; return this; }
        public String getIssueDateEnd() { return IssueDateEnd; }
        public TicketCouponsIssued setIssueDateEnd(String value) { this.IssueDateEnd = value; return this; }
        public String getTravelAgentID() { return TravelAgentID; }
        public TicketCouponsIssued setTravelAgentID(String value) { this.TravelAgentID = value; return this; }
        public String getFlightCouponStatus() { return FlightCouponStatus; }
        public TicketCouponsIssued setFlightCouponStatus(String value) { this.FlightCouponStatus = value; return this; }
        public String getFormatStyle() { return FormatStyle; }
        public TicketCouponsIssued setFormatStyle(String value) { this.FormatStyle = 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 TicketCouponsIssuedItemResponse extends ItemResponse<TicketCouponIssued, TicketCouponsIssuedResponseReport>
    {
        
    }

    @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="TicketCoupon", Namespace="schemas.agentivity.com/types")
    public static class TicketCouponIssued
    {
        @DataMember(Order=10)
        public String RecordLocator = null;

        @DataMember(Order=20)
        public Date PNRCreationDate = null;

        @DataMember(Order=30)
        public String TktNumber = null;

        @DataMember(Order=40)
        public String Passenger = null;

        @DataMember(Order=50)
        public Date VendorIssueDate = null;

        @DataMember(Order=60)
        public String FOP = null;

        @DataMember(Order=70)
        public String FOPCurrncy = null;

        @DataMember(Order=80)
        public String FOPFare = null;

        @DataMember(Order=90)
        public String CouponSequenceNbr = null;

        @DataMember(Order=100)
        public Date FlightDate = null;

        @DataMember(Order=110)
        public String Routing = null;

        @DataMember(Order=120)
        public String FlightServiceClass = null;

        @DataMember(Order=130)
        public String FareBasis = null;

        @DataMember(Order=140)
        public String Carrier = null;

        @DataMember(Order=150)
        public String Account = null;

        @DataMember(Order=160)
        public String OwningAgencyLocationID = null;

        @DataMember(Order=170)
        public String FlightCouponStatus = null;

        @DataMember(Order=180)
        public Date DateLastChecked = null;

        @DataMember(Order=190)
        public String OwningConsultantID = null;

        @DataMember(Order=200)
        public String TicketingAgent = null;
        
        public String getRecordLocator() { return RecordLocator; }
        public TicketCouponIssued setRecordLocator(String value) { this.RecordLocator = value; return this; }
        public Date getPnrCreationDate() { return PNRCreationDate; }
        public TicketCouponIssued setPnrCreationDate(Date value) { this.PNRCreationDate = value; return this; }
        public String getTktNumber() { return TktNumber; }
        public TicketCouponIssued setTktNumber(String value) { this.TktNumber = value; return this; }
        public String getPassenger() { return Passenger; }
        public TicketCouponIssued setPassenger(String value) { this.Passenger = value; return this; }
        public Date getVendorIssueDate() { return VendorIssueDate; }
        public TicketCouponIssued setVendorIssueDate(Date value) { this.VendorIssueDate = value; return this; }
        public String getFop() { return FOP; }
        public TicketCouponIssued setFop(String value) { this.FOP = value; return this; }
        public String getFopCurrncy() { return FOPCurrncy; }
        public TicketCouponIssued setFopCurrncy(String value) { this.FOPCurrncy = value; return this; }
        public String getFopFare() { return FOPFare; }
        public TicketCouponIssued setFopFare(String value) { this.FOPFare = value; return this; }
        public String getCouponSequenceNbr() { return CouponSequenceNbr; }
        public TicketCouponIssued setCouponSequenceNbr(String value) { this.CouponSequenceNbr = value; return this; }
        public Date getFlightDate() { return FlightDate; }
        public TicketCouponIssued setFlightDate(Date value) { this.FlightDate = value; return this; }
        public String getRouting() { return Routing; }
        public TicketCouponIssued setRouting(String value) { this.Routing = value; return this; }
        public String getFlightServiceClass() { return FlightServiceClass; }
        public TicketCouponIssued setFlightServiceClass(String value) { this.FlightServiceClass = value; return this; }
        public String getFareBasis() { return FareBasis; }
        public TicketCouponIssued setFareBasis(String value) { this.FareBasis = value; return this; }
        public String getCarrier() { return Carrier; }
        public TicketCouponIssued setCarrier(String value) { this.Carrier = value; return this; }
        public String getAccount() { return Account; }
        public TicketCouponIssued setAccount(String value) { this.Account = value; return this; }
        public String getOwningAgencyLocationID() { return OwningAgencyLocationID; }
        public TicketCouponIssued setOwningAgencyLocationID(String value) { this.OwningAgencyLocationID = value; return this; }
        public String getFlightCouponStatus() { return FlightCouponStatus; }
        public TicketCouponIssued setFlightCouponStatus(String value) { this.FlightCouponStatus = value; return this; }
        public Date getDateLastChecked() { return DateLastChecked; }
        public TicketCouponIssued setDateLastChecked(Date value) { this.DateLastChecked = value; return this; }
        public String getOwningConsultantID() { return OwningConsultantID; }
        public TicketCouponIssued setOwningConsultantID(String value) { this.OwningConsultantID = value; return this; }
        public String getTicketingAgent() { return TicketingAgent; }
        public TicketCouponIssued setTicketingAgent(String value) { this.TicketingAgent = value; return this; }
    }

    @DataContract(Name="TicketCouponIssued", Namespace="schemas.agentivity.com/types")
    public static class TicketCouponsIssuedResponseReport extends Report<TicketCouponsIssuedItemResponse, TicketCouponIssued>
    {
        
    }

    @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 TicketCouponsIssued DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /TicketCouponsIssued 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":{"RecordLocator":"String","PNRCreationDate":"\/Date(-62135596800000-0000)\/","TktNumber":"String","Passenger":"String","VendorIssueDate":"\/Date(-62135596800000-0000)\/","FOP":"String","FOPCurrncy":"String","FOPFare":"String","CouponSequenceNbr":"String","FlightDate":"\/Date(-62135596800000-0000)\/","Routing":"String","FlightServiceClass":"String","FareBasis":"String","Carrier":"String","Account":"String","OwningAgencyLocationID":"String","FlightCouponStatus":"String","DateLastChecked":"\/Date(-62135596800000-0000)\/","OwningConsultantID":"String","TicketingAgent":"String"}},"ResponseError":{"ErrorCode":"String","Message":"String","StatusCode":"String","VerboseMessage":"String"}}