Sanctions Search API: v2

<back to all web services

GetSubUsers

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


@DataContract
open class GetSubUsers : BaseRequest()
{
    /**
    * If this is 'True' the main user will be included in the list of sub users
    */
    @DataMember
    @ApiMember(Description="If this is 'True' the main user will be included in the list of sub users", ParameterType="query")
    var includeMainUser:Boolean? = 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 GetSubUsersResponse
{
    /**
    * The response data
    */
    @DataMember
    @ApiMember(Description="The response data")
    @SerializedName("data") var Data:GetSubUsersData? = null
}

open class GetSubUsersData : BaseResponse()
{
    /**
    * The list of sub users
    */
    @ApiMember(Description="The list of sub users")
    var subUsers:ArrayList<SubUser> = ArrayList<SubUser>()
}

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 GetSubUsers DTOs

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

HTTP + SOAP12

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

POST /soap12 HTTP/1.1 
Host: api.sanctionssearch.com 
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>

<GetSubUsers xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
  <Authentication>
    <ApiUserId>String</ApiUserId>
    <ApiUserKey>String</ApiUserKey>
  </Authentication>
  <IncludeMainUser>false</IncludeMainUser>
</GetSubUsers>

</soap12:Body>
</soap12:Envelope>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>

<GetSubUsersResponse 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>
    <SubUsers>
      <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>
    </SubUsers>
  </Data>
</GetSubUsersResponse>

</soap12:Body>
</soap12:Envelope>