DigiOffice Gateway Web Services

<back to all web services

GetRegistrationprofileDetailsWithMessageQueue

Requires Authentication
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 Registrationprofile:
    id: Optional[str] = None
    name: Optional[str] = None
    hint: Optional[str] = None
    order: Optional[int] = None
    register_automatically: Optional[bool] = None
    register_in_background: Optional[bool] = None
    thumbnail_url: Optional[str] = None
    prog_code: Optional[str] = None
    version_control_type: Optional[int] = None
    wo_place_logo: Optional[int] = None
    wo_printer_bins: Optional[str] = None
    select_all_files: Optional[bool] = None


class RegistrationprofileStepLayout(str, Enum):
    ONE_COLUMN_12 = 'OneColumn_12'
    TWO_COLUMN_6_6 = 'TwoColumn_6_6'
    TWO_COLUMN_7_5 = 'TwoColumn_7_5'
    THREE_COLUMN_4_4_4 = 'ThreeColumn_4_4_4'


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class RegistrationProfileFieldStateBase:
    document_field_i_d: Optional[str] = None
    required: Optional[bool] = None
    visible: Optional[bool] = None
    readonly: Optional[bool] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class RegistrationprofileField:
    id: Optional[str] = None
    document_field_i_d: Optional[str] = None
    label: Optional[str] = None
    user_control_type: Optional[str] = None
    user_control_properties: Optional[List[SerializableKeyValuePair[str, Object]]] = None
    hint: Optional[str] = None
    order: Optional[int] = None
    has_dependable_fields: Optional[bool] = None
    entity_name: Optional[str] = None
    state: Optional[RegistrationProfileFieldStateBase] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class RegistrationprofileGroup:
    id: Optional[str] = None
    name: Optional[str] = None
    label: Optional[str] = None
    order: Optional[int] = None
    column_index: Optional[int] = None
    fields: Optional[List[RegistrationprofileField]] = None
    label_layout_type: Optional[int] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class RegistrationprofileStep:
    id: Optional[str] = None
    name: Optional[str] = None
    order: Optional[int] = None
    layout: Optional[RegistrationprofileStepLayout] = None
    groups: Optional[List[RegistrationprofileGroup]] = None


class MessageType(IntEnum):
    INFORMATION = 1
    WARNING = 2
    ERROR = 3
    SUCCESS = 4


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class InformationMessageBase(IInformationMessage):
    type: Optional[MessageType] = None
    summary: Optional[str] = None
    full_message: Optional[str] = None
    field_name: Optional[str] = None
    keep_open: Optional[bool] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class RegistrationprofileDetails(Registrationprofile):
    steps: Optional[List[RegistrationprofileStep]] = None
    messages: Optional[List[InformationMessageBase]] = None
    read_only: Optional[bool] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetRegistrationprofileDetailsWithMessageQueue:
    id: Optional[str] = None
    message_queue_id: Optional[int] = None
    is_office365_context: Optional[bool] = None

Python GetRegistrationprofileDetailsWithMessageQueue DTOs

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

HTTP + CSV

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

POST /csv/reply/GetRegistrationprofileDetailsWithMessageQueue HTTP/1.1 
Host: digiofficeapigateway.deltares.nl 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"ID":"00000000-0000-0000-0000-000000000000","MessageQueueId":0,"IsOffice365Context":false}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"Steps":[{"ID":"00000000-0000-0000-0000-000000000000","Name":"String","Order":0,"Layout":"OneColumn_12","Groups":[{"ID":"00000000-0000-0000-0000-000000000000","Name":"String","Label":"String","Order":0,"ColumnIndex":0,"Fields":[{"ID":"00000000-0000-0000-0000-000000000000","DocumentFieldID":"00000000-0000-0000-0000-000000000000","Label":"String","UserControlType":"String","UserControlProperties":[{}],"Hint":"String","Order":0,"HasDependableFields":false,"EntityName":"String","State":{"DocumentFieldID":"00000000-0000-0000-0000-000000000000","Required":false,"Visible":false,"Readonly":false}}],"LabelLayoutType":0}]}],"Messages":[{}],"ReadOnly":false,"ID":"00000000-0000-0000-0000-000000000000","Name":"String","Hint":"String","Order":0,"RegisterAutomatically":false,"RegisterInBackground":false,"ThumbnailUrl":"String","ProgCode":"String","VersionControlType":0,"WOPlaceLogo":0,"WOPrinterBins":"String","SelectAllFiles":false}