sfgboxapi

<back to all web services

UsersDetailsAdd

Requires Authentication
The following routes are available for this service:
POST/users_details
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 UsersDetailsAddResponse:
    app_user_id: int = 0
    approved: bool = False
    identification_number: Optional[str] = None
    passport_number: Optional[str] = None
    address: Optional[str] = None
    latitude: float = 0.0
    longitude: float = 0.0
    age: int = 0
    ethnic_group: Optional[str] = None
    gender: Optional[str] = None
    is_disabled: bool = False
    document_url: Optional[str] = None
    application_date: datetime.datetime = datetime.datetime(1, 1, 1)
    approval_date: datetime.datetime = datetime.datetime(1, 1, 1)
    response_status: Optional[ResponseStatus] = None


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

    # @Validate(Validator="NotNull")
    approved: bool = False

    identification_number: Optional[str] = None
    passport_number: Optional[str] = None
    # @Validate(Validator="NotNull")
    address: Optional[str] = None

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

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

    # @Validate(Validator="NotNull")
    age: int = 0

    # @Validate(Validator="NotNull")
    ethnic_group: Optional[str] = None

    # @Validate(Validator="NotNull")
    gender: Optional[str] = None

    # @Validate(Validator="NotNull")
    is_disabled: bool = False

    document_url: Optional[str] = None
    application_date: datetime.datetime = datetime.datetime(1, 1, 1)
    approval_date: datetime.datetime = datetime.datetime(1, 1, 1)

Python UsersDetailsAdd 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 /users_details HTTP/1.1 
Host: sfgboxapi.dev.scadsoftware.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	appUserId: 0,
	approved: False,
	identificationNumber: String,
	passportNumber: String,
	address: String,
	latitude: 0,
	longitude: 0,
	age: 0,
	ethnicGroup: String,
	gender: String,
	isDisabled: False,
	documentUrl: String,
	applicationDate: 0001-01-01,
	approvalDate: 0001-01-01
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	appUserId: 0,
	approved: False,
	identificationNumber: String,
	passportNumber: String,
	address: String,
	latitude: 0,
	longitude: 0,
	age: 0,
	ethnicGroup: String,
	gender: String,
	isDisabled: False,
	documentUrl: String,
	applicationDate: 0001-01-01,
	approvalDate: 0001-01-01,
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	}
}