ProfileChildSearchReq |
element |
|
|
|
Request to allow a user to retrieve the immediate children of a given profile. |
| RetrieveProviderReservationDetails |
boolean simple type |
|
Optional |
false |
|
| AuthorizedBy |
string simple type |
|
Optional |
|
Used in showing who authorized the request. Use is optional. |
| LanguageCode |
token simple type |
|
Optional |
|
ISO 639 two-character language codes are used to retrieve specific information in the requested language. For Rich Content and Branding, language codes ZH-HANT (Chinese Traditional), ZH-HANS (Chinese Simplified), FR-CA (French Canadian) and PT-BR (Portuguese Brazil) can also be used. For RCH, language codes ENGB, ENUS, DEDE, DECH can also be used. Only certain services support this attribute. Providers: ACH, RCH, 1G, 1V, 1P, 1J. |
| OverrideLogging |
string simple type |
TRACE , DEBUG , INFO , WARN , ERROR , FATAL |
Optional |
|
Use to override the default logging level |
| TargetBranch |
string simple type |
|
Optional |
|
Used for Emulation - If authorised will execute the request as if the agent's parent branch is the TargetBranch specified. |
| TokenId |
string simple type |
|
Optional |
|
Authentication Token ID used when running in statefull operation. Obtained from the LoginRsp. Use is optional. |
| TraceId |
string simple type |
|
Optional |
|
Unique identifier for this atomic transaction traced by the user. Use is optional. |
| HierarchyType |
typeProfileType simple type |
Agency , Account |
Optional |
|
The type of hierarchy in which to search for children. If not specified search result will include profiles of all types. |
| IncludeAgentsAndTravelers |
boolean simple type |
|
Optional |
false |
Indicator to include or exclude Travelers and Agent profiles when doing a this search. The default is false, no Travelers or Agents will be returned. |
| BillingPointOfSaleInfo |
element |
|
|
|
Point of Sale information for Billing |
| CIDBNumber |
integer simple type |
|
Optional |
|
A 10 Digit customer number generated by CIDB system. |
| OriginApplication |
string simple type |
|
Required |
|
Name of the Point of Sale application which initiated the Request.This information will be provided as part of the provisioning of the user. |
| AgentIDOverride |
element |
|
|
|
Vendor specific agent identifier overrides to be used to access vendor systems. |
| AgentID |
string simple type |
|
Required |
|
The Agent ID for the applicable supplier/vendor |
| ProviderCode |
string simple type |
|
Required |
|
Provider code to route the AgentId to proper provider. |
| SupplierCode |
string simple type |
|
Optional |
|
Supplier code to determine which vendor this AgentId belongs to. |
| TerminalSessionInfo |
string simple type |
|
|
|
Travelport use only. This element contains CDATA information representing existing GDS session data or ACH credentials information of the terminal user |
| OverridePCC |
element |
|
|
|
Used for Host Emulation - If used agent will emulate to this PCC in host and execute the request emulated into this PCC. |
| ProviderCode |
string simple type |
|
Required |
|
The code of the provider (e.g. 1G, 1S) |
| PseudoCityCode |
string simple type |
|
Required |
|
The PCC in the host system. |
| ProfileID |
typeProfileID simple type |
|
|
|
Specify the Profile ID |
| ProvisioningCode |
element |
|
|
|
Specify the Provisioning Code with the profile Type |
| ProfileType |
typeProfileType simple type |
Agency , BranchGroup , Branch , Agent |
Required |
|
Specify the Profile Type (limited to only the ones where ProvisioningCode is relevant) |
| UniqueProfileID |
element |
|
|
|
Applicable to retrieve, modify and delete a traveler profile. Combination of UniqueProfileID and AgencyCode can be used in place of Profile ID. Cannot be used with ProfileParentAdd, ProfileParentDelete or ProfileChildSearch. |
| AgencyCode |
string simple type |
|
Optional |
|
'AgencyCode' is the Provisioning code of the parent Agency. This is an optional attribute and if not provided, the system will determine 'AgencyCode' by Agent's WAB/target Branch or Agent's agency. |
| ProfileType |
typeProfileType simple type |
Traveler |
Required |
|
Specify the Profile Type (limited to only the ones where Profile Identifier is relevant) |
| OrganizationName |
typeWildcard simple type |
|
|
|
Name of the organization to filter for. |
| GivenName |
typeWildcard simple type |
|
|
|
Name of the organization to filter for. |
| Surname |
typeWildcard simple type |
|
|
|
Name of the organization to filter for. |
| ProfileSearchModifiers |
element |
|
|
|
Specifies the range of search results. If omitted, the default values for each attriubute are used. |
| MaxResults |
integer simple type |
|
Optional |
20 |
Limits the number of search results in the response. Note that performance may decline when a large number of results is requested. |
| StartFromResult |
integer simple type |
|
Optional |
1 |
The starting search index of the results returned. Used to browse beyond the initial search results. |