Agentivity API

<back to all web services

GetBookingsCreatedAndSegments

The following routes are available for this service:
All Verbs/BookingsCreatedAndSegments
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 GetBookingsCreatedAndSegments extends CompanyLevelRequestBase
    {
        /**
        * Comma Delimited List of PCCs
        */
        @DataMember
        public ArrayList<String> OwningAgencyLocationID = null;

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

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

        /**
        * When set to true, filters the results to only include air segments where the associated PNR has been ticketed. Other segments types are unaffected by this filter
        */
        @DataMember
        public Boolean AirSegmentsMustBeTicketed = null;
        
        public ArrayList<String> getOwningAgencyLocationID() { return OwningAgencyLocationID; }
        public GetBookingsCreatedAndSegments setOwningAgencyLocationID(ArrayList<String> value) { this.OwningAgencyLocationID = value; return this; }
        public String getPnrCreationDateStart() { return PNRCreationDateStart; }
        public GetBookingsCreatedAndSegments setPnrCreationDateStart(String value) { this.PNRCreationDateStart = value; return this; }
        public String getPnrCreationDateEnd() { return PNRCreationDateEnd; }
        public GetBookingsCreatedAndSegments setPnrCreationDateEnd(String value) { this.PNRCreationDateEnd = value; return this; }
        public Boolean isAirSegmentsMustBeTicketed() { return AirSegmentsMustBeTicketed; }
        public GetBookingsCreatedAndSegments setAirSegmentsMustBeTicketed(Boolean value) { this.AirSegmentsMustBeTicketed = 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; }
    }

}

Java GetBookingsCreatedAndSegments DTOs

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

HTTP + XML

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

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

<GetBookingsCreatedAndSegments 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>
  <AirSegmentsMustBeTicketed>false</AirSegmentsMustBeTicketed>
  <OwningAgencyLocationID xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </OwningAgencyLocationID>
  <PNRCreationDateEnd>String</PNRCreationDateEnd>
  <PNRCreationDateStart>String</PNRCreationDateStart>
</GetBookingsCreatedAndSegments>