Agentivity API

<back to all web services

GetBookingEventsDetails

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 GetBookingEventsDetails extends CompanyLevelRequestBase
    {
        /**
        * Date in format YYYYMMDD
        */
        @DataMember
        public String EventDateStart = null;

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

        /**
        * Comma Delimited List of Event Types
        */
        @DataMember
        public ArrayList<String> EventType = null;

        /**
        * Comma Delimited List of PCCs
        */
        @DataMember
        public ArrayList<String> OwningAgencyLocationID = null;
        
        public String getEventDateStart() { return EventDateStart; }
        public GetBookingEventsDetails setEventDateStart(String value) { this.EventDateStart = value; return this; }
        public String getEventDateEnd() { return EventDateEnd; }
        public GetBookingEventsDetails setEventDateEnd(String value) { this.EventDateEnd = value; return this; }
        public ArrayList<String> getEventType() { return EventType; }
        public GetBookingEventsDetails setEventType(ArrayList<String> value) { this.EventType = value; return this; }
        public ArrayList<String> getOwningAgencyLocationID() { return OwningAgencyLocationID; }
        public GetBookingEventsDetails setOwningAgencyLocationID(ArrayList<String> value) { this.OwningAgencyLocationID = 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 GetBookingEventsDetailsResponse extends CollectionResponse<BookingEventsDetail>
    {
        
    }

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

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

        @DataMember(Order=110)
        public Integer Hour1 = null;

        @DataMember(Order=120)
        public Integer Hour2 = null;

        @DataMember(Order=130)
        public Integer Hour3 = null;

        @DataMember(Order=140)
        public Integer Hour4 = null;

        @DataMember(Order=150)
        public Integer Hour5 = null;

        @DataMember(Order=160)
        public Integer Hour6 = null;

        @DataMember(Order=170)
        public Integer Hour7 = null;

        @DataMember(Order=180)
        public Integer Hour8 = null;

        @DataMember(Order=190)
        public Integer Hour9 = null;

        @DataMember(Order=200)
        public Integer Hour10 = null;

        @DataMember(Order=210)
        public Integer Hour11 = null;

        @DataMember(Order=220)
        public Integer Hour12 = null;

        @DataMember(Order=230)
        public Integer Hour13 = null;

        @DataMember(Order=240)
        public Integer Hour14 = null;

        @DataMember(Order=250)
        public Integer Hour15 = null;

        @DataMember(Order=260)
        public Integer Hour16 = null;

        @DataMember(Order=270)
        public Integer Hour17 = null;

        @DataMember(Order=280)
        public Integer Hour18 = null;

        @DataMember(Order=290)
        public Integer Hour19 = null;

        @DataMember(Order=300)
        public Integer Hour20 = null;

        @DataMember(Order=310)
        public Integer Hour21 = null;

        @DataMember(Order=320)
        public Integer Hour22 = null;

        @DataMember(Order=330)
        public Integer Hour23 = null;
        
        public Date getRequestDate() { return RequestDate; }
        public ApiRequestPerHour setRequestDate(Date value) { this.RequestDate = value; return this; }
        public Integer getHour0() { return Hour0; }
        public ApiRequestPerHour setHour0(Integer value) { this.Hour0 = value; return this; }
        public Integer getHour1() { return Hour1; }
        public ApiRequestPerHour setHour1(Integer value) { this.Hour1 = value; return this; }
        public Integer getHour2() { return Hour2; }
        public ApiRequestPerHour setHour2(Integer value) { this.Hour2 = value; return this; }
        public Integer getHour3() { return Hour3; }
        public ApiRequestPerHour setHour3(Integer value) { this.Hour3 = value; return this; }
        public Integer getHour4() { return Hour4; }
        public ApiRequestPerHour setHour4(Integer value) { this.Hour4 = value; return this; }
        public Integer getHour5() { return Hour5; }
        public ApiRequestPerHour setHour5(Integer value) { this.Hour5 = value; return this; }
        public Integer getHour6() { return Hour6; }
        public ApiRequestPerHour setHour6(Integer value) { this.Hour6 = value; return this; }
        public Integer getHour7() { return Hour7; }
        public ApiRequestPerHour setHour7(Integer value) { this.Hour7 = value; return this; }
        public Integer getHour8() { return Hour8; }
        public ApiRequestPerHour setHour8(Integer value) { this.Hour8 = value; return this; }
        public Integer getHour9() { return Hour9; }
        public ApiRequestPerHour setHour9(Integer value) { this.Hour9 = value; return this; }
        public Integer getHour10() { return Hour10; }
        public ApiRequestPerHour setHour10(Integer value) { this.Hour10 = value; return this; }
        public Integer getHour11() { return Hour11; }
        public ApiRequestPerHour setHour11(Integer value) { this.Hour11 = value; return this; }
        public Integer getHour12() { return Hour12; }
        public ApiRequestPerHour setHour12(Integer value) { this.Hour12 = value; return this; }
        public Integer getHour13() { return Hour13; }
        public ApiRequestPerHour setHour13(Integer value) { this.Hour13 = value; return this; }
        public Integer getHour14() { return Hour14; }
        public ApiRequestPerHour setHour14(Integer value) { this.Hour14 = value; return this; }
        public Integer getHour15() { return Hour15; }
        public ApiRequestPerHour setHour15(Integer value) { this.Hour15 = value; return this; }
        public Integer getHour16() { return Hour16; }
        public ApiRequestPerHour setHour16(Integer value) { this.Hour16 = value; return this; }
        public Integer getHour17() { return Hour17; }
        public ApiRequestPerHour setHour17(Integer value) { this.Hour17 = value; return this; }
        public Integer getHour18() { return Hour18; }
        public ApiRequestPerHour setHour18(Integer value) { this.Hour18 = value; return this; }
        public Integer getHour19() { return Hour19; }
        public ApiRequestPerHour setHour19(Integer value) { this.Hour19 = value; return this; }
        public Integer getHour20() { return Hour20; }
        public ApiRequestPerHour setHour20(Integer value) { this.Hour20 = value; return this; }
        public Integer getHour21() { return Hour21; }
        public ApiRequestPerHour setHour21(Integer value) { this.Hour21 = value; return this; }
        public Integer getHour22() { return Hour22; }
        public ApiRequestPerHour setHour22(Integer value) { this.Hour22 = value; return this; }
        public Integer getHour23() { return Hour23; }
        public ApiRequestPerHour setHour23(Integer value) { this.Hour23 = 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="BookingEvents", Namespace="schemas.agentivity.com/types")
    public static class BookingEventsDetail implements IBookingIdentifier, IBookingExtItinerary, ITicketNumbers
    {
        @DataMember(Order=10)
        public String RecordLocator = null;

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

        @DataMember(Order=30)
        public ArrayList<EventTypeItem> Events = null;

        @DataMember(Order=40)
        public Integer AgentivityRef = null;

        @DataMember(Order=50)
        public ArrayList<BookingExtItinerarySegment> Itinerary = null;

        @DataMember(Order=60)
        public ArrayList<String> TicketNumbers = null;
        
        public String getRecordLocator() { return RecordLocator; }
        public BookingEventsDetail setRecordLocator(String value) { this.RecordLocator = value; return this; }
        public Date getPnrCreationDate() { return PNRCreationDate; }
        public BookingEventsDetail setPnrCreationDate(Date value) { this.PNRCreationDate = value; return this; }
        public ArrayList<EventTypeItem> getEvents() { return Events; }
        public BookingEventsDetail setEvents(ArrayList<EventTypeItem> value) { this.Events = value; return this; }
        public Integer getAgentivityRef() { return AgentivityRef; }
        public BookingEventsDetail setAgentivityRef(Integer value) { this.AgentivityRef = value; return this; }
        public ArrayList<BookingExtItinerarySegment> getItinerary() { return Itinerary; }
        public BookingEventsDetail setItinerary(ArrayList<BookingExtItinerarySegment> value) { this.Itinerary = value; return this; }
        public ArrayList<String> getTicketNumbers() { return TicketNumbers; }
        public BookingEventsDetail setTicketNumbers(ArrayList<String> value) { this.TicketNumbers = value; return this; }
    }

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

        @DataMember(Order=20)
        public Date EventDateTime = null;
        
        public String getEventType() { return EventType; }
        public EventTypeItem setEventType(String value) { this.EventType = value; return this; }
        public Date getEventDateTime() { return EventDateTime; }
        public EventTypeItem setEventDateTime(Date value) { this.EventDateTime = value; return this; }
    }

    @DataContract(Name="ItinerarySegment", Namespace="schemas.agentivity.com/types")
    public static class BookingExtItinerarySegment extends ItinerarySegment
    {
        @DataMember
        public String OperatorCodeName = null;

        @DataMember
        public String ServiceCodeName = null;
        
        public String getOperatorCodeName() { return OperatorCodeName; }
        public BookingExtItinerarySegment setOperatorCodeName(String value) { this.OperatorCodeName = value; return this; }
        public String getServiceCodeName() { return ServiceCodeName; }
        public BookingExtItinerarySegment setServiceCodeName(String value) { this.ServiceCodeName = value; return this; }
    }

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

        @DataMember
        public Integer SegmentNbr = null;

        @DataMember
        public String BoardPoint = null;

        @DataMember
        public String OffPoint = null;

        @DataMember
        public String OperatorCode = null;

        @DataMember
        public String OperatorService = null;

        @DataMember
        public String SegmentStatus = null;

        @DataMember
        public String DepartureTimeFormatted = null;

        @DataMember
        public String ArrivalTimeFormatted = null;

        @DataMember
        public String ChangeOfDayFormatted = null;

        @DataMember
        public String ServiceCode = null;

        @DataMember
        public String StartDate = null;

        @DataMember
        public String EndDate = null;

        @DataMember
        public String TicketNumber = null;

        /**
        * Comma separated list of vendor locators
        */
        @DataMember
        public String VendorLocators = null;

        @DataMember
        public String EquipmentCode = null;

        @DataMember
        public String Equipment = null;
        
        public String getSegmentType() { return SegmentType; }
        public ItinerarySegment setSegmentType(String value) { this.SegmentType = value; return this; }
        public Integer getSegmentNbr() { return SegmentNbr; }
        public ItinerarySegment setSegmentNbr(Integer value) { this.SegmentNbr = value; return this; }
        public String getBoardPoint() { return BoardPoint; }
        public ItinerarySegment setBoardPoint(String value) { this.BoardPoint = value; return this; }
        public String getOffPoint() { return OffPoint; }
        public ItinerarySegment setOffPoint(String value) { this.OffPoint = value; return this; }
        public String getOperatorCode() { return OperatorCode; }
        public ItinerarySegment setOperatorCode(String value) { this.OperatorCode = value; return this; }
        public String getOperatorService() { return OperatorService; }
        public ItinerarySegment setOperatorService(String value) { this.OperatorService = value; return this; }
        public String getSegmentStatus() { return SegmentStatus; }
        public ItinerarySegment setSegmentStatus(String value) { this.SegmentStatus = value; return this; }
        public String getDepartureTimeFormatted() { return DepartureTimeFormatted; }
        public ItinerarySegment setDepartureTimeFormatted(String value) { this.DepartureTimeFormatted = value; return this; }
        public String getArrivalTimeFormatted() { return ArrivalTimeFormatted; }
        public ItinerarySegment setArrivalTimeFormatted(String value) { this.ArrivalTimeFormatted = value; return this; }
        public String getChangeOfDayFormatted() { return ChangeOfDayFormatted; }
        public ItinerarySegment setChangeOfDayFormatted(String value) { this.ChangeOfDayFormatted = value; return this; }
        public String getServiceCode() { return ServiceCode; }
        public ItinerarySegment setServiceCode(String value) { this.ServiceCode = value; return this; }
        public String getStartDate() { return StartDate; }
        public ItinerarySegment setStartDate(String value) { this.StartDate = value; return this; }
        public String getEndDate() { return EndDate; }
        public ItinerarySegment setEndDate(String value) { this.EndDate = value; return this; }
        public String getTicketNumber() { return TicketNumber; }
        public ItinerarySegment setTicketNumber(String value) { this.TicketNumber = value; return this; }
        public String getVendorLocators() { return VendorLocators; }
        public ItinerarySegment setVendorLocators(String value) { this.VendorLocators = value; return this; }
        public String getEquipmentCode() { return EquipmentCode; }
        public ItinerarySegment setEquipmentCode(String value) { this.EquipmentCode = value; return this; }
        public String getEquipment() { return Equipment; }
        public ItinerarySegment setEquipment(String value) { this.Equipment = value; return this; }
    }

}

