| All Verbs | /ConsultantWorkGDSActions |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| DateStart | query | string | Yes | Date in format YYYYMMDD |
| DateEnd | query | string | Yes | Date in format YYYYMMDD |
| OwningConsultantID | query | string | Yes | Comma delimited list of owning consultants ids |
| TransactionAgencyLocationID | query | string | No | Comma delimited list of transaction agency location ids |
| RequestConsultantID | query | string | No | Request Consultant ID (sign on) |
| 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 |
|---|---|---|---|---|
| ProblematicSegmentList | form | List<ConsultantProblematicSegment> | No | |
| AirlineDemandsForTicketingList | form | List<ConsultantAirlineDemandsForTicketing> | No | |
| BookingsWithWarningsList | form | List<BookingWithWarnings> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| RecordLocator | form | string | No | |
| PNRCreationDate | form | DateTime? | No | |
| OwningConsultantID | form | string | No | |
| OwningConsultant | form | string | No | |
| PrimaryPax | form | string | No | |
| Account | form | string | No | |
| SegmentStatus | form | string | No | |
| Segment | form | string | No | |
| OwningAgencyLocationID | form | string | No | |
| GdsCode | form | string | No | |
| DepartureDate | form | DateTime? | No | |
| AgentivityRef | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| RecordLocator | form | string | No | |
| PNRCreationDate | form | DateTime? | No | |
| PrimaryPax | form | string | No | |
| OwningConsultantID | form | string | No | |
| OwningConsultant | form | string | No | |
| Account | form | string | No | |
| AirlineCode | form | string | No | |
| DueDate | form | DateTime? | No | |
| DueTime | form | string | No | |
| OwningAgencyLocationID | form | string | No | |
| GdsCode | form | string | No | |
| AgentivityRef | form | int? | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| RecordLocator | form | string | No | |
| PNRCreationDate | form | DateTime | No | |
| AgentivityRef | form | int | No | |
| OwningConsultant | form | string | No | |
| Account | form | string | No | |
| OwningConsultantID | form | string | No | |
| OwningAgencyLocationID | form | string | No | |
| GdsCode | form | string | No | |
| TravelDate | form | DateTime? | No | |
| PrimaryPax | form | string | No | |
| WarningsList | form | List<BookingWarning> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| WarningType | form | string | No | |
| Vendor | form | string | No | |
| VendorType | form | string | No | |
| WarningDateTime | form | DateTime? | No | |
| LogDateTime | form | DateTime? | No | |
| OriginalRemark | form | string | No | |
| PropertiesList | form | List<BookingWarningProperty> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Name | form | string | No | |
| Value | form | string | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /ConsultantWorkGDSActions HTTP/1.1
Host: api.agentivity.com
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length
{"DateStart":"String","DateEnd":"String","OwningConsultantID":["String"],"TransactionAgencyLocationID":["String"],"RequestConsultantID":"String","OwningCompanyCode":["String"],"UserName":"String","Offset":"String","Limit":"String","TotalRecords":0,"ResponseRecords":0}
HTTP/1.1 200 OK
Content-Type: text/jsonl
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":[{"ProblematicSegmentList":[{"RecordLocator":"String","PNRCreationDate":"\/Date(-62135596800000-0000)\/","OwningConsultantID":"String","OwningConsultant":"String","PrimaryPax":"String","Account":"String","SegmentStatus":"String","Segment":"String","OwningAgencyLocationID":"String","GdsCode":"String","DepartureDate":"\/Date(-62135596800000-0000)\/","AgentivityRef":"String"}],"AirlineDemandsForTicketingList":[{"RecordLocator":"String","PNRCreationDate":"\/Date(-62135596800000-0000)\/","PrimaryPax":"String","OwningConsultantID":"String","OwningConsultant":"String","Account":"String","AirlineCode":"String","DueDate":"\/Date(-62135596800000-0000)\/","DueTime":"String","OwningAgencyLocationID":"String","GdsCode":"String","AgentivityRef":0}],"BookingsWithWarningsList":[{"RecordLocator":"String","PNRCreationDate":"\/Date(-62135596800000-0000)\/","AgentivityRef":0,"OwningConsultant":"String","Account":"String","OwningConsultantID":"String","OwningAgencyLocationID":"String","GdsCode":"String","TravelDate":"\/Date(-62135596800000-0000)\/","PrimaryPax":"String","WarningsList":[{"WarningType":"String","Vendor":"String","VendorType":"String","WarningDateTime":"\/Date(-62135596800000-0000)\/","LogDateTime":"\/Date(-62135596800000-0000)\/","OriginalRemark":"String","PropertiesList":[{"Name":"String","Value":"String"}]}]}]}],"ResponseError":{"ErrorCode":"String","Message":"String","StatusCode":"String","VerboseMessage":"String"}}