Agentivity API

<back to all web services

GetTravellersByCrm

The following routes are available for this service:
All Verbs/TravellersByCRM
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 GetTravellersByCrm extends CompanyLevelRequestBase
    {
        @DataMember
        public Integer CrmCode = null;

        @DataMember
        public String CrmTravellerId = null;
        
        public Integer getCrmCode() { return CrmCode; }
        public GetTravellersByCrm setCrmCode(Integer value) { this.CrmCode = value; return this; }
        public String getCrmTravellerId() { return CrmTravellerId; }
        public GetTravellersByCrm setCrmTravellerId(String value) { this.CrmTravellerId = 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 TravellersByCrmResponse extends CollectionResponse<TravellerByNameNested>
    {
        
    }

    @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; }
    }

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

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

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

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

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

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

        @DataMember(Order=70)
        public ArrayList<Aliases> Aliases = null;

        @DataMember(Order=80)
        public ArrayList<Accounts> Accounts = null;

        @DataMember(Order=90)
        public ArrayList<BARS> BARS = null;

        @DataMember(Order=100)
        public ArrayList<MARS> MARS = null;

        @DataMember(Order=110)
        public ArrayList<PARS> PARS = null;

        @DataMember(Order=120)
        public PNRStats PNRStats = null;
        
        public String getTravellerGUID() { return TravellerGUID; }
        public TravellerByNameNested setTravellerGUID(String value) { this.TravellerGUID = value; return this; }
        public String getFirstName() { return FirstName; }
        public TravellerByNameNested setFirstName(String value) { this.FirstName = value; return this; }
        public String getLastName() { return LastName; }
        public TravellerByNameNested setLastName(String value) { this.LastName = value; return this; }
        public String getBar() { return BAR; }
        public TravellerByNameNested setBar(String value) { this.BAR = value; return this; }
        public String getMar() { return MAR; }
        public TravellerByNameNested setMar(String value) { this.MAR = value; return this; }
        public String getPar() { return PAR; }
        public TravellerByNameNested setPar(String value) { this.PAR = value; return this; }
        public ArrayList<Aliases> getAliases() { return Aliases; }
        public TravellerByNameNested setAliases(ArrayList<Aliases> value) { this.Aliases = value; return this; }
        public ArrayList<Accounts> getAccounts() { return Accounts; }
        public TravellerByNameNested setAccounts(ArrayList<Accounts> value) { this.Accounts = value; return this; }
        public ArrayList<BARS> getBars() { return BARS; }
        public TravellerByNameNested setBars(ArrayList<BARS> value) { this.BARS = value; return this; }
        public ArrayList<MARS> getMars() { return MARS; }
        public TravellerByNameNested setMars(ArrayList<MARS> value) { this.MARS = value; return this; }
        public ArrayList<PARS> getPars() { return PARS; }
        public TravellerByNameNested setPars(ArrayList<PARS> value) { this.PARS = value; return this; }
        public PNRStats getPnrStats() { return PNRStats; }
        public TravellerByNameNested setPnrStats(PNRStats value) { this.PNRStats = value; return this; }
    }

    @DataContract(Name="AliasesItem", Namespace="schemas.agentivity.com/types")
    public static class Aliases
    {
        @DataMember
        public String FirstName = null;

        @DataMember
        public String LastName = null;
        
        public String getFirstName() { return FirstName; }
        public Aliases setFirstName(String value) { this.FirstName = value; return this; }
        public String getLastName() { return LastName; }
        public Aliases setLastName(String value) { this.LastName = value; return this; }
    }

    @DataContract(Name="Account", Namespace="schemas.agentivity.com/types")
    public static class Accounts
    {
        @DataMember
        public String AccountID = null;

        @DataMember
        public String AccountName = null;

        @DataMember
        public PNRStats PNRStats = null;
        
        public String getAccountID() { return AccountID; }
        public Accounts setAccountID(String value) { this.AccountID = value; return this; }
        public String getAccountName() { return AccountName; }
        public Accounts setAccountName(String value) { this.AccountName = value; return this; }
        public PNRStats getPnrStats() { return PNRStats; }
        public Accounts setPnrStats(PNRStats value) { this.PNRStats = value; return this; }
    }

    @DataContract(Name="PNRStatsItem", Namespace="schemas.agentivity.com/types")
    public static class PNRStats
    {
        @DataMember
        public Integer PNRsCreatedPreviousThreeYears = null;
        
        public Integer getPnRsCreatedPreviousThreeYears() { return PNRsCreatedPreviousThreeYears; }
        public PNRStats setPnRsCreatedPreviousThreeYears(Integer value) { this.PNRsCreatedPreviousThreeYears = value; return this; }
    }

    @DataContract(Name="BARItem", Namespace="schemas.agentivity.com/types")
    public static class BARS
    {
        @DataMember
        public String BAR = null;
        
        public String getBar() { return BAR; }
        public BARS setBar(String value) { this.BAR = value; return this; }
    }

    @DataContract(Name="MARItem", Namespace="schemas.agentivity.com/types")
    public static class MARS
    {
        @DataMember
        public String MAR = null;
        
        public String getMar() { return MAR; }
        public MARS setMar(String value) { this.MAR = value; return this; }
    }

    @DataContract(Name="PARitem", Namespace="schemas.agentivity.com/types")
    public static class PARS
    {
        @DataMember
        public String PAR = null;
        
        public String getPar() { return PAR; }
        public PARS setPar(String value) { this.PAR = value; return this; }
    }

}

Java GetTravellersByCrm DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

POST /TravellersByCRM HTTP/1.1 
Host: api.agentivity.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"CrmCode":0,"CrmTravellerId":"String","OwningCompanyCode":["String"],"UserName":"String","Offset":"String","Limit":"String","TotalRecords":0,"ResponseRecords":0}
HTTP/1.1 200 OK
Content-Type: application/json
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":[{"TravellerGUID":"String","FirstName":"String","LastName":"String","BAR":"String","MAR":"String","PAR":"String","Aliases":[{"FirstName":"String","LastName":"String"}],"Accounts":[{"AccountID":"String","AccountName":"String","PNRStats":{"PNRsCreatedPreviousThreeYears":0}}],"BARS":[{"BAR":"String"}],"MARS":[{"MAR":"String"}],"PARS":[{"PAR":"String"}],"PNRStats":{"PNRsCreatedPreviousThreeYears":0}}],"ResponseError":{"ErrorCode":"String","Message":"String","StatusCode":"String","VerboseMessage":"String"}}