DigiOffice Gateway Web Services

<back to all web services

AddMessageQueueWithSendDocumentByEmail

Requires Authentication
The following routes are available for this service:
POST/api/messagequeue/senddocumentbyemail
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 AddMessageQueueResonse:
    id: Optional[int] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class AddMessageQueueWithSendDocumentByEmail:
    from_prog_code: Optional[str] = None
    document_i_d: Optional[str] = None
    take_over_email_addresses: Optional[bool] = None
    shipping_form_i_d: Optional[int] = None
    linked_document_i_ds: Optional[List[str]] = None

Python AddMessageQueueWithSendDocumentByEmail DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

POST /api/messagequeue/senddocumentbyemail HTTP/1.1 
Host: digiofficeapigateway.deltares.nl 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"FromProgCode":"String","DocumentID":"00000000-0000-0000-0000-000000000000","TakeOverEmailAddresses":false,"ShippingFormID":0,"LinkedDocumentIDs":["String"]}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"ID":0}