BctNotification

<back to all web services

SendSiteOpenQueryEmail

Requires Authentication

export class EmailAddress
{
    public displayName: string;
    public address: string;

    public constructor(init?: Partial<EmailAddress>) { (Object as any).assign(this, init); }
}

export class SendSiteOpenQueryEmailResponse
{
    public responseStatus: ResponseStatus;
    public result: string;
    public subject: string;
    public toAddresses: EmailAddress[];
    public ccAddresses: EmailAddress[];
    public bccAddresses: EmailAddress[];
    public fromAddress: EmailAddress;
    public count: number;

    public constructor(init?: Partial<SendSiteOpenQueryEmailResponse>) { (Object as any).assign(this, init); }
}

export class SendSiteOpenQueryEmail implements IPost
{
    // @Validate(Validator="NotNull")
    public trialId: number;

    // @Validate(Validator="NotNull")
    public instCode: string;

    // @Validate(Validator="NotNull")
    public effectiveDate: string;

    public constructor(init?: Partial<SendSiteOpenQueryEmail>) { (Object as any).assign(this, init); }
}

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