sfgboxapi

<back to all web services

UsersDetailsEdit

Requires Authentication
The following routes are available for this service:
PUT/users_details/{Id}
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 UsersDetailsEditResponse:
    id: int = 0
    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 UsersDetailsEdit:
    # @Validate(Validator="NotNull")
    id: int = 0

    # @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

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

    application_date: datetime.datetime = datetime.datetime(1, 1, 1)
    approval_date: datetime.datetime = datetime.datetime(1, 1, 1)

Python UsersDetailsEdit DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

PUT /users_details/{Id} HTTP/1.1 
Host: sfgboxapi.dev.scadsoftware.com 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"id":0,"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":"\/Date(-62135596800000-0000)\/","approvalDate":"\/Date(-62135596800000-0000)\/"}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"id":0,"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":"\/Date(-62135596800000-0000)\/","approvalDate":"\/Date(-62135596800000-0000)\/","responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}