settings/userprofiles/print

Retrieves the list of all user profiles defined in the platform with code and description, returning an Excel, JSON or XML file.

URL

CODE

(GET) /api/settings/userprofiles/print

PARAMETERS

The URL parameters are:

format

The report format, any of:

Excel (default)
Xml
Json

Optional, string

RESULTS

The method returns a file “user-profiles” in the following format:

JSON

The file content is a JSON array. See example below:

CODE

[
  {
    "v": 1,
    "t": "Administrator"
  },
  {
    "v": 2,
    "t": "Manager"
  },
  {
    "v": 3,
    "t": "Team leader"
  },
  {
    "v": 4,
    "t": "Worker"
  },
  {
    "v": 5,
    "t": "Worker (limited)"
  },
  ...
]

XML

CODE

<?xml version="1.0" encoding="utf-8"?>
<Rows>
  <Row>
    <v>1</v>
    <t>Administrator</t>
  </Row>
  <Row>
    <v>2</v>
    <t>Manager</t>
  </Row>
  <Row>
    <v>3</v>
    <t>Team leader</t>
  </Row>
  <Row>
    <v>4</v>
    <t>Worker</t>
  </Row>
  <Row>
    <v>5</v>
    <t>Worker (limited)</t>
  </Row>
  ...
</Rows>

EXCEL

The report is an .xlsx file.