BctNotification

<back to all web services

SendIncompleteResubmittableFormEmail

OpenClinica
Requires Authentication
The following routes are available for this service:
POST/notification/send-incomplete-resubmittable-form-email/
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 EmailAddress:
    display_name: Optional[str] = None
    address: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SendIncompleteResubmittableFormEmailResponse:
    incomplete_resubmittab_form_count: Optional[int] = None
    response_status: Optional[ResponseStatus] = None
    result: Optional[str] = None
    subject: Optional[str] = None
    to_addresses: Optional[List[EmailAddress]] = None
    cc_addresses: Optional[List[EmailAddress]] = None
    bcc_addresses: Optional[List[EmailAddress]] = None
    from_address: Optional[EmailAddress] = None


# @ApiResponse(Description="Unauthorized.", StatusCode=401)
# @ApiResponse(Description="Forbidden.", StatusCode=403)
# @ApiResponse(Description="Bad Request.", StatusCode=400)
# @ApiResponse(Description="Internal Server Error.", StatusCode=500)
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SendIncompleteResubmittableFormEmail:
    pass

Python SendIncompleteResubmittableFormEmail 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 /notification/send-incomplete-resubmittable-form-email/ HTTP/1.1 
Host: notifications.breastcancertrials.org.au 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<SendIncompleteResubmittableFormEmail xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BctNotification.ServiceModel.Requests.Hangfire" />
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<SendIncompleteResubmittableFormEmailResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BctNotification.ServiceModel.Requests.Hangfire">
  <BccAddresses xmlns:d2p1="http://schemas.datacontract.org/2004/07/BctNotification.ServiceModel.Types">
    <d2p1:EmailAddress>
      <d2p1:Address>String</d2p1:Address>
      <d2p1:DisplayName>String</d2p1:DisplayName>
    </d2p1:EmailAddress>
  </BccAddresses>
  <CcAddresses xmlns:d2p1="http://schemas.datacontract.org/2004/07/BctNotification.ServiceModel.Types">
    <d2p1:EmailAddress>
      <d2p1:Address>String</d2p1:Address>
      <d2p1:DisplayName>String</d2p1:DisplayName>
    </d2p1:EmailAddress>
  </CcAddresses>
  <FromAddress xmlns:d2p1="http://schemas.datacontract.org/2004/07/BctNotification.ServiceModel.Types">
    <d2p1:Address>String</d2p1:Address>
    <d2p1:DisplayName>String</d2p1:DisplayName>
  </FromAddress>
  <IncompleteResubmittabFormCount>0</IncompleteResubmittabFormCount>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <Result>String</Result>
  <Subject>String</Subject>
  <ToAddresses xmlns:d2p1="http://schemas.datacontract.org/2004/07/BctNotification.ServiceModel.Types">
    <d2p1:EmailAddress>
      <d2p1:Address>String</d2p1:Address>
      <d2p1:DisplayName>String</d2p1:DisplayName>
    </d2p1:EmailAddress>
  </ToAddresses>
</SendIncompleteResubmittableFormEmailResponse>