Agentivity API

AirSegmentsPerLocation

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


// @DataContract(Name="Metadata", Namespace="schemas.agentivity.com/types")
export class PagingMetadata
{
    /** @description Starting Record */
    // @DataMember
    // @ApiMember(DataType="string", Description="Starting Record", Name="Offset", ParameterType="query")
    public Offset: string;

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

    /** @description 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")
    public TotalRecords: number;

    /** @description 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")
    public ResponseRecords: number;

    public constructor(init?: Partial<PagingMetadata>) { (Object as any).assign(this, init); }
}

// @DataContract(Namespace="schemas.agentivity.com/types")
export class CompanyLevelRequestBase extends PagingMetadata implements IMemberUsername, IMemberOwningCompanyCode
{
    /** @description Comma Delimited List of Owning Company Codes */
    // @DataMember
    public OwningCompanyCode: string[];

    /** @description UserName in form of an email address */
    // @DataMember
    public UserName: string;

    public constructor(init?: Partial<CompanyLevelRequestBase>) { super(init); (Object as any).assign(this, init); }
}

// @DataContract(Namespace="schemas.agentivity.com/types")
export class AirSegmentsPerLocation extends CompanyLevelRequestBase
{
    // @DataMember
    public DateStart: string;

    // @DataMember
    public DateEnd: string;

    public constructor(init?: Partial<AirSegmentsPerLocation>) { super(init); (Object as any).assign(this, init); }
}

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