Java GetBookingEventsDetails DTOs

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

<GetBookingEventsDetails xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="schemas.agentivity.com/types">
  <Limit>String</Limit>
  <Offset>String</Offset>
  <ResponseRecords>0</ResponseRecords>
  <TotalRecords>0</TotalRecords>
  <OwningCompanyCode xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </OwningCompanyCode>
  <UserName>String</UserName>
  <EventDateEnd>String</EventDateEnd>
  <EventDateStart>String</EventDateStart>
  <EventType xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </EventType>
  <OwningAgencyLocationID xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </OwningAgencyLocationID>
</GetBookingEventsDetails>

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>
    <BookingEvents>
      <RecordLocator>String</RecordLocator>
      <PNRCreationDate>0001-01-01T00:00:00</PNRCreationDate>
      <Events>
        <Event>
          <EventType>String</EventType>
          <EventDateTime>0001-01-01T00:00:00</EventDateTime>
        </Event>
      </Events>
      <AgentivityRef>0</AgentivityRef>
      <Itinerary>
        <ItinerarySegment>
          <ArrivalTimeFormatted>String</ArrivalTimeFormatted>
          <BoardPoint>String</BoardPoint>
          <ChangeOfDayFormatted>String</ChangeOfDayFormatted>
          <DepartureTimeFormatted>String</DepartureTimeFormatted>
          <EndDate>String</EndDate>
          <Equipment>String</Equipment>
          <EquipmentCode>String</EquipmentCode>
          <OffPoint>String</OffPoint>
          <OperatorCode>String</OperatorCode>
          <OperatorService>String</OperatorService>
          <SegmentNbr>0</SegmentNbr>
          <SegmentStatus>String</SegmentStatus>
          <SegmentType>String</SegmentType>
          <ServiceCode>String</ServiceCode>
          <StartDate>String</StartDate>
          <TicketNumber>String</TicketNumber>
          <VendorLocators>String</VendorLocators>
          <OperatorCodeName>String</OperatorCodeName>
          <ServiceCodeName>String</ServiceCodeName>
        </ItinerarySegment>
      </Itinerary>
      <TicketNumbers xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>String</d4p1:string>
      </TicketNumbers>
    </BookingEvents>
  </ResponseReport>
  <ResponseError>
    <ErrorCode>String</ErrorCode>
    <Message>String</Message>
    <StatusCode>String</StatusCode>
    <VerboseMessage>String</VerboseMessage>
  </ResponseError>
</AgentivityResponse>