Agentivity API

<back to all web services

AirSegmentsPerLocation

The following routes are available for this service:
GET/AirSegmentsPerLocation/user
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;
}

// @DataContract(Namespace="schemas.agentivity.com/types")
class AirSegmentsPerLocation extends CompanyLevelRequestBase implements IConvertible
{
    // @DataMember
    String? DateStart;

    // @DataMember
    String? DateEnd;

    AirSegmentsPerLocation({this.DateStart,this.DateEnd});
    AirSegmentsPerLocation.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        super.fromMap(json);
        DateStart = json['DateStart'];
        DateEnd = json['DateEnd'];
        return this;
    }

    Map<String, dynamic> toJson() => super.toJson()..addAll({
        'DateStart': DateStart,
        'DateEnd': DateEnd
    });

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

TypeContext _ctx = TypeContext(library: 'api.agentivity.com', types: <String, TypeInfo> {
    'PagingMetadata': TypeInfo(TypeOf.Class, create:() => PagingMetadata()),
    'CompanyLevelRequestBase': TypeInfo(TypeOf.AbstractClass),
    'AirSegmentsPerLocation': TypeInfo(TypeOf.Class, create:() => AirSegmentsPerLocation()),
});

Dart AirSegmentsPerLocation 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 /AirSegmentsPerLocation/user HTTP/1.1 
Host: api.agentivity.com 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ArrayOfAgentivityResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="schemas.agentivity.com/types">
  <AgentivityResponse>
    <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>
        <CarrierCode>String</CarrierCode>
        <CarrierName>String</CarrierName>
        <TotalAirSegments>0</TotalAirSegments>
      </Item>
    </ResponseReport>
    <ResponseError>
      <ErrorCode>String</ErrorCode>
      <Message>String</Message>
      <StatusCode>String</StatusCode>
      <VerboseMessage>String</VerboseMessage>
    </ResponseError>
  </AgentivityResponse>
</ArrayOfAgentivityResponse>