Versions Compared

Old Version 62

changes.mady.by.user Susanne Schlegel

Saved on

compared with

New Version 63

changes.mady.by.user Susanne Schlegel

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

NameDescriptionValidation
qFreetext query for finding matching profilesRequired parameter
pageCurrent page within the result set, starts at 0Optional, number >= 0
pageSizeMaximum number of results per page. Default 10Optional, number > 0 and <= 100
scopeSearch 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)

pSearch 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.

Any section may be specified, with more data-heavy sections only being allowed if pageSize is <= 25

The following sections are allowed regardless of page size:

  • AGENCY_INFO

  • CONTACT_DATA

  • PARENT_COMPANY

  • COMMENT

  • HISTORY

  • TRAVELLER_SETTINGS

  • GENERAL_SETTINGS

Code Block
languagebash
titleExample Request
curl -v -H "Authorization: Bearer <token>" \
    "https://hurricane.umbrellanet.ch/uf-test/api/v1/profiles/companies?q=acme&page=0&pageSize=10"

...