GET pxapi/Role?selection={selection}&inclNotActive={inclNotActive}&companyId={companyId}

Retrieves roles according to selection

Request Information

Parameters

Name	Description	Additional information
selection	1 - standard sync-data - all roles	Define this parameter in the request URI.
inclNotActive	false for only active ones or true for all, no matter status	Define this parameter in the request URI.
companyId	ID for the current company/PX database received by the PX Administrator	Define this parameter in the request URI.

Response Information

Response body formats

application/json, text/json

Sample:

{
  "Servertime": "2026-05-09T17:16:57.9369762+02:00",
  "Roles": [
    {
      "Roleid": "sample string 1",
      "Language": "sample string 2",
      "Name": "sample string 3",
      "Blocked": true
    },
    {
      "Roleid": "sample string 1",
      "Language": "sample string 2",
      "Name": "sample string 3",
      "Blocked": true
    },
    {
      "Roleid": "sample string 1",
      "Language": "sample string 2",
      "Name": "sample string 3",
      "Blocked": true
    }
  ],
  "Message": {
    "Messagetype": 1,
    "Datareference": "sample string 2",
    "Messagetext": "sample string 3",
    "Created": "sample string 4",
    "Noofrowssub1": 1,
    "Noofrowssub2": 1,
    "Noofrowssub3": 1,
    "Noofrowssub4": 1,
    "Noofrowssub5": 1,
    "Noofrowssub6": 1,
    "AutoInvoiceData": {
      "Status": 1,
      "Documentid": 2,
      "Errortext": "sample string 3",
      "Xmlfilesuffix": "sample string 4",
      "Filereference": "sample string 5",
      "Document": "QEBA",
      "Attachments": [
        {
          "Attachmenttype": 1,
          "Documentid": 2,
          "Attachmentid": 1,
          "Filereference": "sample string 3",
          "Filename": "sample string 4",
          "DceInvoice": "QEBA"
        },
        {
          "Attachmenttype": 1,
          "Documentid": 2,
          "Attachmentid": 1,
          "Filereference": "sample string 3",
          "Filename": "sample string 4",
          "DceInvoice": "QEBA"
        },
        {
          "Attachmenttype": 1,
          "Documentid": 2,
          "Attachmentid": 1,
          "Filereference": "sample string 3",
          "Filename": "sample string 4",
          "DceInvoice": "QEBA"
        }
      ]
    }
  }
}

application/xml, text/xml

Sample:

<RoleHead xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Visma.PXWebApi.Domain.Entities.Registration">
  <Message xmlns:d2p1="http://schemas.datacontract.org/2004/07/Visma.PXWebApi.Domain.Entities.Misc">
    <d2p1:AutoInvoiceData>
      <d2p1:Attachments>
        <d2p1:AutoInvoiceAttachment>
          <d2p1:Attachmentid>1</d2p1:Attachmentid>
          <d2p1:Attachmenttype>1</d2p1:Attachmenttype>
          <d2p1:DceInvoice>QEBA</d2p1:DceInvoice>
          <d2p1:Documentid>2</d2p1:Documentid>
          <d2p1:Filename>sample string 4</d2p1:Filename>
          <d2p1:Filereference>sample string 3</d2p1:Filereference>
        </d2p1:AutoInvoiceAttachment>
        <d2p1:AutoInvoiceAttachment>
          <d2p1:Attachmentid>1</d2p1:Attachmentid>
          <d2p1:Attachmenttype>1</d2p1:Attachmenttype>
          <d2p1:DceInvoice>QEBA</d2p1:DceInvoice>
          <d2p1:Documentid>2</d2p1:Documentid>
          <d2p1:Filename>sample string 4</d2p1:Filename>
          <d2p1:Filereference>sample string 3</d2p1:Filereference>
        </d2p1:AutoInvoiceAttachment>
        <d2p1:AutoInvoiceAttachment>
          <d2p1:Attachmentid>1</d2p1:Attachmentid>
          <d2p1:Attachmenttype>1</d2p1:Attachmenttype>
          <d2p1:DceInvoice>QEBA</d2p1:DceInvoice>
          <d2p1:Documentid>2</d2p1:Documentid>
          <d2p1:Filename>sample string 4</d2p1:Filename>
          <d2p1:Filereference>sample string 3</d2p1:Filereference>
        </d2p1:AutoInvoiceAttachment>
      </d2p1:Attachments>
      <d2p1:Document>QEBA</d2p1:Document>
      <d2p1:Documentid>2</d2p1:Documentid>
      <d2p1:Errortext>sample string 3</d2p1:Errortext>
      <d2p1:Filereference>sample string 5</d2p1:Filereference>
      <d2p1:Status>1</d2p1:Status>
      <d2p1:Xmlfilesuffix>sample string 4</d2p1:Xmlfilesuffix>
    </d2p1:AutoInvoiceData>
    <d2p1:Created>sample string 4</d2p1:Created>
    <d2p1:Datareference>sample string 2</d2p1:Datareference>
    <d2p1:Messagetext>sample string 3</d2p1:Messagetext>
    <d2p1:Messagetype>1</d2p1:Messagetype>
    <d2p1:Noofrowssub1>1</d2p1:Noofrowssub1>
    <d2p1:Noofrowssub2>1</d2p1:Noofrowssub2>
    <d2p1:Noofrowssub3>1</d2p1:Noofrowssub3>
    <d2p1:Noofrowssub4>1</d2p1:Noofrowssub4>
    <d2p1:Noofrowssub5>1</d2p1:Noofrowssub5>
    <d2p1:Noofrowssub6>1</d2p1:Noofrowssub6>
  </Message>
  <Roles>
    <Role>
      <Blocked>true</Blocked>
      <Language>sample string 2</Language>
      <Name>sample string 3</Name>
      <Roleid>sample string 1</Roleid>
    </Role>
    <Role>
      <Blocked>true</Blocked>
      <Language>sample string 2</Language>
      <Name>sample string 3</Name>
      <Roleid>sample string 1</Roleid>
    </Role>
    <Role>
      <Blocked>true</Blocked>
      <Language>sample string 2</Language>
      <Name>sample string 3</Name>
      <Roleid>sample string 1</Roleid>
    </Role>
  </Roles>
  <Servertime>2026-05-09T17:16:57.9369762+02:00</Servertime>
</RoleHead>