| POST | /subusers/create | Create a sub user |
|---|
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 Authentication:
# @ApiMember(Description="The API User ID provided by us when you signed up to use our API", IsRequired=true, ParameterType="header, body")
api_user_id: Optional[str] = None
"""
The API User ID provided by us when you signed up to use our API
"""
# @ApiMember(Description="The API User Key provided by us when you signed up to use our API", IsRequired=true, ParameterType="header, body")
api_user_key: Optional[str] = None
"""
The API User Key provided by us when you signed up to use our API
"""
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class BaseRequest(IBaseRequest):
# @ApiMember(Description="The authentication credentials", IsRequired=true, ParameterType="header, body")
authentication: Optional[Authentication] = None
"""
The authentication credentials
"""
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ResponseError:
error_code: Optional[str] = None
field_name: Optional[str] = None
message: Optional[str] = None
meta: Optional[Dict[str, str]] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ArrayOfResponseError(List[ResponseError]):
pass
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ResponseStatus:
error_code: Optional[str] = None
message: Optional[str] = None
stack_trace: Optional[str] = None
errors: Optional[ArrayOfResponseError] = None
meta: Optional[Dict[str, str]] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class BaseResponse(IBaseDataResponse, IHasResponseStatus):
# @ApiMember(Description="The status of the response")
response_status: Optional[ResponseStatus] = None
"""
The status of the response
"""
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ArrayOfUserNames(List[str]):
pass
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SubUser:
# @ApiMember(Description="Is this user the main user (i.e. the user who created the account)")
is_main_user: bool = False
"""
Is this user the main user (i.e. the user who created the account)
"""
# @ApiMember(Description="The sub user's id (GUID)")
user_id: Optional[str] = None
"""
The sub user's id (GUID)
"""
# @ApiMember(Description="The sub user's UserName (i.e. the sign-in username)")
user_name: Optional[str] = None
"""
The sub user's UserName (i.e. the sign-in username)
"""
# @ApiMember(Description="The sub user's name")
name: Optional[str] = None
"""
The sub user's name
"""
# @ApiMember(Description="The sub user's email address")
email: Optional[str] = None
"""
The sub user's email address
"""
# @ApiMember(Description="Does this sub user have admin privileges, such as managing purchases and sub users")
is_admin: bool = False
"""
Does this sub user have admin privileges, such as managing purchases and sub users
"""
# @ApiMember(Description="Can this sub user resolve searches (UpdateSearch) they have access to")
can_resolve_searches: bool = False
"""
Can this sub user resolve searches (UpdateSearch) they have access to
"""
# @ApiMember(Description="Can this sub user delete searches (DeleteSearch) they have access to")
can_delete_searches: bool = False
"""
Can this sub user delete searches (DeleteSearch) they have access to
"""
# @ApiMember(Description="The user names for which searches will be made available to the sub user")
permissions: Optional[ArrayOfUserNames] = None
"""
The user names for which searches will be made available to the sub user
"""
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class AddSubUserData(BaseResponse):
# @ApiMember(Description="The sub user")
sub_user: Optional[SubUser] = None
"""
The sub user
"""
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class AddSubUserResponse:
# @ApiMember(Description="The response data")
data: Optional[AddSubUserData] = None
"""
The response data
"""
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class AddSubUserRequest:
user_name: Optional[str] = None
name: Optional[str] = None
email: Optional[str] = None
is_admin: bool = False
can_resolve_searches: bool = False
can_delete_searches: bool = False
send_welcome_email: bool = False
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class AddSubUser(BaseRequest):
request: Optional[AddSubUserRequest] = None
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /subusers/create HTTP/1.1
Host: api.sanctionssearch.com
Accept: application/json
Content-Type: application/json
Content-Length: length
{"request":{"userName":"String","name":"String","email":"String","isAdmin":false,"canResolveSearches":false,"canDeleteSearches":false,"sendWelcomeEmail":false},"authentication":{"apiUserId":"String","apiUserKey":"String"}}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"data":{"subUser":{"isMainUser":false,"userName":"String","name":"String","email":"String","isAdmin":false,"canResolveSearches":false,"canDeleteSearches":false,"permissions":["String"]},"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}}