BctNotification

<back to all web services

SendSiteOpenQueryEmail

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 EmailAddress:
    display_name: Optional[str] = None
    address: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SendSiteOpenQueryEmailResponse:
    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
    count: int = 0


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SendSiteOpenQueryEmail(IPost):
    # @Validate(Validator="NotNull")
    trial_id: Optional[int] = None

    # @Validate(Validator="NotNull")
    inst_code: Optional[str] = None

    # @Validate(Validator="NotNull")
    effective_date: Optional[datetime.datetime] = None

Python SendSiteOpenQueryEmail DTOs

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

HTTP + JSV

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

POST /jsv/reply/SendSiteOpenQueryEmail HTTP/1.1 
Host: notifications.breastcancertrials.org.au 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	trialId: 0,
	instCode: String,
	effectiveDate: "0001-01-01T00:00:00.0000000"
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	},
	result: String,
	subject: String,
	toAddresses: 
	[
		{
			displayName: String,
			address: String
		}
	],
	ccAddresses: 
	[
		{
			displayName: String,
			address: String
		}
	],
	bccAddresses: 
	[
		{
			displayName: String,
			address: String
		}
	],
	fromAddress: 
	{
		displayName: String,
		address: String
	},
	count: 0
}