Agentivity API

AirSegmentsPerLocation

The following routes are available for this service:
GET	/AirSegmentsPerLocation/user

import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*
import com.google.gson.annotations.*
import com.google.gson.reflect.*


@DataContract(Namespace="schemas.agentivity.com/types")
open class AirSegmentsPerLocation : CompanyLevelRequestBase()
{
    @DataMember
    open var DateStart:String? = null

    @DataMember
    open var DateEnd:String? = null
}

@DataContract(Namespace="schemas.agentivity.com/types")
open class CompanyLevelRequestBase : PagingMetadata(), IMemberUsername, IMemberOwningCompanyCode
{
    /**
    * Comma Delimited List of Owning Company Codes
    */
    @DataMember
    override var OwningCompanyCode:ArrayList<String>? = null

    /**
    * UserName in form of an email address
    */
    @DataMember
    override var UserName:String? = null
}

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

    /**
    * Number of records to return (PageSize)
    */
    @DataMember
    @ApiMember(DataType="string", Description="Number of records to return (PageSize)", Name="Limit", ParameterType="query")
    open var Limit:String? = 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")
    open var TotalRecords:Int? = 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")
    open var ResponseRecords:Int? = null
}

Kotlin 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>