BctNotification

<back to all web services

SendSiteOpenQueryEmail

Requires Authentication
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using BctNotification.ServiceModel.Requests.Hangfire;
using BctNotification.ServiceModel.Types;

namespace BctNotification.ServiceModel.Requests.Hangfire
{
    public partial class SendSiteOpenQueryEmail
        : IPost
    {
        [Validate("NotNull")]
        public virtual int? TrialId { get; set; }

        [Validate("NotNull")]
        public virtual string InstCode { get; set; }

        [Validate("NotNull")]
        public virtual DateTime? EffectiveDate { get; set; }
    }

    public partial class SendSiteOpenQueryEmailResponse
    {
        public SendSiteOpenQueryEmailResponse()
        {
            ToAddresses = new List<EmailAddress>{};
            CcAddresses = new List<EmailAddress>{};
            BccAddresses = new List<EmailAddress>{};
        }

        public virtual ResponseStatus ResponseStatus { get; set; }
        public virtual string Result { get; set; }
        public virtual string Subject { get; set; }
        public virtual List<EmailAddress> ToAddresses { get; set; }
        public virtual List<EmailAddress> CcAddresses { get; set; }
        public virtual List<EmailAddress> BccAddresses { get; set; }
        public virtual EmailAddress FromAddress { get; set; }
        public virtual int count { get; set; }
    }

}

namespace BctNotification.ServiceModel.Types
{
    public partial class EmailAddress
    {
        public virtual string DisplayName { get; set; }
        public virtual string Address { get; set; }
    }

}

C# 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
}