sfgboxapi

<back to all web services

AuthoriseFunction

The following routes are available for this service:
POST/authorizefunction
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using sfgboxapi.ServiceModel;

namespace sfgboxapi.ServiceModel
{
    public partial class AuthoriseFunction
    {
        [Validate("Email")]
        public virtual string EMail { get; set; }

        [Validate("[NotNull,NotEmpty]")]
        public virtual string Password { get; set; }

        public virtual string SystemFunction { get; set; }
        public virtual ResponseStatus ResponseStatus { get; set; }
    }

}

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