Agentivity API

<back to all web services

GetTicketDetails

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 GetTicketDetails extends CompanyLevelRequestBase implements IRequestConsultantID
    {
        /**
        * Ticket number
        */
        @DataMember
        public String TktNumber = null;

        /**
        * Cache Guid
        */
        @DataMember
        public String CacheGuid = null;

        /**
        * Request Consultant ID (sign on)
        */
        @DataMember
        public String RequestConsultantID = null;
        
        public String getTktNumber() { return TktNumber; }
        public GetTicketDetails setTktNumber(String value) { this.TktNumber = value; return this; }
        public String getCacheGuid() { return CacheGuid; }
        public GetTicketDetails setCacheGuid(String value) { this.CacheGuid = value; return this; }
        public String getRequestConsultantID() { return RequestConsultantID; }
        public GetTicketDetails setRequestConsultantID(String value) { this.RequestConsultantID = 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 TicketDetailsItemResponse extends ItemResponse<TicketInfo, TicketDetailsResponseReport>
    {
        
    }

    @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="TicketInfo", Namespace="schemas.agentivity.com/types")
    public static class TicketInfo
    {
        @DataMember(Order=5)
        public Integer PassengerTicketID = null;

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

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

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

        @DataMember(Order=40)
        public Date TktIssueDate = null;

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

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

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

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

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

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

        @DataMember(Order=110)
        public Date TicketExpiryDate = null;

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

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

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

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

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

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

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

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

        @DataMember(Order=200)
        public ArrayList<TicketInfoFlightCoupon> Coupons = null;

        @DataMember(Order=210)
        public Boolean EligibleForRefund = null;

        @DataMember(Order=220)
        public Boolean EligibleForCovidStatus = null;

        @DataMember(Order=230)
        public ArrayList<TicketExchange> TicketExchanges = null;

        @DataMember(Order=240)
        public TicketTaxDetails Tax = null;

        @DataMember(Order=500)
        public String OwningCompanyCode = null;
        
        public Integer getPassengerTicketID() { return PassengerTicketID; }
        public TicketInfo setPassengerTicketID(Integer value) { this.PassengerTicketID = value; return this; }
        public String getTktNumber() { return TktNumber; }
        public TicketInfo setTktNumber(String value) { this.TktNumber = value; return this; }
        public String getRecordLocator() { return RecordLocator; }
        public TicketInfo setRecordLocator(String value) { this.RecordLocator = value; return this; }
        public Date getPnrCreationDate() { return PNRCreationDate; }
        public TicketInfo setPnrCreationDate(Date value) { this.PNRCreationDate = value; return this; }
        public Date getTktIssueDate() { return TktIssueDate; }
        public TicketInfo setTktIssueDate(Date value) { this.TktIssueDate = value; return this; }
        public String getPlatingCarrier() { return PlatingCarrier; }
        public TicketInfo setPlatingCarrier(String value) { this.PlatingCarrier = value; return this; }
        public String getStatus() { return Status; }
        public TicketInfo setStatus(String value) { this.Status = value; return this; }
        public String getBar() { return BAR; }
        public TicketInfo setBar(String value) { this.BAR = value; return this; }
        public String getPar() { return PAR; }
        public TicketInfo setPar(String value) { this.PAR = value; return this; }
        public String getLastName() { return LastName; }
        public TicketInfo setLastName(String value) { this.LastName = value; return this; }
        public String getFirstName() { return FirstName; }
        public TicketInfo setFirstName(String value) { this.FirstName = value; return this; }
        public Date getTicketExpiryDate() { return TicketExpiryDate; }
        public TicketInfo setTicketExpiryDate(Date value) { this.TicketExpiryDate = value; return this; }
        public String getFop() { return FOP; }
        public TicketInfo setFop(String value) { this.FOP = value; return this; }
        public String getFopFare() { return FopFare; }
        public TicketInfo setFopFare(String value) { this.FopFare = value; return this; }
        public String getFopCurrency() { return FOPCurrency; }
        public TicketInfo setFopCurrency(String value) { this.FOPCurrency = value; return this; }
        public String getPrintedCurrency() { return PrintedCurrency; }
        public TicketInfo setPrintedCurrency(String value) { this.PrintedCurrency = value; return this; }
        public String getPrintedFare() { return PrintedFare; }
        public TicketInfo setPrintedFare(String value) { this.PrintedFare = value; return this; }
        public String getCreditCardFOPAcct() { return CreditCardFOPAcct; }
        public TicketInfo setCreditCardFOPAcct(String value) { this.CreditCardFOPAcct = value; return this; }
        public String getOwningAgencyLocationID() { return OwningAgencyLocationID; }
        public TicketInfo setOwningAgencyLocationID(String value) { this.OwningAgencyLocationID = value; return this; }
        public String getIata() { return IATA; }
        public TicketInfo setIata(String value) { this.IATA = value; return this; }
        public ArrayList<TicketInfoFlightCoupon> getCoupons() { return Coupons; }
        public TicketInfo setCoupons(ArrayList<TicketInfoFlightCoupon> value) { this.Coupons = value; return this; }
        public Boolean isEligibleForRefund() { return EligibleForRefund; }
        public TicketInfo setEligibleForRefund(Boolean value) { this.EligibleForRefund = value; return this; }
        public Boolean isEligibleForCovidStatus() { return EligibleForCovidStatus; }
        public TicketInfo setEligibleForCovidStatus(Boolean value) { this.EligibleForCovidStatus = value; return this; }
        public ArrayList<TicketExchange> getTicketExchanges() { return TicketExchanges; }
        public TicketInfo setTicketExchanges(ArrayList<TicketExchange> value) { this.TicketExchanges = value; return this; }
        public TicketTaxDetails getTax() { return Tax; }
        public TicketInfo setTax(TicketTaxDetails value) { this.Tax = value; return this; }
        public String getOwningCompanyCode() { return OwningCompanyCode; }
        public TicketInfo setOwningCompanyCode(String value) { this.OwningCompanyCode = value; return this; }
    }

    @DataContract(Name="TicketInfoFlightCoupon", Namespace="schemas.agentivity.com/types")
    public static class TicketInfoFlightCoupon
    {
        @DataMember(Order=10)
        public String TktNumber = null;

        @DataMember(Order=20)
        public Integer CouponSequenceNbr = null;

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

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

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

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

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

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

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

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

        @DataMember(Order=100)
        public Integer AirTktSegId = null;

        @DataMember(Order=110)
        public Boolean EligibleForRefund = null;

        @DataMember(Order=120)
        public Boolean EligibleForCovidStatus = null;

        @DataMember(Order=130)
        public String FareBasis = null;
        
        public String getTktNumber() { return TktNumber; }
        public TicketInfoFlightCoupon setTktNumber(String value) { this.TktNumber = value; return this; }
        public Integer getCouponSequenceNbr() { return CouponSequenceNbr; }
        public TicketInfoFlightCoupon setCouponSequenceNbr(Integer value) { this.CouponSequenceNbr = value; return this; }
        public String getCarrier() { return Carrier; }
        public TicketInfoFlightCoupon setCarrier(String value) { this.Carrier = value; return this; }
        public String getFlightNbr() { return FlightNbr; }
        public TicketInfoFlightCoupon setFlightNbr(String value) { this.FlightNbr = value; return this; }
        public String getBoardPoint() { return BoardPoint; }
        public TicketInfoFlightCoupon setBoardPoint(String value) { this.BoardPoint = value; return this; }
        public String getOffPoint() { return OffPoint; }
        public TicketInfoFlightCoupon setOffPoint(String value) { this.OffPoint = value; return this; }
        public String getFlightServiceClass() { return FlightServiceClass; }
        public TicketInfoFlightCoupon setFlightServiceClass(String value) { this.FlightServiceClass = value; return this; }
        public Date getFlightDate() { return FlightDate; }
        public TicketInfoFlightCoupon setFlightDate(Date value) { this.FlightDate = value; return this; }
        public String getFlightCouponStatus() { return FlightCouponStatus; }
        public TicketInfoFlightCoupon setFlightCouponStatus(String value) { this.FlightCouponStatus = value; return this; }
        public Date getDateLastChecked() { return DateLastChecked; }
        public TicketInfoFlightCoupon setDateLastChecked(Date value) { this.DateLastChecked = value; return this; }
        public Integer getAirTktSegId() { return AirTktSegId; }
        public TicketInfoFlightCoupon setAirTktSegId(Integer value) { this.AirTktSegId = value; return this; }
        public Boolean isEligibleForRefund() { return EligibleForRefund; }
        public TicketInfoFlightCoupon setEligibleForRefund(Boolean value) { this.EligibleForRefund = value; return this; }
        public Boolean isEligibleForCovidStatus() { return EligibleForCovidStatus; }
        public TicketInfoFlightCoupon setEligibleForCovidStatus(Boolean value) { this.EligibleForCovidStatus = value; return this; }
        public String getFareBasis() { return FareBasis; }
        public TicketInfoFlightCoupon setFareBasis(String value) { this.FareBasis = value; return this; }
    }

    @DataContract(Name="Exchange", Namespace="schemas.agentivity.com/types")
    public static class TicketExchange
    {
        @DataMember(Order=10)
        public String OriginalTktNumber = null;
        
        public String getOriginalTktNumber() { return OriginalTktNumber; }
        public TicketExchange setOriginalTktNumber(String value) { this.OriginalTktNumber = value; return this; }
    }

    @DataContract(Name="Tax", Namespace="schemas.agentivity.com/types")
    public static class TicketTaxDetails
    {
        @DataMember(Order=10)
        public BigDecimal TotalAmt = null;

        @DataMember(Order=20)
        public ArrayList<TicketTaxElement> TaxElements = null;
        
        public BigDecimal getTotalAmt() { return TotalAmt; }
        public TicketTaxDetails setTotalAmt(BigDecimal value) { this.TotalAmt = value; return this; }
        public ArrayList<TicketTaxElement> getTaxElements() { return TaxElements; }
        public TicketTaxDetails setTaxElements(ArrayList<TicketTaxElement> value) { this.TaxElements = value; return this; }
    }

    @DataContract(Name="TaxElement", Namespace="schemas.agentivity.com/types")
    public static class TicketTaxElement
    {
        @DataMember(Order=10)
        public BigDecimal Amt = null;

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

        @DataMember(Order=30)
        public String Code = null;
        
        public BigDecimal getAmt() { return Amt; }
        public TicketTaxElement setAmt(BigDecimal value) { this.Amt = value; return this; }
        public String getPrintedAmt() { return PrintedAmt; }
        public TicketTaxElement setPrintedAmt(String value) { this.PrintedAmt = value; return this; }
        public String getCode() { return Code; }
        public TicketTaxElement setCode(String value) { this.Code = value; return this; }
    }

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

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

GET /TicketDetails/User 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>
      <PassengerTicketID>0</PassengerTicketID>
      <TktNumber>String</TktNumber>
      <RecordLocator>String</RecordLocator>
      <PNRCreationDate>0001-01-01T00:00:00</PNRCreationDate>
      <TktIssueDate>0001-01-01T00:00:00</TktIssueDate>
      <PlatingCarrier>String</PlatingCarrier>
      <Status>String</Status>
      <BAR>String</BAR>
      <PAR>String</PAR>
      <LastName>String</LastName>
      <FirstName>String</FirstName>
      <TicketExpiryDate>0001-01-01T00:00:00</TicketExpiryDate>
      <FOP>String</FOP>
      <FopFare>String</FopFare>
      <FOPCurrency>String</FOPCurrency>
      <PrintedCurrency>String</PrintedCurrency>
      <PrintedFare>String</PrintedFare>
      <CreditCardFOPAcct>String</CreditCardFOPAcct>
      <OwningAgencyLocationID>String</OwningAgencyLocationID>
      <IATA>String</IATA>
      <Coupons>
        <TicketInfoFlightCoupon>
          <TktNumber>String</TktNumber>
          <Carrier>String</Carrier>
          <CouponSequenceNbr>0</CouponSequenceNbr>
          <FlightNbr>String</FlightNbr>
          <BoardPoint>String</BoardPoint>
          <OffPoint>String</OffPoint>
          <FlightServiceClass>String</FlightServiceClass>
          <FlightDate>0001-01-01T00:00:00</FlightDate>
          <FlightCouponStatus>String</FlightCouponStatus>
          <DateLastChecked>0001-01-01T00:00:00</DateLastChecked>
          <AirTktSegId>0</AirTktSegId>
          <EligibleForRefund>false</EligibleForRefund>
          <EligibleForCovidStatus>false</EligibleForCovidStatus>
          <FareBasis>String</FareBasis>
        </TicketInfoFlightCoupon>
      </Coupons>
      <EligibleForRefund>false</EligibleForRefund>
      <EligibleForCovidStatus>false</EligibleForCovidStatus>
      <TicketExchanges>
        <Exchange>
          <OriginalTktNumber>String</OriginalTktNumber>
        </Exchange>
      </TicketExchanges>
      <Tax>
        <TotalAmt>0</TotalAmt>
        <TaxElements>
          <TaxElement>
            <Amt>0</Amt>
            <PrintedAmt>String</PrintedAmt>
            <Code>String</Code>
          </TaxElement>
        </TaxElements>
      </Tax>
      <OwningCompanyCode>String</OwningCompanyCode>
    </Item>
  </ResponseReport>
  <ResponseError>
    <ErrorCode>String</ErrorCode>
    <Message>String</Message>
    <StatusCode>String</StatusCode>
    <VerboseMessage>String</VerboseMessage>
  </ResponseError>
</AgentivityResponse>