Agentivity API

<back to all web services

GetItineraryChangeEvents

The following routes are available for this service:
GET/ItineraryChangeEvents
import 'package:servicestack/servicestack.dart';

// @DataContract(Name="Metadata", Namespace="schemas.agentivity.com/types")
class PagingMetadata implements IConvertible
{
    /**
    * Starting Record
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="Starting Record", Name="Offset", ParameterType="query")
    String? Offset;

    /**
    * Number of records to return (PageSize)
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="Number of records to return (PageSize)", Name="Limit", ParameterType="query")
    String? Limit;

    /**
    * 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")
    int? TotalRecords;

    /**
    * 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")
    int? ResponseRecords;

    PagingMetadata({this.Offset,this.Limit,this.TotalRecords,this.ResponseRecords});
    PagingMetadata.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Offset = json['Offset'];
        Limit = json['Limit'];
        TotalRecords = json['TotalRecords'];
        ResponseRecords = json['ResponseRecords'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'Offset': Offset,
        'Limit': Limit,
        'TotalRecords': TotalRecords,
        'ResponseRecords': ResponseRecords
    };

    getTypeName() => "PagingMetadata";
    TypeContext? context = _ctx;
}

// @DataContract(Name="ItineraryChangeEvent", Namespace="schemas.agentivity.com/types")
class ItineraryChangeEvent implements IConvertible
{
    // @DataMember(Order=10)
    String? AgentivityRef;

    // @DataMember(Order=20)
    String? RecordLocator;

    // @DataMember(Order=30)
    String? LastActionConsultant;

    // @DataMember(Order=40)
    String? Passengers;

    // @DataMember(Order=50)
    DateTime? EventDateTime;

    // @DataMember(Order=55)
    String? EventDateTimeFormatted;

    // @DataMember(Order=60)
    String? EventTypeDetail;

    // @DataMember(Order=65)
    String? EventTypeGroup;

    // @DataMember(Order=70)
    String? OldData;

    // @DataMember(Order=80)
    String? NewData;

    // @DataMember(Order=90)
    String? PNRTicketed;

    // @DataMember(Order=100)
    String? FirstDILine;

    // @DataMember(Order=110)
    String? Account;

    // @DataMember(Order=120)
    String? PurchaseOrder;

    // @DataMember(Order=130)
    String? DivisionCode;

    // @DataMember(Order=140)
    String? BusinessUnit;

    // @DataMember(Order=150)
    String? AccountCode;

    ItineraryChangeEvent({this.AgentivityRef,this.RecordLocator,this.LastActionConsultant,this.Passengers,this.EventDateTime,this.EventDateTimeFormatted,this.EventTypeDetail,this.EventTypeGroup,this.OldData,this.NewData,this.PNRTicketed,this.FirstDILine,this.Account,this.PurchaseOrder,this.DivisionCode,this.BusinessUnit,this.AccountCode});
    ItineraryChangeEvent.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        AgentivityRef = json['AgentivityRef'];
        RecordLocator = json['RecordLocator'];
        LastActionConsultant = json['LastActionConsultant'];
        Passengers = json['Passengers'];
        EventDateTime = JsonConverters.fromJson(json['EventDateTime'],'DateTime',context!);
        EventDateTimeFormatted = json['EventDateTimeFormatted'];
        EventTypeDetail = json['EventTypeDetail'];
        EventTypeGroup = json['EventTypeGroup'];
        OldData = json['OldData'];
        NewData = json['NewData'];
        PNRTicketed = json['PNRTicketed'];
        FirstDILine = json['FirstDILine'];
        Account = json['Account'];
        PurchaseOrder = json['PurchaseOrder'];
        DivisionCode = json['DivisionCode'];
        BusinessUnit = json['BusinessUnit'];
        AccountCode = json['AccountCode'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'AgentivityRef': AgentivityRef,
        'RecordLocator': RecordLocator,
        'LastActionConsultant': LastActionConsultant,
        'Passengers': Passengers,
        'EventDateTime': JsonConverters.toJson(EventDateTime,'DateTime',context!),
        'EventDateTimeFormatted': EventDateTimeFormatted,
        'EventTypeDetail': EventTypeDetail,
        'EventTypeGroup': EventTypeGroup,
        'OldData': OldData,
        'NewData': NewData,
        'PNRTicketed': PNRTicketed,
        'FirstDILine': FirstDILine,
        'Account': Account,
        'PurchaseOrder': PurchaseOrder,
        'DivisionCode': DivisionCode,
        'BusinessUnit': BusinessUnit,
        'AccountCode': AccountCode
    };

    getTypeName() => "ItineraryChangeEvent";
    TypeContext? context = _ctx;
}

// @DataContract(Namespace="schemas.agentivity.com/types")
class Report<TItemResponse,TItem> implements IConvertible
{
    // @DataMember(Order=1, EmitDefaultValue=false)
    TItem? Item;

    Report({this.Item});
    Report.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Item = JsonConverters.fromJson(json['Item'],'TItem',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'Item': JsonConverters.toJson(Item,'TItem',context!)
    };

    getTypeName() => "Report<$TItemResponse,$TItem>";
    TypeContext? context = _ctx;
}

// @DataContract(Name="ItineraryChangeEvent", Namespace="schemas.agentivity.com/types")
class ItineraryChangeEventsResponseReport extends Report<ItineraryChangeEventsItemResponse,ItineraryChangeEvent> implements IConvertible
{
    ItineraryChangeEventsResponseReport();
    ItineraryChangeEventsResponseReport.fromJson(Map<String, dynamic> json) : super.fromJson(json);
    fromMap(Map<String, dynamic> json) {
        super.fromMap(json);
        return this;
    }

    Map<String, dynamic> toJson() => super.toJson();
    getTypeName() => "ItineraryChangeEventsResponseReport";
    TypeContext? context = _ctx;
}

// @DataContract(Name="CacheMetadata", Namespace="schemas.agentivity.com/types")
class CacheMetadata implements IConvertible
{
    // @DataMember(Order=1)
    DateTime? CachedAt;

    // @DataMember(Order=2)
    DateTime? CacheExpiresAt;

    // @DataMember(Order=0)
    bool? IsFromCache;

    CacheMetadata({this.CachedAt,this.CacheExpiresAt,this.IsFromCache});
    CacheMetadata.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        CachedAt = JsonConverters.fromJson(json['CachedAt'],'DateTime',context!);
        CacheExpiresAt = JsonConverters.fromJson(json['CacheExpiresAt'],'DateTime',context!);
        IsFromCache = json['IsFromCache'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'CachedAt': JsonConverters.toJson(CachedAt,'DateTime',context!),
        'CacheExpiresAt': JsonConverters.toJson(CacheExpiresAt,'DateTime',context!),
        'IsFromCache': IsFromCache
    };

    getTypeName() => "CacheMetadata";
    TypeContext? context = _ctx;
}

// @DataContract(Name="ResponseMetadata", Namespace="schemas.agentivity.com/types")
class ResponseMetadata implements IConvertible
{
    // @DataMember(Order=0)
    bool? Success;

    // @DataMember(Order=1)
    bool? HasCache;

    // @DataMember(Order=2)
    bool? HasPaging;

    // @DataMember(Order=3, EmitDefaultValue=false)
    CacheMetadata? CacheMetadata;

    // @DataMember(Order=4, EmitDefaultValue=false)
    PagingMetadata? PagingMetadata;

    ResponseMetadata({this.Success,this.HasCache,this.HasPaging,this.CacheMetadata,this.PagingMetadata});
    ResponseMetadata.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Success = json['Success'];
        HasCache = json['HasCache'];
        HasPaging = json['HasPaging'];
        CacheMetadata = JsonConverters.fromJson(json['CacheMetadata'],'CacheMetadata',context!);
        PagingMetadata = JsonConverters.fromJson(json['PagingMetadata'],'PagingMetadata',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'Success': Success,
        'HasCache': HasCache,
        'HasPaging': HasPaging,
        'CacheMetadata': JsonConverters.toJson(CacheMetadata,'CacheMetadata',context!),
        'PagingMetadata': JsonConverters.toJson(PagingMetadata,'PagingMetadata',context!)
    };

    getTypeName() => "ResponseMetadata";
    TypeContext? context = _ctx;
}

// @DataContract(Name="ResponseMetadata", Namespace="schemas.agentivity.com/types")
class AgentivityError implements IConvertible
{
    // @DataMember
    String? ErrorCode;

    // @DataMember
    String? Message;

    // @DataMember
    String? StatusCode;

    // @DataMember
    String? VerboseMessage;

    AgentivityError({this.ErrorCode,this.Message,this.StatusCode,this.VerboseMessage});
    AgentivityError.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        ErrorCode = json['ErrorCode'];
        Message = json['Message'];
        StatusCode = json['StatusCode'];
        VerboseMessage = json['VerboseMessage'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'ErrorCode': ErrorCode,
        'Message': Message,
        'StatusCode': StatusCode,
        'VerboseMessage': VerboseMessage
    };

    getTypeName() => "AgentivityError";
    TypeContext? context = _ctx;
}

// @DataContract(Name="AgentivityResponse", Namespace="schemas.agentivity.com/types")
class ItemResponse<TItem,TReport> implements IConvertible
{
    // @DataMember(Order=1)
    ResponseMetadata? ResponseMetadata;

    // @DataMember(Order=2, EmitDefaultValue=false)
    TReport? ResponseReport;

    // @DataMember(Order=3, EmitDefaultValue=false)
    AgentivityError? ResponseError;

    ItemResponse({this.ResponseMetadata,this.ResponseReport,this.ResponseError});
    ItemResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        ResponseMetadata = JsonConverters.fromJson(json['ResponseMetadata'],'ResponseMetadata',context!);
        ResponseReport = JsonConverters.fromJson(json['ResponseReport'],'TReport',context!);
        ResponseError = JsonConverters.fromJson(json['ResponseError'],'AgentivityError',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'ResponseMetadata': JsonConverters.toJson(ResponseMetadata,'ResponseMetadata',context!),
        'ResponseReport': JsonConverters.toJson(ResponseReport,'TReport',context!),
        'ResponseError': JsonConverters.toJson(ResponseError,'AgentivityError',context!)
    };

    getTypeName() => "ItemResponse<$TItem,$TReport>";
    TypeContext? context = _ctx;
}

// @DataContract(Name="AgentivityResponse", Namespace="schemas.agentivity.com/types")
class ItineraryChangeEventsItemResponse extends ItemResponse<ItineraryChangeEvent,ItineraryChangeEventsResponseReport> implements IConvertible
{
    ItineraryChangeEventsItemResponse();
    ItineraryChangeEventsItemResponse.fromJson(Map<String, dynamic> json) : super.fromJson(json);
    fromMap(Map<String, dynamic> json) {
        super.fromMap(json);
        return this;
    }

    Map<String, dynamic> toJson() => super.toJson();
    getTypeName() => "ItineraryChangeEventsItemResponse";
    TypeContext? context = _ctx;
}

// @DataContract(Namespace="schemas.agentivity.com/types")
class GetItineraryChangeEvents extends PagingMetadata implements IConvertible
{
    /**
    * Comma Delimited List of Accounts
    */
    // @DataMember
    List<String>? Account;

