Agentivity API

<back to all web services

SegmentsQC

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(Namespace="schemas.agentivity.com/types")
abstract class CompanyLevelRequestBase extends PagingMetadata implements IMemberUsername, IMemberOwningCompanyCode
{
    /**
    * Comma Delimited List of Owning Company Codes
    */
    // @DataMember
    List<String>? OwningCompanyCode;

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

    CompanyLevelRequestBase({this.OwningCompanyCode,this.UserName});
    CompanyLevelRequestBase.fromJson(Map<String, dynamic> json) { fromMap(json); }

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

    Map<String, dynamic> toJson() => super.toJson()..addAll({
        'OwningCompanyCode': JsonConverters.toJson(OwningCompanyCode,'List<String>',context!),
        'UserName': UserName
    });

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

enum QcCheck
{
    Missing,
    Warning,
    Valid,
    Denied,
}

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

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

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

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

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

    // @DataMember(Order=50)
    String? BoardPoint;

    // @DataMember(Order=50)
    String? OffPoint;

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

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

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

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

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

    // @DataMember(Order=105)
    String? FlightNumberFromatted;

    // @DataMember(Order=110)
    QcCheck? SeatCheck;

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

    // @DataMember(Order=130)
    QcCheck? MealCheck;

    // @DataMember(Order=155)
    String? MealFormatted;

    // @DataMember(Order=160)
    String? ChauffeurDesc;

    // @DataMember(Order=170)
    String? TransferDesc;

    // @DataMember(Order=180)
    String? CarsFormatted;

    // @DataMember(Order=190)
    QcCheck? HoteCheck;

    // @DataMember(Order=200)
    String? Hotels;

    // @DataMember(Order=210)
    String? ShuttleDesc;

    // @DataMember(Order=220)
    String? TourDesc;

    // @DataMember(Order=230)
    String? FrequentFlyerNumbers;

    // @DataMember(Order=240)
    String? PnrTicketed;

    // @DataMember(Order=250)
    String? TicketNumber;

    // @DataMember(Order=260)
    String? Comments;

    // @DataMember(Order=270)
    String? OpsComments;

    // @DataMember(Order=280)
    bool? IsVip;

    // @DataMember(Order=290)
    String? CorporateFFs;

    // @DataMember(Order=300)
    String? VendorLocator;

    SegmentQC({this.AgentivityRef,this.RecordLocator,this.OwningConsultant,this.Passenger,this.Account,this.BoardPoint,this.OffPoint,this.DepartureTime,this.BookingClass,this.SegmentStatus,this.CarrierCode,this.FlightNbr,this.FlightNumberFromatted,this.SeatCheck,this.SeatFormatted,this.MealCheck,this.MealFormatted,this.ChauffeurDesc,this.TransferDesc,this.CarsFormatted,this.HoteCheck,this.Hotels,this.ShuttleDesc,this.TourDesc,this.FrequentFlyerNumbers,this.PnrTicketed,this.TicketNumber,this.Comments,this.OpsComments,this.IsVip,this.CorporateFFs,this.VendorLocator});
    SegmentQC.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        AgentivityRef = json['AgentivityRef'];
        RecordLocator = json['RecordLocator'];
        OwningConsultant = json['OwningConsultant'];
        Passenger = json['Passenger'];
        Account = json['Account'];
        BoardPoint = json['BoardPoint'];
        OffPoint = json['OffPoint'];
        DepartureTime = json['DepartureTime'];
        BookingClass = json['BookingClass'];
        SegmentStatus = json['SegmentStatus'];
        CarrierCode = json['CarrierCode'];
        FlightNbr = json['FlightNbr'];
        FlightNumberFromatted = json['FlightNumberFromatted'];
        SeatCheck = JsonConverters.fromJson(json['SeatCheck'],'QcCheck',context!);
        SeatFormatted = json['SeatFormatted'];
        MealCheck = JsonConverters.fromJson(json['MealCheck'],'QcCheck',context!);
        MealFormatted = json['MealFormatted'];
        ChauffeurDesc = json['ChauffeurDesc'];
        TransferDesc = json['TransferDesc'];
        CarsFormatted = json['CarsFormatted'];
        HoteCheck = JsonConverters.fromJson(json['HoteCheck'],'QcCheck',context!);
        Hotels = json['Hotels'];
        ShuttleDesc = json['ShuttleDesc'];
        TourDesc = json['TourDesc'];
        FrequentFlyerNumbers = json['FrequentFlyerNumbers'];
        PnrTicketed = json['PnrTicketed'];
        TicketNumber = json['TicketNumber'];
        Comments = json['Comments'];
        OpsComments = json['OpsComments'];
        IsVip = json['IsVip'];
        CorporateFFs = json['CorporateFFs'];
        VendorLocator = json['VendorLocator'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'AgentivityRef': AgentivityRef,
        'RecordLocator': RecordLocator,
        'OwningConsultant': OwningConsultant,
        'Passenger': Passenger,
        'Account': Account,
        'BoardPoint': BoardPoint,
        'OffPoint': OffPoint,
        'DepartureTime': DepartureTime,
        'BookingClass': BookingClass,
        'SegmentStatus': SegmentStatus,
        'CarrierCode': CarrierCode,
        'FlightNbr': FlightNbr,
        'FlightNumberFromatted': FlightNumberFromatted,
        'SeatCheck': JsonConverters.toJson(SeatCheck,'QcCheck',context!),
        'SeatFormatted': SeatFormatted,
        'MealCheck': JsonConverters.toJson(MealCheck,'QcCheck',context!),
        'MealFormatted': MealFormatted,
        'ChauffeurDesc': ChauffeurDesc,
        'TransferDesc': TransferDesc,
        'CarsFormatted': CarsFormatted,
        'HoteCheck': JsonConverters.toJson(HoteCheck,'QcCheck',context!),
        'Hotels': Hotels,
        'ShuttleDesc': ShuttleDesc,
        'TourDesc': TourDesc,
        'FrequentFlyerNumbers': FrequentFlyerNumbers,
        'PnrTicketed': PnrTicketed,
        'TicketNumber': TicketNumber,
        'Comments': Comments,
        'OpsComments': OpsComments,
        'IsVip': IsVip,
        'CorporateFFs': CorporateFFs,
        'VendorLocator': VendorLocator
    };

