Start sharing

Scope

Add access rights to a specific session.

Description

1. The session is accompanied by information about the person and the level of his/her access rights;

2. If a person who is already attached to the session is subordinate, information is corrected according to the supplied data;

3. The session is set to show that it is shared.

Request

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

POST /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.

Content-Type Header

Content-Type: application/json

Body

[ 
 {
    "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

POST /api-share/v1/80832540faff3f90246b71122a4bd6896cd50933cc12a22d99a577b7b41d55e2/Persons HTTP/1.1
Authorization: Bearer a477b3a3366768c07e4c458f518711b4b351e8d2c2f0f78a1524e4d3efd00603
Host: signapi-prep.eparaksts.lv
[
{
    "personId": "111111-11111",
    "accessRights": 5
}
]

Response

JSON object:

{
  "data": {String}
}
PropertyDescription
data
Information about sharing status

Example

{
    "data": "Sharing of the session 80832540faff3f90246b71122a4bd6896cd50933cc12a22d99a577b7b41d55e2 changed. 1 persons added, rights for 0 persons modified"
}
  • No labels