| GET | /CarSegments |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| PickUpDateStart | query | string | No | |
| PickUpDateEnd | query | string | No |
| 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<TItem> | 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 |
|---|---|---|---|---|
| ErrorCode | form | string | No | |
| Message | form | string | No | |
| StatusCode | form | string | No | |
| VerboseMessage | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| OwningAgencyLocation | form | string | No | |
| PNR | form | string | No | |
| Consultant | form | string | No | |
| SegmentStatus | form | string | No | |
| PickUpDate | form | string | No | |
| DropOffDate | form | string | No | |
| CarVendorCode | form | string | No | |
| VendorName | form | string | No | |
| AirportCode | form | string | No | |
| Passenger | form | string | No | |
| Account | form | string | No | |
| ConfirmationNbr | form | string | No | |
| CurrencyCode | form | string | No | |
| RateAmount | form | string | No | |
| CarType | form | string | No | |
| NbrOfCars | form | string | No | |
| BookedInName | form | string | No | |
| ServiceInformation | form | string | No | |
| BRInformation | form | string | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET //CarSegments HTTP/1.1 Host: api.agentivity.com Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length
{"ResponseMetadata":{"Success":false,"HasCache":false,"HasPaging":false,"CacheMetadata":{"IsFromCache":false,"CachedAt":"\/Date(-62135596800000-0000)\/","CacheExpiresAt":"\/Date(-62135596800000-0000)\/"},"PagingMetadata":{"Offset":"String","Limit":"String","TotalRecords":0,"ResponseRecords":0}},"ResponseReport":[{"OwningAgencyLocation":"String","PNR":"String","Consultant":"String","SegmentStatus":"String","PickUpDate":"String","DropOffDate":"String","CarVendorCode":"String","VendorName":"String","AirportCode":"String","Passenger":"String","Account":"String","ConfirmationNbr":"String","CurrencyCode":"String","RateAmount":"String","CarType":"String","NbrOfCars":"String","BookedInName":"String","ServiceInformation":"String","BRInformation":"String"}],"ResponseError":{"ErrorCode":"String","Message":"String","StatusCode":"String","VerboseMessage":"String"}}