Sessions of a Person
Scope
Find out the sessions which are shared with the specific person .
Description
Returns a list of the sessions associated to the person.
Request
The Service provider's application sends the following GET request using TLS:
GET /api-share/v1.0/{personId}/sessions
Property | Description |
---|---|
personId | Identificator of the person |
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.
Example
GET /api-share/v1/111111-111111/Sessions HTTP/1.1 Authorization: Bearer a477b3a3366768c07e4c458f518711b4b351e8d2c2f0f78a1524e4d3efd00603 Host: signapi-prep.eparaksts.lv
Response
JSON object:
{ "data": [ { "sessionId": {String}, "fileCount": {Integer}, "personCount": {Integer}, "signed": {Integer}, "shared": {Boolean}, "archived": {Boolean}, "signedFileType": {String}, "lastModified": {String}, "removalTime":{String} } ] }
Property | Description |
---|---|
sessionId | File processing session identifier |
fileCount | File amount in the session |
personCount | Number of people the session was shared with |
signed | Session signing status: 0 - files loaded but not signed 1 - already signed files where loaded 2 - files signed |
shared | Sharing statuss: false - session is not shared true - session is shared |
archived | Archive timestamp statuss: false - do not contain archive timestap true - archive timestap added |
signedFileType | If signed, shows format of the signed file |
lastModified | Time of last file processing request |
removalTime | Expected process deletion time |
Example
{ "data": [ { "sessionId": "552825f4eafdbf90a676ea40c4802c9d1f27c20373c2594c0dfe950976ce2b19", "fileCount": 0, "personCount": 2, "signed": 0, "shared": false, "archived": false, "lastModified": "0001-01-01T00:00:00", "removalTime": "0001-01-01T00:00:00" }, { "sessionId": "1d72da6fd2d71810f96d04e9261bee6f3b01eaba95ed9b25be0cd6230910902b", "fileCount": 0, "personCount": 1, "signed": 0, "shared": false, "archived": false, "lastModified": "0001-01-01T00:00:00", "removalTime": "0001-01-01T00:00:00" } ] }