Page History

...

Name	Description	Validation
q	Freetext query for finding matching profiles	Required parameter
page	Current page within the result set, starts at 0	Optional, number >= 0
pageSize	Maximum number of results per page. Default 10	Optional, number > 0 and <= 100
scope	Search scope	Optional, may be one of: DEFAULT (Applies default search options as is within the Faces UI) SHORTNAME (To look for profiles with a specific shortname set; partial matches are returned) EXTERNAL_NR (To look for profiles with a specific externalNr set; only exact matches are returned) GENERIC_FIELD (To look in a specific field from the agencies generic setup) RECORD_LOCATOR (To look for profiles with matching record locator only)
p	Search scope parameter	Required if scope=GENERIC_FIELD: Name of the generic field to search in Optional for scope=RECORD_LOCATOR: System type or Label (e.g. “CSX”, “GALILEO_WS”, “My HR-System”) Prohibited otherwise
detailSections	Specify additional profile areas to be returned if includeDetails is set to true. Only explicitly specified sections will be included.	Only the following sections are currently supported: AGENCY_INFO CONTACT_DATA

...

Name

Description

Validation

<uuid>

The UUID of the profile to retrieve

Required parameter

sections

Areas of the profile to be returned.

May

Must be used to reduce the amount of data transferred

, if only specific information is requiredAll sections will be dumped if omitted. Please identify the relevant sections for your application during development and use a restricted information subset before moving to production

Note

Currently all profile sections are dumped if this parameter is omitted.

However, we'll be removing this behaviour and you'll be required to demonstrate usage of the "sections" paraemeter along with how and why each section is processed during certification.

Optional

Code Block

language	bash
title	Example request

curl -v -H "Authorization: Bearer <token>" \
    "https://hurricane.umbrellanet.ch/uf-test/api/v1/profiles/company/b9321d7e-9d72-4e80-ac49-d3aa38169175?sections=CONTACT_DATA,MEMBERSHIPS"

...