sfgboxapi

<back to all web services

LicensesAdd

Requires Authentication
The following routes are available for this service:
POST/licenses
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 LicensesAddResponse:
    app_user_id: int = 0
    from_date: datetime.datetime = datetime.datetime(1, 1, 1)
    to_date: datetime.datetime = datetime.datetime(1, 1, 1)
    paid_amount: float = 0.0
    paid_date: datetime.datetime = datetime.datetime(1, 1, 1)
    response_status: Optional[ResponseStatus] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class LicensesAdd:
    # @Validate(Validator="NotNull")
    app_user_id: int = 0

    # @Validate(Validator="NotNull")
    from_date: datetime.datetime = datetime.datetime(1, 1, 1)

    # @Validate(Validator="NotNull")
    to_date: datetime.datetime = datetime.datetime(1, 1, 1)

    # @Validate(Validator="NotNull")
    paid_amount: float = 0.0

    # @Validate(Validator="NotNull")
    paid_date: datetime.datetime = datetime.datetime(1, 1, 1)

Python LicensesAdd 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 /licenses HTTP/1.1 
Host: api.sfgtec.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	appUserId: 0,
	fromDate: 0001-01-01,
	toDate: 0001-01-01,
	paidAmount: 0,
	paidDate: 0001-01-01
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	appUserId: 0,
	fromDate: 0001-01-01,
	toDate: 0001-01-01,
	paidAmount: 0,
	paidDate: 0001-01-01,
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	}
}