sfgboxapi

<back to all web services

AuthoriseFunction

The following routes are available for this service:
POST/authorizefunction
import java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    public static class AuthoriseFunction
    {
        @Validate(Validator="Email")
        public String eMail = null;

        @Validate(Validator="[NotNull,NotEmpty]")
        public String password = null;

        public String systemFunction = null;
        public ResponseStatus responseStatus = null;
        
        public String getEMail() { return eMail; }
        public AuthoriseFunction setEMail(String value) { this.eMail = value; return this; }
        public String getPassword() { return password; }
        public AuthoriseFunction setPassword(String value) { this.password = value; return this; }
        public String getSystemFunction() { return systemFunction; }
        public AuthoriseFunction setSystemFunction(String value) { this.systemFunction = value; return this; }
        public ResponseStatus getResponseStatus() { return responseStatus; }
        public AuthoriseFunction setResponseStatus(ResponseStatus value) { this.responseStatus = value; return this; }
    }

}

Java 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: api.sfgtec.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
		}
	}
}