The Profile Child Search service returns the immediate children (count and profile summary) of the parent profile specified. Use the Profile Search service to search for a specific profile using various parameters.
The Child Search service only returns the immediate children. It never returns further descendants (children of children). Subsequent requests must be used to browse in steps down through the hierarchy. Deleted profiles are never returned in the response.
The API will provide pagination on the result set. The client service may therefore specify a maximum number of results to return per response (up to a Travelport-defined maximum), and “get more” if appropriate via follow-up requests.
Request
To request the immediate children of a given profile:
-
Specify the ID or provisioning code of the parent.
-
Use the HierarchyType attribute to limit which children are returned (i.e., either agency or account). If no HierarchyType is specified, children of all profile types are returned.
-
This attribute allows you to filter out travelers and accounts that might be directly attached to agencies, branch groups, or branches, or to filter out branch groups, branches, and agents when browsing the agency side of the hierarchy.
-
Use the IncludeAgentsAndTravelers flag to specify whether travelers and agents that are children of the profile should be included in the response.
-
Optionally, enter a name value to filter the results.
-
A wildcard character is permitted for Name (it will work the same as wildcards in the Profile Search feature).
-
For agent and traveler, you can search on Given Name and/or Surname. For other entities, Organization Name can be used to search.
-
For agent and traveler, the GivenName and Surname on the request is mapped to the First and Last Name, respectively. Thus searching for an account’s child profiles by the Organization Name "Smith*" could return a traveler group profile with the name Smith Travel Inc, or searching with surnames "Smith*" could return travelers with last name Smith and Smithe, but not travelers with a given name of Smith.
Show schema diagram
In ProfileChildSearchReq/ProfileSpecification, if a ProfileID or ProvisioningCode is from a Work Area Branch (WAB), then ProfileChildSearchRsp\ProfileChildSummary returns all of the Agents' Profiles who have the requested WAB as their default WAB.
Notes:
- Because Agent and Traveler never have children, a child search response using an ID of one of these profile types will always return an error message and not an empty result set.
- Travelers who may not be the child of an account or traveler group are nevertheless considered part of the account hierarchy for the purposes of this service.
- If the user specifies an Agency ID and requests to search the Agency hierarchy, then only branch groups and branches directly attached to the agency will be returned.
- If the user specifies an Agency ID and requests to search the Account hierarchy, then only accounts and travelers directly attached to the agency will be returned.
- If the user specifies an Account ID and requests to search the Agency hierarchy, the result set will be empty because an account cannot have child agency, branch group, branch, or agent profiles.
Examples:
Response
The child search response includes the number of children found and child profile summary (i.e., a limited subset of data) of each child profile matching the search parameters. Results are sorted by profile type and then by name. The following information is returned in the response:
- The unique ID of the profile
- The provisioning ID/code of the profile, if applicable
- The type of profile (e.g., branch group, traveler group, agent, traveler)
- Agents associated to the children of a default Work Area Branch in addition to the physical children of a Control Branch. Before Release 2.1, Profile Child Searches returned only the children of a Control Branch
- The Name of the profile
- For agent and traveler, both first/given name and surname will be returned (not middle or prefix/suffix).
- The profile's current status
- The profile's current version
- The unique ID of the associated hierarchy level, if applicable (not relevant for travelers)
- The number of parents the profile has
- For all but traveler, the service will always return 1. For travelers, the number could be greater than 1.
- The description, if one exists
Note: Profiles with a status of Deleted are never be returned.
