GET person/getAccessPriviliges?PersonId={PersonId}&Token={Token}

Get access of the person for specific hardware unit. Application privilege "View" for licensed agenda "Persons" required. Application privilege "View" for agenda item "Access" of licensed agenda "Persons" required. Data may also be restricted by record permission "View" of agenda "Persons". Data may also be restricted by record permission "Access Edit" of "HW structure permissions".

Request Information

Authorization

  • Authorization by token required

Availability

  • Method can be used

URI Parameters

NameDescriptionTypeAdditional information
PersonId

Unique identification of the person in the system

 string

Required

String length: inclusive between 0 and 100
Token

The action is authorized by this token. Token should generated by calling action "POST login". Expiration time of each token is 20 seconds

 globally unique identifier

Required

Body Parameters

None.

Response Information

Response Codes

Http CodeError NumberDescription
200 request succesfully done 0 Get Access priviliges for Person [{0}]successfully
202 request succesfully done 0 Get Access priviliges for Person [{0}]successfully. Permission Access Edit of HW structure permissions violated for some records
400 bad request 1002 Entry parameter missing or parameter bindigs failed
401 unauthorized 1000 Token {0} not found
401 unauthorized 1001 Token {0} already expired
401 unauthorized 1006 Ip filter violated for ip client address [{0}]
401 unauthorized 1007 Ip filter [{0}] parsing failed
401 unauthorized 1008 Request rate policy violated for [{0}]
403 server refuses fo fulfill the request 1101 Application privilege View for licensed agenda Persons violated for person [{0}]
403 server refuses fo fulfill the request 1118 Application privilege View for of agenda item Access of licensed agenda Persons violated for person [{0}]
404 required resource does not exist on the server 1100 PersonId [{0}] not found
404 required resource does not exist on the server 1220 Hw structure not found
404 required resource does not exist on the server 1114 No access priviliges found in request
415 unsupported Media Type The request entity has a media type which the server or resource does not support. Only application/json and application/xml are supported

Resource Description

AccessPriviligesGetResp
NameDescriptionTypeAdditional information
PersonId

Unique identification of the person in the system

 string

None.
Priviliges

Collection of AccessPriviliges

None.

Response Formats

application/json

Sample: 
{"PersonId":"100200300","Priviliges":[{"IdentifyingMode":2,"AccessModeTitle":null,"HwStructNodePath":"HwStructure - 0080A3A45917-S1","OptionAccess":1,"OptionAttendance":0,"ValidFrom":"2018-07-30T00:00:00","ValidTo":"2019-07-30T00:00:00"},{"IdentifyingMode":3,"AccessModeTitle":null,"HwStructNodePath":"HwStructure - 0080A3A71930-S2","OptionAccess":1,"OptionAttendance":1,"ValidFrom":"2020-01-30T00:00:00","ValidTo":"2021-07-30T00:00:00"},{"IdentifyingMode":1,"AccessModeTitle":null,"HwStructNodePath":"HwStructure - 0080A3A73240-S1","OptionAccess":0,"OptionAttendance":0,"ValidFrom":"2019-05-01T00:00:00","ValidTo":"2021-07-30T00:00:00"}]}

application/xml

Sample: 

<Response>
  <PersonId>100200300</PersonId>
  <AccessPriviliges>
    <AccessPriviliges>
      <IdentifyingMode>2</IdentifyingMode>
      <HwStructNodePath>HwStructure - 0080A3A45917-S1</HwStructNodePath>
      <OptionAccess>1</OptionAccess>
      <OptionAttendance>0</OptionAttendance>
      <ValidFrom>2018-07-30T00:00:00</ValidFrom>
      <ValidTo>2019-07-30T00:00:00</ValidTo>
    </AccessPriviliges>
    <AccessPriviliges>
      <IdentifyingMode>3</IdentifyingMode>
      <HwStructNodePath>HwStructure - 0080A3A71930-S2</HwStructNodePath>
      <OptionAccess>1</OptionAccess>
      <OptionAttendance>1</OptionAttendance>
      <ValidFrom>2020-01-30T00:00:00</ValidFrom>
      <ValidTo>2021-07-30T00:00:00</ValidTo>
    </AccessPriviliges>
    <AccessPriviliges>
      <IdentifyingMode>1</IdentifyingMode>
      <HwStructNodePath>HwStructure - 0080A3A73240-S1</HwStructNodePath>
      <OptionAccess>0</OptionAccess>
      <OptionAttendance>0</OptionAttendance>
      <ValidFrom>2019-05-01T00:00:00</ValidFrom>
      <ValidTo>2021-07-30T00:00:00</ValidTo>
    </AccessPriviliges>
  </AccessPriviliges>
</Response>

text/json

Sample: 
{
  "PersonId": "sample string 1",
  "Priviliges": [
    {
      "IdentifyingMode": 1,
      "AccessModeTitle": "sample string 2",
      "HwStructNodePath": "sample string 1",
      "OptionAccess": 2,
      "OptionAttendance": 3,
      "ValidFrom": "sample string 4",
      "ValidTo": "sample string 5"
    },
    {
      "IdentifyingMode": 1,
      "AccessModeTitle": "sample string 2",
      "HwStructNodePath": "sample string 1",
      "OptionAccess": 2,
      "OptionAttendance": 3,
      "ValidFrom": "sample string 4",
      "ValidTo": "sample string 5"
    }
  ]
}

text/xml

Sample: 
<Response xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <PersonId>sample string 1</PersonId>
  <AccessPriviliges>
    <AccessPriviliges>
      <IdentifyingMode>1</IdentifyingMode>
      <AccessModeTitle>sample string 2</AccessModeTitle>
      <HwStructNodePath>sample string 1</HwStructNodePath>
      <OptionAccess>2</OptionAccess>
      <OptionAttendance>3</OptionAttendance>
      <ValidFrom>sample string 4</ValidFrom>
      <ValidTo>sample string 5</ValidTo>
    </AccessPriviliges>
    <AccessPriviliges>
      <IdentifyingMode>1</IdentifyingMode>
      <AccessModeTitle>sample string 2</AccessModeTitle>
      <HwStructNodePath>sample string 1</HwStructNodePath>
      <OptionAccess>2</OptionAccess>
      <OptionAttendance>3</OptionAttendance>
      <ValidFrom>sample string 4</ValidFrom>
      <ValidTo>sample string 5</ValidTo>
    </AccessPriviliges>
  </AccessPriviliges>
</Response>