POST person/setAccessPriviliges?Token={Token}

Set access of the person for specific hardware unit. Application privilege "Edit" for licensed agenda "Persons" required. Application privilege "Edit" for agenda item "Access" of licensed agenda "Persons" required. Functionality may also be restricted by record permission "Access edit" of agenda "Person". Functionality 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
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

PersonSetAccessPriviligesReq
NameDescriptionTypeAdditional information
PersonId

Unique identification of the person in the system

 string

Required

String length: inclusive between 0 and 100
CleanOtherPriviliges

Remove access of the person for all others hardware unit. Functionality may be restricted by record permission "Access Edit" of "HW structure permissions". Default value is "0".

 integer

Range: inclusive between 0 and 1
AccessPriviliges

Collection of AccessPrivilige

None.

Request Formats

application/json

Sample: 
{"PersonId":"100200300","CleanOtherPriviliges":0,"AccessPriviliges":[{"HwStructNodePath":"HwStructure - 0080A3A45917 Sensor 1","OptionAccess":1,"OptionAttendance":0,"ValidFrom":"\/Date(1532901600000)\/","ValidTo":"\/Date(1564437600000)\/","IdentifyingMode":2,"AccessModeTitle":null},{"HwStructNodePath":"HwStructure - 0080A3A45917 Sensor 1","OptionAccess":1,"OptionAttendance":1,"ValidFrom":"\/Date(1564610400000)\/","ValidTo":"\/Date(1609282800000)\/","IdentifyingMode":3,"AccessModeTitle":null},{"HwStructNodePath":"HwStructure - 0080A3A45917 Sensor 2","OptionAccess":0,"OptionAttendance":0,"ValidFrom":"\/Date(1607986800000)\/","ValidTo":"\/Date(1611961200000)\/","IdentifyingMode":1,"AccessModeTitle":null}]}

application/xml

Sample: 

<Request>
  <PersonId>100200300</PersonId>
  <CleanOtherPriviliges>0</CleanOtherPriviliges>
  <AccessPriviliges>
    <AccessPrivilige>
      <HwStructNodePath>HwStructure - 0080A3A45917 Sensor 1</HwStructNodePath>
      <OptionAccess>1</OptionAccess>
      <OptionAttendance>0</OptionAttendance>
      <ValidFrom>2018-07-30T00:00:00</ValidFrom>
      <ValidTo>2019-07-30T00:00:00</ValidTo>
      <IdentifyingMode>2</IdentifyingMode>
    </AccessPrivilige>
    <AccessPrivilige>
      <HwStructNodePath>HwStructure - 0080A3A45917 Sensor 1</HwStructNodePath>
      <OptionAccess>1</OptionAccess>
      <OptionAttendance>1</OptionAttendance>
      <ValidFrom>2019-08-01T00:00:00</ValidFrom>
      <ValidTo>2020-12-30T00:00:00</ValidTo>
      <IdentifyingMode>3</IdentifyingMode>
    </AccessPrivilige>
    <AccessPrivilige>
      <HwStructNodePath>HwStructure - 0080A3A45917 Sensor 2</HwStructNodePath>
      <OptionAccess>0</OptionAccess>
      <OptionAttendance>0</OptionAttendance>
      <ValidFrom>2020-12-15T00:00:00</ValidFrom>
      <ValidTo>2021-01-30T00:00:00</ValidTo>
      <IdentifyingMode>1</IdentifyingMode>
    </AccessPrivilige>
  </AccessPriviliges>
</Request>

text/json

Sample: 
{
  "PersonId": "sample string 1",
  "CleanOtherPriviliges": 2,
  "AccessPriviliges": [
    {
      "HwStructNodePath": "sample string 1",
      "OptionAccess": 2,
      "OptionAttendance": 1,
      "ValidFrom": "2024-12-03T18:28:29.0386741+01:00",
      "ValidTo": "2024-12-03T18:28:29.0386741+01:00",
      "IdentifyingMode": 1,
      "AccessModeTitle": "sample string 3"
    },
    {
      "HwStructNodePath": "sample string 1",
      "OptionAccess": 2,
      "OptionAttendance": 1,
      "ValidFrom": "2024-12-03T18:28:29.0386741+01:00",
      "ValidTo": "2024-12-03T18:28:29.0386741+01:00",
      "IdentifyingMode": 1,
      "AccessModeTitle": "sample string 3"
    }
  ]
}

