DigiOffice Gateway Web Services

<back to all web services

GetQuickRegistrationOptions

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 RegistrationprofileInformation:
    id: Optional[str] = None
    name: Optional[str] = None
    wizard_automatisch_doorlopen: Optional[bool] = None


class DragDropAction(str, Enum):
    COPY_EMAIL_INCLUDING_ATTACHMENTS = 'CopyEmailIncludingAttachments'
    COPY_EMAIL_INCLUDING_AND_SEPARATE_ATTACHMENTS = 'CopyEmailIncludingAndSeparateAttachments'
    COPY_EMAIL_EXCLUDING_AND_SEPARATE_ATTACHMENTS = 'CopyEmailExcludingAndSeparateAttachments'
    COPY_EMAIL_EXCLUDING_ATTACHMENTS = 'CopyEmailExcludingAttachments'
    COPY_ONLY_ATTACHMENTS = 'CopyOnlyAttachments'
    MOVE_EMAIL_INCLUDING_ATTACHMENTS = 'MoveEmailIncludingAttachments'
    MOVE_EMAIL_INCLUDING_AND_SEPARATE_ATTACHMENTS = 'MoveEmailIncludingAndSeparateAttachments'
    MOVE_EMAIL_EXCLUDING_AND_SEPARATE_ATTACHMENTS = 'MoveEmailExcludingAndSeparateAttachments'
    MOVE_EMAIL_EXCLUDING_ATTACHMENTS = 'MoveEmailExcludingAttachments'
    MOVE_ONLY_ATTACHMENTS = 'MoveOnlyAttachments'
    FILES = 'Files'
    FILE_STREAM = 'FileStream'


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class QuickRegistrationOptions:
    prog_code: Optional[str] = None
    registration_profile_i_d: Optional[str] = None
    registration_profiles: Optional[List[RegistrationprofileInformation]] = None
    attachment_registration_profile_i_d: Optional[str] = None
    attachment_profiles: Optional[List[RegistrationprofileInformation]] = None
    registration_profile_new_email_i_d: Optional[str] = None
    e_mail_actie: Optional[str] = None
    e_mail_actie_nieuw: Optional[str] = None
    e_mail_actie_beantwoorden: Optional[str] = None
    e_mail_actie_doorsturen: Optional[str] = None
    default_drag_drop_action: Optional[DragDropAction] = None
    registratie_wizard365_u_r_l: Optional[str] = None
    application_name: Optional[str] = None
    extension: Optional[str] = None
    menu_tonen_bij_slepen: Optional[bool] = None
    allow_multiple_registrations: Optional[bool] = None
    minimum_attachment_size: Optional[int] = None
    allow_empty_email_in_registrationprofile_wizard: Optional[bool] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetQuickRegistrationOptions:
    prog_code: Optional[str] = None
    application_name: Optional[str] = None
    extension: Optional[str] = None

Python GetQuickRegistrationOptions 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/GetQuickRegistrationOptions HTTP/1.1 
Host: digiofficeapigateway.deltares.nl 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"ProgCode":"String","ApplicationName":"String","Extension":"String"}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"ProgCode":"String","RegistrationProfileID":"00000000-0000-0000-0000-000000000000","RegistrationProfiles":[{"ID":"00000000-0000-0000-0000-000000000000","Name":"String","WizardAutomatischDoorlopen":false}],"AttachmentRegistrationProfileID":"00000000-0000-0000-0000-000000000000","AttachmentProfiles":[{"ID":"00000000-0000-0000-0000-000000000000","Name":"String","WizardAutomatischDoorlopen":false}],"RegistrationProfileNewEmailID":"00000000-0000-0000-0000-000000000000","EMailActie":"String","EMailActieNieuw":"String","EMailActieBeantwoorden":"String","EMailActieDoorsturen":"String","DefaultDragDropAction":"CopyEmailIncludingAttachments","RegistratieWizard365URL":"String","ApplicationName":"String","Extension":"String","MenuTonenBijSlepen":false,"AllowMultipleRegistrations":false,"MinimumAttachmentSize":0,"AllowEmptyEmailInRegistrationprofileWizard":false}