    getTypeName() => "SegmentQC";
    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="SegmentQC", Namespace="schemas.agentivity.com/types")
class SegmentsQCResponseReport extends Report<SegmentsQCItemResponse,SegmentQC> implements IConvertible
{
    SegmentsQCResponseReport();
    SegmentsQCResponseReport.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() => "SegmentsQCResponseReport";
    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 SegmentsQCItemResponse extends ItemResponse<SegmentQC,SegmentsQCResponseReport> implements IConvertible
{
    SegmentsQCItemResponse();
    SegmentsQCItemResponse.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() => "SegmentsQCItemResponse";
    TypeContext? context = _ctx;
}

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

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

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

    /**
    * Return only segments that are flagged as VIP only
    */
    // @DataMember
    bool? VipOnly;

    SegmentsQC({this.Account,this.DepartureDateStart,this.DepartureDateEnd,this.VipOnly});
    SegmentsQC.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        super.fromMap(json);
        Account = JsonConverters.fromJson(json['Account'],'List<String>',context!);
        DepartureDateStart = json['DepartureDateStart'];
        DepartureDateEnd = json['DepartureDateEnd'];
        VipOnly = json['VipOnly'];
        return this;
    }

    Map<String, dynamic> toJson() => super.toJson()..addAll({
        'Account': JsonConverters.toJson(Account,'List<String>',context!),
        'DepartureDateStart': DepartureDateStart,
        'DepartureDateEnd': DepartureDateEnd,
        'VipOnly': VipOnly
    });

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

TypeContext _ctx = TypeContext(library: 'api.agentivity.com', types: <String, TypeInfo> {
    'PagingMetadata': TypeInfo(TypeOf.Class, create:() => PagingMetadata()),
    'CompanyLevelRequestBase': TypeInfo(TypeOf.AbstractClass),
    'QcCheck': TypeInfo(TypeOf.Enum, enumValues:QcCheck.values),
    'SegmentQC': TypeInfo(TypeOf.Class, create:() => SegmentQC()),
    'Report<TItemResponse,TItem>': TypeInfo(TypeOf.GenericDef,create:() => Report()),
    'SegmentsQCResponseReport': TypeInfo(TypeOf.Class, create:() => SegmentsQCResponseReport()),
    '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()),
    'SegmentsQCItemResponse': TypeInfo(TypeOf.Class, create:() => SegmentsQCItemResponse()),
    'SegmentsQC': TypeInfo(TypeOf.Class, create:() => SegmentsQC()),
});

Dart SegmentsQC DTOs

GET /SegmentsQC 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>0</AgentivityRef>
      <RecordLocator>String</RecordLocator>
      <OwningConsultant>String</OwningConsultant>
      <Passenger>String</Passenger>
      <Account>String</Account>
      <BoardPoint>String</BoardPoint>
      <OffPoint>String</OffPoint>
      <DepartureTime>String</DepartureTime>
      <BookingClass>String</BookingClass>
      <SegmentStatus>String</SegmentStatus>
      <CarrierCode>String</CarrierCode>
      <FlightNbr>String</FlightNbr>
      <FlightNumberFromatted>String</FlightNumberFromatted>
      <SeatCheck>Missing</SeatCheck>
      <SeatFormatted>String</SeatFormatted>
      <MealCheck>Missing</MealCheck>
      <MealFormatted>String</MealFormatted>
      <ChauffeurDesc>String</ChauffeurDesc>
      <TransferDesc>String</TransferDesc>
      <CarsFormatted>String</CarsFormatted>
      <HoteCheck>Missing</HoteCheck>
      <Hotels>String</Hotels>
      <ShuttleDesc>String</ShuttleDesc>
      <TourDesc>String</TourDesc>
      <FrequentFlyerNumbers>String</FrequentFlyerNumbers>
      <PnrTicketed>String</PnrTicketed>
      <TicketNumber>String</TicketNumber>
      <Comments>String</Comments>
      <OpsComments>String</OpsComments>
      <IsVip>false</IsVip>
      <CorporateFFs>String</CorporateFFs>
      <VendorLocator>String</VendorLocator>
    </Item>
  </ResponseReport>
  <ResponseError>
    <ErrorCode>String</ErrorCode>
    <Message>String</Message>
    <StatusCode>String</StatusCode>
    <VerboseMessage>String</VerboseMessage>
  </ResponseError>
</AgentivityResponse>