sfgboxapi

<back to all web services

AuthoriseFunction

The following routes are available for this service:
POST/authorizefunction
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class AuthoriseFunction:
    # @Validate(Validator="Email")
    e_mail: Optional[str] = None

    # @Validate(Validator="[NotNull,NotEmpty]")
    password: Optional[str] = None

    system_function: Optional[str] = None
    response_status: Optional[ResponseStatus] = None

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