Persons in session

Scope

Find out the persons with whom session is shared.

Description

Returns a list of people associated with the session.

Request

The Service provider's application sends the following GET request using TLS:

GET /api-share/v1.0/{sessionId}/persons

Property

Type

Usage

Description

sessionId
String (64)MandatoryFile processing session identifier

Authorization

The request must contain an Authorization header with an OAuth Introspect access token obtained via Integration Platform a Service provider's credentials grant flow.

Unable to render {include} The included page could not be found.

Example

GET /api-share/v1/552825f4eafdbf90a676ea40c4802c9d1f27c20373c2594c0dfe950976ce2b19/Persons HTTP/1.1
Authorization: Bearer a477b3a3366768c07e4c458f518711b4b351e8d2c2f0f78a1524e4d3efd00603
Host: signapi-prep.eparaksts.lv

Response

JSON object:

{
  "data": [
    {
      "personId": {String},
      "accessRights": {Integer}
    }
  ]
}
PropertyDescription
personId
Identificator of of the person who shall access this session
accessRights
Access rights level. For detailed information, please see "Person access list description".

Example

{
    "data": [
        {
            "personId": "111111-11111",
            "accessRights": 5
        },
        {
            "personId": "222222-22222",
            "accessRights": 1
        }
    ]
}
  • No labels