sfgboxapi

AuthoriseFunction

The following routes are available for this service:
POST	/authorizefunction

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

Namespace Global

    Namespace sfgboxapi.ServiceModel

        Public Partial Class AuthoriseFunction
            <Validate(Validator:="Email")>
            Public Overridable Property EMail As String

            <Validate(Validator:="[NotNull,NotEmpty]")>
            Public Overridable Property Password As String

            Public Overridable Property SystemFunction As String
            Public Overridable Property ResponseStatus As ResponseStatus
        End Class
    End Namespace
End Namespace

VB.NET AuthoriseFunction 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 /authorizefunction HTTP/1.1 
Host: sfgboxapi.dev.scadsoftware.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	eMail: String,
	password: String,
	systemFunction: String,
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	}
}