text/xml

Sample: 
<Request xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <PersonId>sample string 1</PersonId>
  <CleanOtherPriviliges>2</CleanOtherPriviliges>
  <AccessPriviliges>
    <AccessPrivilige>
      <HwStructNodePath>sample string 1</HwStructNodePath>
      <OptionAccess>2</OptionAccess>
      <OptionAttendance>1</OptionAttendance>
      <ValidFrom>2024-12-03T18:28:29.0386741+01:00</ValidFrom>
      <ValidTo>2024-12-03T18:28:29.0386741+01:00</ValidTo>
      <IdentifyingMode>1</IdentifyingMode>
      <AccessModeTitle>sample string 3</AccessModeTitle>
    </AccessPrivilige>
    <AccessPrivilige>
      <HwStructNodePath>sample string 1</HwStructNodePath>
      <OptionAccess>2</OptionAccess>
      <OptionAttendance>1</OptionAttendance>
      <ValidFrom>2024-12-03T18:28:29.0386741+01:00</ValidFrom>
      <ValidTo>2024-12-03T18:28:29.0386741+01:00</ValidTo>
      <IdentifyingMode>1</IdentifyingMode>
      <AccessModeTitle>sample string 3</AccessModeTitle>
    </AccessPrivilige>
  </AccessPriviliges>
</Request>

Response Information

Response Codes

