Agentivity API

AirSegmentsPerLocation

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

"use strict";
export class PagingMetadata {
    /** @param {{Offset?:string,Limit?:string,TotalRecords?:number,ResponseRecords?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description Starting Record */
    Offset;
    /**
     * @type {string}
     * @description Number of records to return (PageSize) */
    Limit;
    /**
     * @type {number}
     * @description Total Number of Records in a Full Reponse (if no paging) */
    TotalRecords;
    /**
     * @type {number}
     * @description Total Number of Records in this Reponse (on this page) */
    ResponseRecords;
}
export class CompanyLevelRequestBase extends PagingMetadata {
    /** @param {{OwningCompanyCode?:string[],UserName?:string,Offset?:string,Limit?:string,TotalRecords?:number,ResponseRecords?:number}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /**
     * @type {string[]}
     * @description Comma Delimited List of Owning Company Codes */
    OwningCompanyCode;
    /**
     * @type {string}
     * @description UserName in form of an email address */
    UserName;
}
export class AirSegmentsPerLocation extends CompanyLevelRequestBase {
    /** @param {{DateStart?:string,DateEnd?:string,OwningCompanyCode?:string[],UserName?:string,Offset?:string,Limit?:string,TotalRecords?:number,ResponseRecords?:number}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {string} */
    DateStart;
    /** @type {string} */
    DateEnd;
}

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