| GET | /AirSegmentsPerCarrier |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| DateStart | query | string | Yes | Date in format YYYYMMDD |
| DateEnd | query | string | Yes | Date in format YYYYMMDD |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| OwningCompanyCode | query | string | No | Comma Delimited List of Owning Company Codes |
| UserName | query | string | No | UserName in form of an email address |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Offset | query | string | No | Starting Record |
| Limit | query | string | No | Number of records to return (PageSize) |
| TotalRecords | query | string | No | Total Number of Records in a Full Reponse (if no paging) |
| ResponseRecords | query | string | No | Total Number of Records in this Reponse (on this page) |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ResponseMetadata | form | ResponseMetadata | No | |
| ResponseReport | form | List<ApiRequestPerHour> | No | |
| ResponseError | form | AgentivityError | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Success | form | bool | No | |
| HasCache | form | bool | No | |
| HasPaging | form | bool | No | |
| CacheMetadata | form | CacheMetadata | No | |
| PagingMetadata | form | PagingMetadata | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CachedAt | form | DateTime | No | |
| CacheExpiresAt | form | DateTime | No | |
| IsFromCache | form | bool | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| RequestDate | form | DateTime | No | |
| Hour0 | form | int | No | |
| Hour1 | form | int | No | |
| Hour2 | form | int | No | |
| Hour3 | form | int | No | |
| Hour4 | form | int | No | |
| Hour5 | form | int | No | |
| Hour6 | form | int | No | |
| Hour7 | form | int | No | |
| Hour8 | form | int | No | |
| Hour9 | form | int | No | |
| Hour10 | form | int | No | |
| Hour11 | form | int | No | |
| Hour12 | form | int | No | |
| Hour13 | form | int | No | |
| Hour14 | form | int | No | |
| Hour15 | form | int | No | |
| Hour16 | form | int | No | |
| Hour17 | form | int | No | |
| Hour18 | form | int | No | |
| Hour19 | form | int | No | |
| Hour20 | form | int | No | |
| Hour21 | form | int | No | |
| Hour22 | form | int | No | |
| Hour23 | form | int | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ErrorCode | form | string | No | |
| Message | form | string | No | |
| StatusCode | form | string | No | |
| VerboseMessage | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CarrierCode | form | string | No | |
| CarrierName | form | string | No | |
| TotalAirSegments | form | int | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /AirSegmentsPerCarrier HTTP/1.1 Host: servicestack.agentivity.com Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<AgentivityResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="schemas.agentivity.com/types">
<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>
<AirSegmentPerCarrier>
<CarrierCode>String</CarrierCode>
<CarrierName>String</CarrierName>
<TotalAirSegments>0</TotalAirSegments>
</AirSegmentPerCarrier>
</ResponseReport>
<ResponseError>
<ErrorCode>String</ErrorCode>
<Message>String</Message>
<StatusCode>String</StatusCode>
<VerboseMessage>String</VerboseMessage>
</ResponseError>
</AgentivityResponse>