BctNotification

<back to all web services

SendSiteOpenQueryEmail

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

Namespace Global

    Namespace BctNotification.ServiceModel.Requests.Hangfire

        Public Partial Class SendSiteOpenQueryEmail
            Implements IPost
            <Validate(Validator:="NotNull")>
            Public Overridable Property TrialId As Nullable(Of Integer)

            <Validate(Validator:="NotNull")>
            Public Overridable Property InstCode As String

            <Validate(Validator:="NotNull")>
            Public Overridable Property EffectiveDate As Nullable(Of Date)
        End Class

        Public Partial Class SendSiteOpenQueryEmailResponse
            Public Sub New()
                ToAddresses = New List(Of EmailAddress)
                CcAddresses = New List(Of EmailAddress)
                BccAddresses = New List(Of EmailAddress)
            End Sub

            Public Overridable Property ResponseStatus As ResponseStatus
            Public Overridable Property Result As String
            Public Overridable Property Subject As String
            Public Overridable Property ToAddresses As List(Of EmailAddress)
            Public Overridable Property CcAddresses As List(Of EmailAddress)
            Public Overridable Property BccAddresses As List(Of EmailAddress)
            Public Overridable Property FromAddress As EmailAddress
            Public Overridable Property count As Integer
        End Class
    End Namespace

    Namespace BctNotification.ServiceModel.Types

        Public Partial Class EmailAddress
            Public Overridable Property DisplayName As String
            Public Overridable Property Address As String
        End Class
    End Namespace
End Namespace

VB.NET SendSiteOpenQueryEmail DTOs

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

HTTP + X-MSGPACK

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

POST /x-msgpack/reply/SendSiteOpenQueryEmail HTTP/1.1 
Host: notifications.breastcancertrials.org.au 
Accept: application/x-msgpack
Content-Type: application/x-msgpack
Content-Length: length

{"trialId":0,"instCode":"String","effectiveDate":"0001-01-01T00:00:00.0000000"}
HTTP/1.1 200 OK
Content-Type: application/x-msgpack
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}