DigiOffice Gateway Web Services

GetRights

Get rights for application or object

import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class RightsInformation:
    rights: Optional[Hashtable] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetRights:
    """
    Get rights for application or object
    """

    rights: Optional[List[str]] = None
    entity_name: Optional[str] = None
    id: Optional[str] = None

Python GetRights DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /xml/reply/GetRights HTTP/1.1 
Host: digiofficeapigateway.deltares.nl 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<GetRights xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IDB.API.DTO.Rights.Operations">
  <EntityName>String</EntityName>
  <ID>String</ID>
  <Rights xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </Rights>
</GetRights>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<RightsInformation xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IDB.API.DTO.Rights">
  <Rights xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" />
</RightsInformation>