Agentivity API

<back to all web services

GetTicketsIssuedByNumber

The following routes are available for this service:
GET/TicketsIssuedByNumber
import java.math.*;
import java.util.*;
import java.io.InputStream;
import net.servicestack.client.*;
import com.google.gson.annotations.*;
import com.google.gson.reflect.*;

public class dtos
{

    @DataContract(Namespace="schemas.agentivity.com/types")
    public static class GetTicketsIssuedByNumber extends CompanyLevelRequestBase
    {
        /**
        * Ticket number
        */
        @DataMember
        public String TktNumber = null;
        
        public String getTktNumber() { return TktNumber; }
        public GetTicketsIssuedByNumber setTktNumber(String value) { this.TktNumber = 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 CollectionResponse<TItem>
    {
        @DataMember(Order=1)
        public ResponseMetadata ResponseMetadata = null;

        @DataMember(Order=2, EmitDefaultValue=false)
        public ArrayList<TicketsIssuedByNumber> 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<TicketsIssuedByNumber> getResponseReport() { return ResponseReport; }
        public CollectionResponse<TItem> setResponseReport(ArrayList<TicketsIssuedByNumber> 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="TicketsIssuedByNumber", Namespace="schemas.agentivity.com/types")
    public static class TicketsIssuedByNumber
    {
        @DataMember(Order=10)
        public String RecordLocator = null;

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

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

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

        @DataMember(Order=50)
        public String IATA = null;

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

        @DataMember(Order=70)
        public Date IssueDate = null;

        @DataMember(Order=80)
        public Date ExpirationDate = null;

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

        @DataMember(Order=100)
        public String PrintedCurrency = null;

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

        @DataMember(Order=120)
        public String TicketingAgent = null;
        
        public String getRecordLocator() { return RecordLocator; }
        public TicketsIssuedByNumber setRecordLocator(String value) { this.RecordLocator = value; return this; }
        public String getTktNumber() { return TktNumber; }
        public TicketsIssuedByNumber setTktNumber(String value) { this.TktNumber = value; return this; }
        public String getPlatingCarrier() { return PlatingCarrier; }
        public TicketsIssuedByNumber setPlatingCarrier(String value) { this.PlatingCarrier = value; return this; }
        public String getPassenger() { return Passenger; }
        public TicketsIssuedByNumber setPassenger(String value) { this.Passenger = value; return this; }
        public String getIata() { return IATA; }
        public TicketsIssuedByNumber setIata(String value) { this.IATA = value; return this; }
        public String getOwningAgencyLocationID() { return OwningAgencyLocationID; }
        public TicketsIssuedByNumber setOwningAgencyLocationID(String value) { this.OwningAgencyLocationID = value; return this; }
        public Date getIssueDate() { return IssueDate; }
        public TicketsIssuedByNumber setIssueDate(Date value) { this.IssueDate = value; return this; }
        public Date getExpirationDate() { return ExpirationDate; }
        public TicketsIssuedByNumber setExpirationDate(Date value) { this.ExpirationDate = value; return this; }
        public String getFopFare() { return FOPFare; }
        public TicketsIssuedByNumber setFopFare(String value) { this.FOPFare = value; return this; }
        public String getPrintedCurrency() { return PrintedCurrency; }
        public TicketsIssuedByNumber setPrintedCurrency(String value) { this.PrintedCurrency = value; return this; }
        public String getTicketingAgentID() { return TicketingAgentID; }
        public TicketsIssuedByNumber setTicketingAgentID(String value) { this.TicketingAgentID = value; return this; }
        public String getTicketingAgent() { return TicketingAgent; }
        public TicketsIssuedByNumber setTicketingAgent(String value) { this.TicketingAgent = 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; }
    }

}

Java GetTicketsIssuedByNumber 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 /TicketsIssuedByNumber 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":[{"RecordLocator":"String","TktNumber":"String","PlatingCarrier":"String","Passenger":"String","IATA":"String","OwningAgencyLocationID":"String","IssueDate":"\/Date(-62135596800000-0000)\/","ExpirationDate":"\/Date(-62135596800000-0000)\/","FOPFare":"String","PrintedCurrency":"String","TicketingAgentID":"String","TicketingAgent":"String"}],"ResponseError":{"ErrorCode":"String","Message":"String","StatusCode":"String","VerboseMessage":"String"}}