Agentivity API

<back to all web services

AirSegmentsPerLocation

The following routes are available for this service:
GET/AirSegmentsPerLocation/user
using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using AgentivityAPI.ServiceModel.Types;
using AgentivityAPI.ServiceModel.Base;

namespace AgentivityAPI.ServiceModel.Base
{
    [DataContract(Namespace="schemas.agentivity.com/types")]
    public partial class CompanyLevelRequestBase
        : PagingMetadata, IMemberUsername, IMemberOwningCompanyCode
    {
        ///<summary>
        ///Comma Delimited List of Owning Company Codes
        ///</summary>
        [DataMember]
        public virtual string[] OwningCompanyCode { get; set; }

        ///<summary>
        ///UserName in form of an email address
        ///</summary>
        [DataMember]
        public virtual string UserName { get; set; }
    }

}

namespace AgentivityAPI.ServiceModel.Types
{
    [DataContract(Namespace="schemas.agentivity.com/types")]
    public partial class AirSegmentsPerLocation
        : CompanyLevelRequestBase
    {
        [DataMember]
        public virtual string DateStart { get; set; }

        [DataMember]
        public virtual string DateEnd { get; set; }
    }

    [DataContract(Name="Metadata", Namespace="schemas.agentivity.com/types")]
    public partial class PagingMetadata
    {
        ///<summary>
        ///Starting Record
        ///</summary>
        [DataMember]
        [ApiMember(DataType="string", Description="Starting Record", Name="Offset", ParameterType="query")]
        public virtual string Offset { get; set; }

        ///<summary>
        ///Number of records to return (PageSize)
        ///</summary>
        [DataMember]
        [ApiMember(DataType="string", Description="Number of records to return (PageSize)", Name="Limit", ParameterType="query")]
        public virtual string Limit { get; set; }

        ///<summary>
        ///Total Number of Records in a Full Reponse (if no paging)
        ///</summary>
        [DataMember]
        [ApiMember(DataType="string", Description="Total Number of Records in a Full Reponse (if no paging)", Name="TotalRecords", ParameterType="query")]
        public virtual int TotalRecords { get; set; }

        ///<summary>
        ///Total Number of Records in this Reponse (on this page)
        ///</summary>
        [DataMember]
        [ApiMember(DataType="string", Description="Total Number of Records in this Reponse (on this page)", Name="ResponseRecords", ParameterType="query")]
        public virtual int ResponseRecords { get; set; }
    }

}

C# 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>