Sanctions Search API: v2

<back to all web services

GetSubUsers

import java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    @DataContract
    public static class GetSubUsers extends 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")
        public Boolean includeMainUser = null;
        
        public Boolean isIncludeMainUser() { return includeMainUser; }
        public GetSubUsers setIncludeMainUser(Boolean value) { this.includeMainUser = value; return this; }
    }

    @DataContract
    public static class BaseRequest implements IBaseRequest
    {
        /**
        * The authentication credentials
        */
        @DataMember
        @ApiMember(Description="The authentication credentials", IsRequired=true, ParameterType="header, body")
        public Authentication authentication = null;
        
        public Authentication getAuthentication() { return authentication; }
        public BaseRequest setAuthentication(Authentication value) { this.authentication = value; return this; }
    }

    @DataContract
    public static 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")
        public String apiUserId = 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")
        public String apiUserKey = null;
        
        public String getApiUserId() { return apiUserId; }
        public Authentication setApiUserId(String value) { this.apiUserId = value; return this; }
        public String getApiUserKey() { return apiUserKey; }
        public Authentication setApiUserKey(String value) { this.apiUserKey = value; return this; }
    }

    @DataContract
    public static class GetSubUsersResponse
    {
        /**
        * The response data
        */
        @DataMember
        @ApiMember(Description="The response data")
        public GetSubUsersData data = null;
        
        public GetSubUsersData getData() { return data; }
        public GetSubUsersResponse setData(GetSubUsersData value) { this.data = value; return this; }
    }

    public static class GetSubUsersData extends BaseResponse
    {
        /**
        * The list of sub users
        */
        @ApiMember(Description="The list of sub users")
        public ArrayList<SubUser> subUsers = null;
        
        public ArrayList<SubUser> getSubUsers() { return subUsers; }
        public GetSubUsersData setSubUsers(ArrayList<SubUser> value) { this.subUsers = value; return this; }
    }

    public static class BaseResponse implements IBaseDataResponse, IHasResponseStatus
    {
        /**
        * The status of the response
        */
        @ApiMember(Description="The status of the response")
        public ResponseStatus responseStatus = null;
        
        public ResponseStatus getResponseStatus() { return responseStatus; }
        public BaseResponse setResponseStatus(ResponseStatus value) { this.responseStatus = value; return this; }
    }

    public static class ArrayOfResponseError extends ArrayList<ResponseError>
    {
        
    }

    public static 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)")
        public Boolean isMainUser = null;

        /**
        * The sub user's id (GUID)
        */
        @ApiMember(Description="The sub user's id (GUID)")
        public UUID userId = 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)")
        public String userName = null;

        /**
        * The sub user's name
        */
        @ApiMember(Description="The sub user's name")
        public String name = null;

        /**
        * The sub user's email address
        */
        @ApiMember(Description="The sub user's email address")
        public String email = 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")
        public Boolean isAdmin = 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")
        public Boolean canResolveSearches = 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")
        public Boolean canDeleteSearches = 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")
        public ArrayOfUserNames permissions = null;
        
        public Boolean getIsMainUser() { return isMainUser; }
        public SubUser setIsMainUser(Boolean value) { this.isMainUser = value; return this; }
        public UUID getUserId() { return userId; }
        public SubUser setUserId(UUID value) { this.userId = value; return this; }
        public String getUserName() { return userName; }
        public SubUser setUserName(String value) { this.userName = value; return this; }
        public String getName() { return name; }
        public SubUser setName(String value) { this.name = value; return this; }
        public String getEmail() { return email; }
        public SubUser setEmail(String value) { this.email = value; return this; }
        public Boolean getIsAdmin() { return isAdmin; }
        public SubUser setIsAdmin(Boolean value) { this.isAdmin = value; return this; }
        public Boolean isCanResolveSearches() { return canResolveSearches; }
        public SubUser setCanResolveSearches(Boolean value) { this.canResolveSearches = value; return this; }
        public Boolean isCanDeleteSearches() { return canDeleteSearches; }
        public SubUser setCanDeleteSearches(Boolean value) { this.canDeleteSearches = value; return this; }
        public ArrayOfUserNames getPermissions() { return permissions; }
        public SubUser setPermissions(ArrayOfUserNames value) { this.permissions = value; return this; }
    }

    public static class ArrayOfUserNames extends ArrayList<String>
    {
        
    }

}

Java GetSubUsers DTOs

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

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

{"data":{"subUsers":[{"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"}}}}