sfgboxapi

<back to all web services

AuthoriseFunction

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

export class AuthoriseFunction
{
    // @Validate(Validator="Email")
    public eMail: string;

    // @Validate(Validator="[NotNull,NotEmpty]")
    public password: string;

    public systemFunction: string;
    public responseStatus: ResponseStatus;

    public constructor(init?: Partial<AuthoriseFunction>) { (Object as any).assign(this, init); }
}

TypeScript 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
		}
	}
}