Sanctions Search API: v2

<back to all web services

GetSubUser

import java.math.*
import java.util.*
import net.servicestack.client.*
import com.google.gson.annotations.*
import com.google.gson.reflect.*


@DataContract
open class GetSubUser : BaseRequest()
{
    /**
    * The user name of the sub user
    */
    @DataMember
    @ApiMember(Description="The user name of the sub user", ParameterType="query")
    var subUserName:String? = null

    /**
    * The user id of the sub user
    */
    @DataMember
    @ApiMember(Description="The user id of the sub user", ParameterType="query")
    var subUserId:UUID? = null
}

@DataContract
open class BaseRequest : IBaseRequest
{
    /**
    * The authentication credentials
    */
    @DataMember
    @ApiMember(Description="The authentication credentials", IsRequired=true, ParameterType="header, body")
    var authentication:Authentication? = null
}

@DataContract
open class Authentication
{
    /**
    * The API User ID provided by us when you signed up to use our API
    */
    @DataMember
    @ApiMember(Description="The API User ID provided by us when you signed up to use our API", IsRequired=true, ParameterType="header, body")
    var apiUserId:String? = null

    /**
    * The API User Key provided by us when you signed up to use our API
    */
    @DataMember
    @ApiMember(Description="The API User Key provided by us when you signed up to use our API", IsRequired=true, ParameterType="header, body")
    var apiUserKey:String? = null
}

@DataContract
open class GetSubUserResponse
{
    /**
    * The response data
    */
    @DataMember
    @ApiMember(Description="The response data")
    @SerializedName("data") var Data:GetSubUserData? = null
}

open class GetSubUserData : BaseResponse()
{
    /**
    * The sub users
    */
    @ApiMember(Description="The sub users")
    var subUser:SubUser? = null
}

open class BaseResponse : IBaseDataResponse, IHasResponseStatus
{
    /**
    * The status of the response
    */
    @ApiMember(Description="The status of the response")
    var responseStatus:ResponseStatus? = null
}

open class ArrayOfResponseError : ArrayList<ResponseError>()
{
}

open class SubUser
{
    /**
    * Is this user the main user (i.e. the user who created the account)
    */
    @ApiMember(Description="Is this user the main user (i.e. the user who created the account)")
    var isMainUser:Boolean? = null

    /**
    * The sub user's id (GUID)
    */
    @ApiMember(Description="The sub user's id (GUID)")
    var userId:UUID? = null

    /**
    * The sub user's UserName (i.e. the sign-in username)
    */
    @ApiMember(Description="The sub user's UserName (i.e. the sign-in username)")
    var userName:String? = null

    /**
    * The sub user's name
    */
    @ApiMember(Description="The sub user's name")
    var name:String? = null

    /**
    * The sub user's email address
    */
    @ApiMember(Description="The sub user's email address")
    var email:String? = null

    /**
    * Does this sub user have admin privileges, such as managing purchases and sub users
    */
    @ApiMember(Description="Does this sub user have admin privileges, such as managing purchases and sub users")
    var isAdmin:Boolean? = null

    /**
    * Can this sub user resolve searches (UpdateSearch) they have access to
    */
    @ApiMember(Description="Can this sub user resolve searches (UpdateSearch) they have access to")
    var canResolveSearches:Boolean? = null

    /**
    * Can this sub user delete searches (DeleteSearch) they have access to
    */
    @ApiMember(Description="Can this sub user delete searches (DeleteSearch) they have access to")
    var canDeleteSearches:Boolean? = null

    /**
    * The user names for which searches will be made available to the sub user
    */
    @ApiMember(Description="The user names for which searches will be made available to the sub user")
    var permissions:ArrayOfUserNames? = null
}

open class ArrayOfUserNames : ArrayList<String>()
{
}

Kotlin GetSubUser DTOs

GET /subusers/get HTTP/1.1 
Host: api.sanctionssearch.com 
Accept: application/json

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"}}}}