Http CodeError NumberDescription
200 request succesfully done 0 Access priviliges for Person [{0}] stored successfully
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 1102 Application privilege Edit for licensed agenda Persons violated for person [{0}]
403 server refuses fo fulfill the request 1119 Application privilege Edit for of agenda item Access of licensed agenda Persons violated for person [{0}]
403 server refuses fo fulfill the request 1226 Record permission Access Edit of HW structure permissions violated for [{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 1300 No access mode 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

BaseRespOfPersonSetAccessPriviligesReq
NameDescriptionTypeAdditional information
Result

RequestResult

None.
Request

PersonSetAccessPriviligesReq

None.

Response Formats

application/json

Sample: 
{"Result":{"Message":"Processed with result: ExecOK","Code":0,"ModelStateErr":null},"Request":{"PersonId":"100200300","CleanOtherPriviliges":0,"AccessPriviliges":[{"HwStructNodePath":"HwStructure - 0080A3A45917 Sensor 1","OptionAccess":1,"OptionAttendance":0,"ValidFrom":"\/Date(1532901600000)\/","ValidTo":"\/Date(1564437600000)\/","IdentifyingMode":2,"AccessModeTitle":null},{"HwStructNodePath":"HwStructure - 0080A3A45917 Sensor 1","OptionAccess":1,"OptionAttendance":1,"ValidFrom":"\/Date(1564610400000)\/","ValidTo":"\/Date(1609282800000)\/","IdentifyingMode":3,"AccessModeTitle":null},{"HwStructNodePath":"HwStructure - 0080A3A45917 Sensor 2","OptionAccess":0,"OptionAttendance":0,"ValidFrom":"\/Date(1607986800000)\/","ValidTo":"\/Date(1611961200000)\/","IdentifyingMode":1,"AccessModeTitle":null}]}}

application/xml

Sample: 

<Response>
  <Result>
    <Message>Processed with result: ExecOK</Message>
    <Code>0</Code>
  </Result>
  <Request>
    <PersonId>100200300</PersonId>
    <CleanOtherPriviliges>0</CleanOtherPriviliges>
    <AccessPriviliges>
      <AccessPrivilige>
        <HwStructNodePath>HwStructure - 0080A3A45917 Sensor 1</HwStructNodePath>
        <OptionAccess>1</OptionAccess>
        <OptionAttendance>0</OptionAttendance>
        <ValidFrom>2018-07-30T00:00:00</ValidFrom>
        <ValidTo>2019-07-30T00:00:00</ValidTo>
        <IdentifyingMode>2</IdentifyingMode>
      </AccessPrivilige>
      <AccessPrivilige>
        <HwStructNodePath>HwStructure - 0080A3A45917 Sensor 1</HwStructNodePath>
        <OptionAccess>1</OptionAccess>
        <OptionAttendance>1</OptionAttendance>
        <ValidFrom>2019-08-01T00:00:00</ValidFrom>
        <ValidTo>2020-12-30T00:00:00</ValidTo>
        <IdentifyingMode>3</IdentifyingMode>
      </AccessPrivilige>
      <AccessPrivilige>
        <HwStructNodePath>HwStructure - 0080A3A45917 Sensor 2</HwStructNodePath>
        <OptionAccess>0</OptionAccess>
        <OptionAttendance>0</OptionAttendance>
        <ValidFrom>2020-12-15T00:00:00</ValidFrom>
        <ValidTo>2021-01-30T00:00:00</ValidTo>
        <IdentifyingMode>1</IdentifyingMode>
      </AccessPrivilige>
    </AccessPriviliges>
  </Request>
</Response>

text/json

Sample: 
{
  "Result": {
    "Message": "sample string 1",
    "Code": 2,
    "ModelStateErr": [
      "sample string 1",
      "sample string 2"
    ]
  },
  "Request": {
    "PersonId": "sample string 1",
    "CleanOtherPriviliges": 2,
    "AccessPriviliges": [
      {
        "HwStructNodePath": "sample string 1",
        "OptionAccess": 2,
        "OptionAttendance": 1,
        "ValidFrom": "2024-12-03T18:28:29.0386741+01:00",
        "ValidTo": "2024-12-03T18:28:29.0386741+01:00",
        "IdentifyingMode": 1,
        "AccessModeTitle": "sample string 3"
      },
      {
        "HwStructNodePath": "sample string 1",
        "OptionAccess": 2,
        "OptionAttendance": 1,
        "ValidFrom": "2024-12-03T18:28:29.0386741+01:00",
        "ValidTo": "2024-12-03T18:28:29.0386741+01:00",
        "IdentifyingMode": 1,
        "AccessModeTitle": "sample string 3"
      }
    ]
  }
}

text/xml

Sample: 
<Response xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Result>
    <Message>sample string 1</Message>
    <Code>2</Code>
    <ModelStateErr>
      <string>sample string 1</string>
      <string>sample string 2</string>
    </ModelStateErr>
  </Result>
  <Request>
    <PersonId>sample string 1</PersonId>
    <CleanOtherPriviliges>2</CleanOtherPriviliges>
    <AccessPriviliges>
      <AccessPrivilige>
        <HwStructNodePath>sample string 1</HwStructNodePath>
        <OptionAccess>2</OptionAccess>
        <OptionAttendance>1</OptionAttendance>
        <ValidFrom>2024-12-03T18:28:29.0386741+01:00</ValidFrom>
        <ValidTo>2024-12-03T18:28:29.0386741+01:00</ValidTo>
        <IdentifyingMode>1</IdentifyingMode>
        <AccessModeTitle>sample string 3</AccessModeTitle>
      </AccessPrivilige>
      <AccessPrivilige>
        <HwStructNodePath>sample string 1</HwStructNodePath>
        <OptionAccess>2</OptionAccess>
        <OptionAttendance>1</OptionAttendance>
        <ValidFrom>2024-12-03T18:28:29.0386741+01:00</ValidFrom>
        <ValidTo>2024-12-03T18:28:29.0386741+01:00</ValidTo>
        <IdentifyingMode>1</IdentifyingMode>
        <AccessModeTitle>sample string 3</AccessModeTitle>
      </AccessPrivilige>
    </AccessPriviliges>
  </Request>
</Response>