Tax Filing Service
| Required role: | Admin | Required permissions: | CanAccess, CanEdit |
| PUT | /async/accounts/{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
# @Api(Description="Specifies a service request from an admin user to update an account.")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class AdminUpdateAccountBase(IReturn[AccountResponse], IPut):
"""
Specifies a service request from an admin user to update an account.
"""
# @ApiMember(Description="The unique identifier of the user account.", IsRequired=true)
id: int = 0
"""
The unique identifier of the user account.
"""
# @ApiMember(Description="The user name of the user account.")
user_name: Optional[str] = None
"""
The user name of the user account.
"""
# @ApiMember(Description="The display name of the user account.")
display_name: Optional[str] = None
"""
The display name of the user account.
"""
# @ApiMember(Description="The e-mail address of the user account.")
email: Optional[str] = None
"""
The e-mail address of the user account.
"""
profile_url: Optional[str] = None
# @ApiMember(Description="The roles of the user account.")
roles: Optional[List[str]] = None
"""
The roles of the user account.
"""
# @ApiMember(Description="The roles of the user account.")
permissions: Optional[List[str]] = None
"""
The roles of the user account.
"""
# @ApiMember(Description="Extra information for the user account.")
meta: Optional[Dict[str, str]] = None
"""
Extra information for the user account.
"""
@staticmethod
def response_type(): return AccountResponse
# @Api(Description="Specifies a base service response class that contains a structured error information.")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ServiceResponseBase:
"""
Specifies a base service response class that contains a structured error information.
"""
# @ApiMember(Description="Data structure that holds error information from a service operation.")
response_status: Optional[ResponseStatus] = None
"""
Data structure that holds error information from a service operation.
"""
# @Api(Description="Represents a user account.")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Account(IHasUserName):
"""
Represents a user account.
"""
# @ApiMember(Description="The unique identifier of the user account.", IsRequired=true)
id: int = 0
"""
The unique identifier of the user account.
"""
# @ApiMember(Description="The position of this instance in a collection of 'Account' instances", IsRequired=true)
index: int = 0
"""
The position of this instance in a collection of 'Account' instances
"""
# @ApiMember(Description="The unique identifier of the customer associated with this account.", IsRequired=true)
ref_id: Optional[int] = None
"""
The unique identifier of the customer associated with this account.
"""
# @ApiMember(Description="The string representation of the unique identifier of a reference that associates with this user account. This should have the same value as 'RefId'.")
ref_id_str: Optional[str] = None
"""
The string representation of the unique identifier of a reference that associates with this user account. This should have the same value as 'RefId'.
"""
# @ApiMember(Description="The unique user name of the user account.", IsRequired=true)
user_name: Optional[str] = None
"""
The unique user name of the user account.
"""
# @ApiMember(Description="The electronic mail address of the user account.")
email: Optional[str] = None
"""
The electronic mail address of the user account.
"""
# @ApiMember(Description="The friendly name of the user account.")
display_name: Optional[str] = None
"""
The friendly name of the user account.
"""
# @ApiMember(Description="The first name of the owner (natural person) of the user account.")
first_name: Optional[str] = None
"""
The first name of the owner (natural person) of the user account.
"""
# @ApiMember(Description="The last name of the owner (natural person) of the user account.")
last_name: Optional[str] = None
"""
The last name of the owner (natural person) of the user account.
"""
# @ApiMember(Description="The unique identifier of the customer associated with this account.")
full_name: Optional[str] = None
"""
The unique identifier of the customer associated with this account.
"""
# @ApiMember(Description="The gender of the owner (natural person) of the user account.")
gender: Optional[str] = None
"""
The gender of the owner (natural person) of the user account.
"""
# @ApiMember(Description="The language of the owner of teh user account.")
language: Optional[str] = None
"""
The language of the owner of teh user account.
"""
# @ApiMember(Description="The company, where the user is an employee.")
company: Optional[str] = None
"""
The company, where the user is an employee.
"""
# @ApiMember(Description="The profile URL of the user account.", IsRequired=true)
profile_url: Optional[str] = None
"""
The profile URL of the user account.
"""
# @ApiMember(Description="The roles assigned to the user account.")
roles: Optional[List[str]] = None
"""
The roles assigned to the user account.
"""
# @ApiMember(Description="The permissions assigned to the user account.")
permissions: Optional[List[str]] = None
"""
The permissions assigned to the user account.
"""
# @ApiMember(Description="The primary e-mail address of the user.")
primary_email: Optional[str] = None
"""
The primary e-mail address of the user.
"""
# @ApiMember(Description="Random data to enhance the security of the user password.")
salt: Optional[str] = None
"""
Random data to enhance the security of the user password.
"""
# @ApiMember(Description="The hash value of the user password that the PBKDF2 algorithm produces.")
password_hash: Optional[str] = None
"""
The hash value of the user password that the PBKDF2 algorithm produces.
"""
# @ApiMember(Description="The hash value of the user password that the DigestHa1 algorithm produces.")
digest_ha1_hash: Optional[str] = None
"""
The hash value of the user password that the DigestHa1 algorithm produces.
"""
# @ApiMember(Description="The number of times the user account tried to sign in but failed.")
invalid_login_attempts: int = 0
"""
The number of times the user account tried to sign in but failed.
"""
# @ApiMember(Description="The last time the user account attempted a sign in.")
last_login_attempt: Optional[datetime.datetime] = None
"""
The last time the user account attempted a sign in.
"""
# @ApiMember(Description="The date and time when the user acount was denied access.")
locked_date: Optional[datetime.datetime] = None
"""
The date and time when the user acount was denied access.
"""
# @ApiMember(Description="The date and time when the user account was created.")
created_date: datetime.datetime = datetime.datetime(1, 1, 1)
"""
The date and time when the user account was created.
"""
# @ApiMember(Description="The date and time when the user account was last modified.")
modified_date: datetime.datetime = datetime.datetime(1, 1, 1)
"""
The date and time when the user account was last modified.
"""
# @ApiMember(Description="The telephone number of the owner of the user account.")
phone_number: Optional[str] = None
"""
The telephone number of the owner of the user account.
"""
# @ApiMember(Description="The birth date of the owner of the user account")
birth_date: Optional[datetime.datetime] = None
"""
The birth date of the owner of the user account
"""
# @ApiMember(Description="The string representation of the birth date of the user account.")
birth_date_raw: Optional[str] = None
"""
The string representation of the birth date of the user account.
"""
# @ApiMember(Description="The mail address of the user account.")
address: Optional[str] = None
"""
The mail address of the user account.
"""
# @ApiMember(Description="Additional information for the specified 'Address' of the user.")
address2: Optional[str] = None
"""
Additional information for the specified 'Address' of the user.
"""
# @ApiMember(Description="The city of the owner of the user account.")
city: Optional[str] = None
"""
The city of the owner of the user account.
"""
# @ApiMember(Description="The state of the owner of the user account.")
state: Optional[str] = None
"""
The state of the owner of the user account.
"""
# @ApiMember(Description="The country of the owner of the user account. It is recommended to use the name of the associated 'Customer'.")
country: Optional[str] = None
"""
The country of the owner of the user account. It is recommended to use the name of the associated 'Customer'.
"""
# @ApiMember(Description="The locale of the user account.")
culture: Optional[str] = None
"""
The locale of the user account.
"""
# @ApiMember(Description="The mail address of the user account.")
mail_address: Optional[str] = None
"""
The mail address of the user account.
"""
# @ApiMember(Description="The nickname of the user of the user account.")
nickname: Optional[str] = None
"""
The nickname of the user of the user account.
"""
# @ApiMember(Description="The postal code of the user account.")
postal_code: Optional[str] = None
"""
The postal code of the user account.
"""
# @ApiMember(Description="The time zone of the user of the user account.")
time_zone: Optional[str] = None
"""
The time zone of the user of the user account.
"""
# @ApiMember(Description="Additional information to attach to the user account.")
meta: Optional[Dict[str, str]] = None
"""
Additional information to attach to the user account.
"""
# @Api(Description="Represents a product.")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Product(IHasName):
"""
Represents a product.
"""
# @ApiMember(Description="The unique identifier of the product.", IsRequired=true)
id: int = 0
"""
The unique identifier of the product.
"""
# @ApiMember(Description="The position of this instance in a collection of 'Product' instances", IsRequired=true)
index: int = 0
"""
The position of this instance in a collection of 'Product' instances
"""
# @ApiMember(Description="The name of the product.", IsRequired=true)
# @Validate(Validator="NotEmpty")
name: Optional[str] = None
"""
The name of the product.
"""
# @ApiMember(Description="The version of the product.", IsRequired=true)
# @Validate(Validator="NotEmpty")
version: Optional[str] = None
"""
The version of the product.
"""
# @ApiMember(Description="The version of the product.")
description: Optional[str] = None
"""
The version of the product.
"""
# @ApiMember(Description="Tags associated with the product.")
tags: Optional[List[str]] = None
"""
Tags associated with the product.
"""
# @Api(Description="Represents a commission to consume services.")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Order(IHasName):
"""
Represents a commission to consume services.
"""
# @ApiMember(Description="The unique identifier of the order.", IsRequired=true)
id: int = 0
"""
The unique identifier of the order.
"""
# @ApiMember(Description="The unique identifier of the product, for which the order is made.", IsRequired=true)
product_id: int = 0
"""
The unique identifier of the product, for which the order is made.
"""
# @ApiMember(Description="The unique identifier of the user account, who placed the order.", IsRequired=true)
account_id: int = 0
"""
The unique identifier of the user account, who placed the order.
"""
# @ApiMember(Description="A name to identify the order.", IsRequired=true)
# @Validate(Validator="NotEmpty")
name: Optional[str] = None
"""
A name to identify the order.
"""
# @ApiMember(Description="The name of the service, for which the order was made.")
service_name: Optional[str] = None
"""
The name of the service, for which the order was made.
"""
# @ApiMember(Description="The time stamp at which the order was initiated.")
request_timestamp: Optional[datetime.datetime] = None
"""
The time stamp at which the order was initiated.
"""
# @ApiMember(Description="The time stamp at which the order was completed.")
response_timestamp: Optional[datetime.datetime] = None
"""
The time stamp at which the order was completed.
"""
# @ApiMember(Description="The URI from which the order was initiated.")
request_uri: Optional[str] = None
"""
The URI from which the order was initiated.
"""
# @ApiMember(Description="The HTTP method of the order request.")
request_http_method: Optional[str] = None
"""
The HTTP method of the order request.
"""
# @ApiMember(Description="The duration of the order request.")
request_duration: Optional[datetime.timedelta] = None
"""
The duration of the order request.
"""
# @ApiMember(Description="The HTTP status code of the order request.")
response_status_code: Optional[HttpStatusCode] = None
"""
The HTTP status code of the order request.
"""
# @ApiMember(Description="The IP address of client, who placed the order.")
client_i_p_address: Optional[str] = None
"""
The IP address of client, who placed the order.
"""
# @ApiMember(Description="The unit of measurement for the order.")
unit_of_measurement: Optional[str] = None
"""
The unit of measurement for the order.
"""
# @ApiMember(Description="The type of process, for which the order is charged.")
process_type: Optional[str] = None
"""
The type of process, for which the order is charged.
"""
# @ApiMember(Description="The type of data, for which the order is charged.")
data_type: Optional[str] = None
"""
The type of data, for which the order is charged.
"""
# @ApiMember(Description="The name of the data, for which the order is charged.")
data_name: Optional[str] = None
"""
The name of the data, for which the order is charged.
"""
# @ApiMember(Description="The date of creation of the order.")
creation_date: datetime.datetime = datetime.datetime(1, 1, 1)
"""
The date of creation of the order.
"""
# @ApiMember(Description="The final date to retain the order in the records. After this date, the order is expunged from the records.")
expiry_date: Optional[datetime.datetime] = None
"""
The final date to retain the order in the records. After this date, the order is expunged from the records.
"""
# @ApiMember(Description="Indicates whether the order is simulated for test purposes. True if the order is simulated for test purposes; otherwise it is a false order for production purposes.")
is_test: bool = False
"""
Indicates whether the order is simulated for test purposes. True if the order is simulated for test purposes; otherwise it is a false order for production purposes.
"""
# @Api(Description="Represents a service response that contains a structured error information and encapsulates a user account.")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class AccountResponse(ServiceResponseBase):
"""
Represents a service response that contains a structured error information and encapsulates a user account.
"""
# @ApiMember(Description="The user account encapsulated in the response.")
account: Optional[Account] = None
"""
The user account encapsulated in the response.
"""
# @ApiMember(Description="The index position of the reponse in a collection, if it were returned together with other responses.")
index: int = 0
"""
The index position of the reponse in a collection, if it were returned together with other responses.
"""
# @ApiMember(Description="The list of products associated with the encapsulated user account.")
products: Optional[List[Product]] = None
"""
The list of products associated with the encapsulated user account.
"""
# @ApiMember(Description="The list of orders associated with the encapsulated user account.")
orders: Optional[List[Order]] = None
"""
The list of orders associated with the encapsulated user account.
"""
# @ApiMember(Description="Data structure that holds error information from a service operation.")
response_status: Optional[ResponseStatus] = None
"""
Data structure that holds error information from a service operation.
"""
# @Api(Description="Represents a service request from an admin user to update an account in an asynchronous operation.")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class AdminUpdateAccountAsync(AdminUpdateAccountBase):
"""
Represents a service request from an admin user to update an account in an asynchronous operation.
"""
# @ApiMember(Description="The unique identifier of the user account.", IsRequired=true)
id: int = 0
"""
The unique identifier of the user account.
"""
# @ApiMember(Description="The user name of the user account.")
user_name: Optional[str] = None
"""
The user name of the user account.
"""
# @ApiMember(Description="The display name of the user account.")
display_name: Optional[str] = None
"""
The display name of the user account.
"""
# @ApiMember(Description="The e-mail address of the user account.")
email: Optional[str] = None
"""
The e-mail address of the user account.
"""
profile_url: Optional[str] = None
# @ApiMember(Description="The roles of the user account.")
roles: Optional[List[str]] = None
"""
The roles of the user account.
"""
# @ApiMember(Description="The roles of the user account.")
permissions: Optional[List[str]] = None
"""
The roles of the user account.
"""
# @ApiMember(Description="Extra information for the user account.")
meta: Optional[Dict[str, str]] = None
"""
Extra information for the user account.
"""
Python AdminUpdateAccountAsync DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
PUT /async/accounts/{Id} HTTP/1.1
Host: taxfiling.pwc.de
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
id: 0,
userName: String,
displayName: String,
email: String,
profileUrl: String,
roles:
[
String
],
permissions:
[
String
],
meta:
{
String: String
}
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
account:
{
id: 0,
index: 0,
refId: 0,
refIdStr: String,
userName: String,
email: String,
displayName: String,
firstName: String,
lastName: String,
fullName: String,
gender: String,
language: String,
company: String,
profileUrl: String,
roles:
[
String
],
permissions:
[
String
],
primaryEmail: String,
salt: String,
passwordHash: String,
digestHa1Hash: String,
invalidLoginAttempts: 0,
lastLoginAttempt: 0001-01-01,
lockedDate: 0001-01-01,
createdDate: 0001-01-01,
modifiedDate: 0001-01-01,
phoneNumber: String,
birthDate: 0001-01-01,
birthDateRaw: String,
address: String,
address2: String,
city: String,
state: String,
country: String,
culture: String,
mailAddress: String,
nickname: String,
postalCode: String,
timeZone: String,
meta:
{
String: String
}
},
index: 0,
products:
[
{
id: 0,
index: 0,
name: String,
version: String,
description: String,
tags:
[
String
]
}
],
orders:
[
{
id: 0,
productId: 0,
accountId: 0,
name: String,
serviceName: String,
requestTimestamp: 0001-01-01,
responseTimestamp: 0001-01-01,
requestUri: String,
requestHttpMethod: String,
requestDuration: PT0S,
responseStatusCode: Continue,
clientIPAddress: String,
unitOfMeasurement: String,
processType: String,
dataType: String,
dataName: String,
creationDate: 0001-01-01,
expiryDate: 0001-01-01,
isTest: False
}
],
responseStatus:
{
errorCode: String,
message: String,
stackTrace: String,
errors:
[
{
errorCode: String,
fieldName: String,
message: String,
meta:
{
String: String
}
}
],
meta:
{
String: String
}
}
}