Sanctions Search API: v2

<back to all web services

UpdateSubUser

Account
The following routes are available for this service:
PUT/subusers/updateUpdate 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 UpdateSubUserData(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 UpdateSubUserResponse:
    # @ApiMember(Description="The response data")
    data: Optional[UpdateSubUserData] = None
    """
    The response data
    """


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ArrayOfString(List[str]):
    pass


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class UpdateSubUserRequest:
    # @ApiMember(Description="The user name of the sub user", IsRequired=true)
    sub_user_name: Optional[str] = None
    """
    The user name of the sub user
    """


    # @ApiMember(Description="The user names for which searches will be made available to the sub user")
    permissions: Optional[ArrayOfString] = 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 UpdateSubUser(BaseRequest):
    request: Optional[UpdateSubUserRequest] = None

Python UpdateSubUser DTOs

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

HTTP + XML

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

PUT /subusers/update HTTP/1.1 
Host: api.sanctionssearch.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<UpdateSubUser xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
  <Authentication>
    <ApiUserId>String</ApiUserId>
    <ApiUserKey>String</ApiUserKey>
  </Authentication>
  <Request>
    <Permissions>
      <String>String</String>
    </Permissions>
    <SubUserName>String</SubUserName>
  </Request>
</UpdateSubUser>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<UpdateSubUserResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
  <Data>
    <ResponseStatus>
      <ErrorCode>String</ErrorCode>
      <Message>String</Message>
      <StackTrace>String</StackTrace>
      <Errors>
        <ResponseError>
          <ErrorCode>String</ErrorCode>
          <FieldName>String</FieldName>
          <Message>String</Message>
          <Meta xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:KeyValueOfstringstring>
              <d6p1:Key>String</d6p1:Key>
              <d6p1:Value>String</d6p1:Value>
            </d6p1:KeyValueOfstringstring>
          </Meta>
        </ResponseError>
      </Errors>
      <Meta xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:KeyValueOfstringstring>
          <d4p1:Key>String</d4p1:Key>
          <d4p1:Value>String</d4p1:Value>
        </d4p1:KeyValueOfstringstring>
      </Meta>
    </ResponseStatus>
    <SubUser>
      <CanDeleteSearches>false</CanDeleteSearches>
      <CanResolveSearches>false</CanResolveSearches>
      <Email>String</Email>
      <IsAdmin>false</IsAdmin>
      <IsMainUser>false</IsMainUser>
      <Name>String</Name>
      <Permissions>
        <UserName>String</UserName>
      </Permissions>
      <UserId>00000000-0000-0000-0000-000000000000</UserId>
      <UserName>String</UserName>
    </SubUser>
  </Data>
</UpdateSubUserResponse>