    /**
    * UserName in form of an email address
    */
    // @DataMember
    String? UserName;

    /**
    * Date in format YYYYMMDD
    */
    // @DataMember
    String? ChangeDateStart;

    /**
    * Date in format YYYYMMDD
    */
    // @DataMember
    String? ChangeDateEnd;

    /**
    * Return only PNRs that are ticketed/all
    */
    // @DataMember
    String? PNRTicketed;

    /**
    * Add document information line 
    */
    // @DataMember
    bool? AddDILine;

    /**
    * Comma Delimited List of Event Type Details. Valid values are: AirBkgCodeChanged, AirRouteChanged, AirStatusChanged, AirSupplierChanged, AirTimingsChanged, CarDatesTimingsChanged, CarLocationChanged, CarStatusChanged, CarSupplierChanged, CarTypeCodeChanged, FewerAirSegs, FewerCar_PSegs, FewerCarSegs, FewerHtl_PSegs, FewerHtlSegs, FewerTrn_PSegs, FlightNbrChanged, Htl_PChainChanged, Htl_PDatesChanged, Htl_PLocationChanged, Htl_PTextChanged, HtlChainChanged, HtlDatesChanged, HtlLocationChanged, HtlPropertyChanged, HtlRateCodeChanged, HtlRoomCodeChanged, HtlStatusChanged, MoreAirSegs, MoreCar_PSegs, MoreCarSegs, MoreHtl_PSegs, MoreHtlSegs, MoreTrn_PSegs, TrainDatesChanged
    */
    // @DataMember
    List<String>? EventTypeDetail;

