System administrators can use ProfileSearchReq to search for profiles across the system by not specifying a parent ID in the request. However, to improve performance of such system-wide searches, when a parent ID is not specified, additional search data will be required. The additional information required depends on the type of search (e.g., agency-level search) and the information submitted in the request.
Additional Information
The following sections list the additional information necessary for each search when the parent ID is not included in a traveller profile search at the branch, branch group, agency, agency group, or system level.
Notes:
-
Wildcard okay requires at least two characters prior to the wildcard indicator, unless otherwise noted.
-
Complete indicates that no wildcard is permitted.
-
If the value being used to search is within the travelers profile itself, the additional information supplied must also be within the traveler profile (i.e., within ProfileSearchReq>ProfileTypeSearch>TravelerCriteria). If the value being used to search is within the alternate contact section of the profile, the additional information supplied must also be within the alternate contact section of the profile (i.e., within ProfileSearchReq>ProfileSearch>AlternateContact).
Search by Country Code or Telephone Country Code
If searching for traveler profiles by Address>Country or for any profile type by Phone>CountryCode, then at least one (or one combination) of the following is required:
-
GivenName AND Surname (applies only to branch level). One value must be complete, while a wildcard is okay for the other.
Note: If searching by country code at a higher hierarchy level than branch, one of the other types of additional information listed below is required. GivenName and Surname do not fulfill the additional information requirements for branch group, agency, agency group, or system searches. -
Phone>LocalNumber (complete)
-
Address>StateProvince AND Address>City AND Name (as defined above)
-
Address>PostalCode (complete) AND Name (as defined above)
-
Address>PostalCode (complete) AND Address>AddressLine (complete)
Search by State/Province Code
If searching for profiles by Address>StateProvince, then at least one (or one combination) of the following is required:
-
GivenName AND Surname (applies only to branch level). One value must be complete; the other value must have at least 5 characters before the wildcard.
Note: If searching at a higher hierarchy level than branch, one of the other types of additional information listed below is required. GivenName and Surname do not fulfill the additional information requirements for branch group, agency, agency group, or system searches. -
Phone>LocalNumber (complete)
-
Address>City (complete) AND Name (as defined above)
-
Address>PostalCode (complete) AND Name (as defined above)
-
Address>PostalCode (complete) AND Address>AddressLine (complete)
Search by Surname or Given Name
If searching by Surname or GivenName (i.e., within TravelerCriteria or AlternateContact), then at least one (or one combination) of the following is required:
-
The other name value (complete). That is, if searching by Surname, the GivenName value can be used to fulfill the additional information requirement.
Note: If searching at a higher hierarchy level than branch, one of the other types of additional information listed below is required. -
Phone>LocalNumber (complete)
-
Address>City (complete) AND other name value (wildcard okay)
-
Address>PostalCode (complete) AND other name value (wildcard okay)
-
Address>PostalCode (complete) AND Address>AddressLine (complete)
Search by Email
If searching by any data within ElectronicAddress, Address is required (wildcard OK). A user cannot search by ElectronicAddress>Type and/or ElectronicAddress>Purpose without also providing at least a partial Address.
If Address is searched by a wildcard with fewer than 10 characters and/or no @ is specified, then Address>PostalCode (complete) must also be provided.
Search by Payment Details
When searching by ProfileSearchReq>ProfileSearch>PaymentDetails, the Type element is required. If searching by any other data within PaymentDetails, then at least one (or one combination) of the following is required:
- AccountNumber (complete)
- ExpirationDate or PaymentSupplier without AccountNumber AND at least one of the following from the address/phone/name of the traveler profile:
- Address>PostalCode (complete)
- Address>City (complete)
- Phone>LocalNumber (complete)
- GivenName AND Surname. One value must be complete; the other value must have at least 5 characters before the wildcard.
Feedback / Support
