| POST | /organisations/{Id}/blocklist |
|---|
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
TResponse = TypeVar('TResponse')
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class PostOperationUnTenanted(Generic[TResponse], IReturn[TResponse], IPost):
@staticmethod
def response_type(): return TResponse
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class OrganisationNotificationSettings(IIdentifiableResource):
warning_notification_roles: Optional[List[str]] = None
job_finished_notification_roles: Optional[List[str]] = None
user_id_block_list: Optional[List[str]] = None
id: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class BlockListResponse:
response_status: Optional[ResponseStatus] = None
notification_settings: Optional[OrganisationNotificationSettings] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class AddUserToBlockListRequest(PostOperationUnTenanted[BlockListResponse]):
id: Optional[str] = None
user_id: Optional[str] = None
Python AddUserToBlockListRequest 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.
POST /organisations/{Id}/blocklist HTTP/1.1
Host: staging-api.foundrylab.com
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
id: String,
userId: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
responseStatus:
{
errorCode: String,
message: String,
stackTrace: String,
errors:
[
{
errorCode: String,
fieldName: String,
message: String,
meta:
{
String: String
}
}
],
meta:
{
String: String
}
},
notificationSettings:
{
warningNotificationRoles:
[
String
],
jobFinishedNotificationRoles:
[
String
],
userIdBlockList:
[
String
],
id: String
}
}