    GetItineraryChangeEvents({this.Account,this.UserName,this.ChangeDateStart,this.ChangeDateEnd,this.PNRTicketed,this.AddDILine,this.EventTypeDetail});
    GetItineraryChangeEvents.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        super.fromMap(json);
        Account = JsonConverters.fromJson(json['Account'],'List<String>',context!);
        UserName = json['UserName'];
        ChangeDateStart = json['ChangeDateStart'];
        ChangeDateEnd = json['ChangeDateEnd'];
        PNRTicketed = json['PNRTicketed'];
        AddDILine = json['AddDILine'];
        EventTypeDetail = JsonConverters.fromJson(json['EventTypeDetail'],'List<String>',context!);
        return this;
    }

    Map<String, dynamic> toJson() => super.toJson()..addAll({
        'Account': JsonConverters.toJson(Account,'List<String>',context!),
        'UserName': UserName,
        'ChangeDateStart': ChangeDateStart,
        'ChangeDateEnd': ChangeDateEnd,
        'PNRTicketed': PNRTicketed,
        'AddDILine': AddDILine,
        'EventTypeDetail': JsonConverters.toJson(EventTypeDetail,'List<String>',context!)
    });

    getTypeName() => "GetItineraryChangeEvents";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'api.agentivity.com', types: <String, TypeInfo> {
    'PagingMetadata': TypeInfo(TypeOf.Class, create:() => PagingMetadata()),
    'ItineraryChangeEvent': TypeInfo(TypeOf.Class, create:() => ItineraryChangeEvent()),
    'Report<TItemResponse,TItem>': TypeInfo(TypeOf.GenericDef,create:() => Report()),
    'ItineraryChangeEventsResponseReport': TypeInfo(TypeOf.Class, create:() => ItineraryChangeEventsResponseReport()),
    'CacheMetadata': TypeInfo(TypeOf.Class, create:() => CacheMetadata()),
    'ResponseMetadata': TypeInfo(TypeOf.Class, create:() => ResponseMetadata()),
    'AgentivityError': TypeInfo(TypeOf.Class, create:() => AgentivityError()),
    'ItemResponse<TItem,TReport>': TypeInfo(TypeOf.GenericDef,create:() => ItemResponse()),
    'ItineraryChangeEventsItemResponse': TypeInfo(TypeOf.Class, create:() => ItineraryChangeEventsItemResponse()),
    'GetItineraryChangeEvents': TypeInfo(TypeOf.Class, create:() => GetItineraryChangeEvents()),
});

Dart GetItineraryChangeEvents 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.

GET /ItineraryChangeEvents 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>
      <AgentivityRef>String</AgentivityRef>
      <RecordLocator>String</RecordLocator>
      <LastActionConsultant>String</LastActionConsultant>
      <Passengers>String</Passengers>
      <EventDateTime>0001-01-01T00:00:00</EventDateTime>
      <EventDateTimeFormatted>String</EventDateTimeFormatted>
      <EventTypeDetail>String</EventTypeDetail>
      <EventTypeGroup>String</EventTypeGroup>
      <OldData>String</OldData>
      <NewData>String</NewData>
      <PNRTicketed>String</PNRTicketed>
      <FirstDILine>String</FirstDILine>
      <Account>String</Account>
      <PurchaseOrder>String</PurchaseOrder>
      <DivisionCode>String</DivisionCode>
      <BusinessUnit>String</BusinessUnit>
      <AccountCode>String</AccountCode>
    </Item>
  </ResponseReport>
  <ResponseError>
    <ErrorCode>String</ErrorCode>
    <Message>String</Message>
    <StatusCode>String</StatusCode>
    <VerboseMessage>String</VerboseMessage>
  </ResponseError>
</AgentivityResponse>