BctNotification

<back to all web services

SendSiteOpenQueryEmail

Requires Authentication
"use strict";
export class EmailAddress {
    /** @param {{displayName?:string,address?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    displayName;
    /** @type {string} */
    address;
}
export class SendSiteOpenQueryEmailResponse {
    /** @param {{responseStatus?:ResponseStatus,result?:string,subject?:string,toAddresses?:EmailAddress[],ccAddresses?:EmailAddress[],bccAddresses?:EmailAddress[],fromAddress?:EmailAddress,count?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    responseStatus;
    /** @type {string} */
    result;
    /** @type {string} */
    subject;
    /** @type {EmailAddress[]} */
    toAddresses;
    /** @type {EmailAddress[]} */
    ccAddresses;
    /** @type {EmailAddress[]} */
    bccAddresses;
    /** @type {EmailAddress} */
    fromAddress;
    /** @type {number} */
    count;
}
export class SendSiteOpenQueryEmail {
    /** @param {{trialId?:number,instCode?:string,effectiveDate?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    trialId;
    /** @type {string} */
    instCode;
    /** @type {string} */
    effectiveDate;
}

JavaScript 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
}