BctNotification

GetApiKeys

auth

The following routes are available for this service:
All Verbs	/apikeys
All Verbs	/apikeys/{Environment}

Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations

Namespace Global

    Namespace ServiceStack

        <DataContract>
        Public Partial Class GetApiKeys
            Implements IGet
            Implements IMeta
            Public Sub New()
                Meta = New Dictionary(Of String, String)
            End Sub

            <DataMember(Order:=1)>
            Public Overridable Property Environment As String

            <DataMember(Order:=2)>
            Public Overridable Property Meta As Dictionary(Of String, String)
        End Class

        <DataContract>
        Public Partial Class GetApiKeysResponse
            Implements IMeta
            Public Sub New()
                Results = New List(Of UserApiKey)
                Meta = New Dictionary(Of String, String)
            End Sub

            <DataMember(Order:=1)>
            Public Overridable Property Results As List(Of UserApiKey)

            <DataMember(Order:=2)>
            Public Overridable Property Meta As Dictionary(Of String, String)

            <DataMember(Order:=3)>
            Public Overridable Property ResponseStatus As ResponseStatus
        End Class

        <DataContract>
        Public Partial Class UserApiKey
            Implements IMeta
            Public Sub New()
                Meta = New Dictionary(Of String, String)
            End Sub

            <DataMember(Order:=1)>
            Public Overridable Property Key As String

            <DataMember(Order:=2)>
            Public Overridable Property KeyType As String

            <DataMember(Order:=3)>
            Public Overridable Property ExpiryDate As Nullable(Of Date)

            <DataMember(Order:=4)>
            Public Overridable Property Meta As Dictionary(Of String, String)
        End Class
    End Namespace
End Namespace

VB.NET GetApiKeys 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 /apikeys HTTP/1.1 
Host: notifications.breastcancertrials.org.au 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	environment: String,
	meta: 
	{
		String: String
	}
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	results: 
	[
		{
			key: String,
			keyType: String,
			expiryDate: "0001-01-01T00:00:00.0000000",
			meta: 
			{
				String: String
			}
		}
	],
	meta: 
	{
		String: String
	},
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	}
}