Sanctions Search API: v2

GetSubUsers

**GetSubUsers** Parameters:
Name	Parameter	Data Type	Required	Description
IncludeMainUser	query	bool	No	If this is 'True' the main user will be included in the list of sub users

**BaseRequest** Parameters:
Name	Parameter	Data Type	Required	Description
Authentication	header, body	Authentication	Yes	The authentication credentials

**Authentication** Parameters:
Name	Parameter	Data Type	Required	Description
ApiUserId	header, body	string	Yes	The API User ID provided by us when you signed up to use our API. Can be provided in the request body, or as a header parameter (X-Api-User)
ApiUserKey	header, body	string	Yes	The API User Key provided by us when you signed up to use our API. Can be provided in the request body, or as a header parameter (X-Api-Key)
UserId	header, body	string	No	The User ID of the user making the request (e.g. a sub user). This is optional but can be used to associate API requests with a specific user, thereby allowing user permissions to be enforced. Can be provided in the body, or as a header parameter (X-User-Id).

**GetSubUsersResponse** Parameters:
Name	Parameter	Data Type	Required	Description
Data	form	GetSubUsersData	No	The response data

**GetSubUsersData** Parameters:
Name	Parameter	Data Type	Required	Description
SubUsers	form	List<SubUser>	No	The list of sub users

**BaseResponse** Parameters:
Name	Parameter	Data Type	Required	Description
ResponseStatus	form	ResponseStatus	No	The status of the response

**ResponseStatus** Parameters:
Name	Parameter	Data Type	Required
ErrorCode	form	string	No
Message	form	string	No
StackTrace	form	string	No
Errors	form	ArrayOfResponseError	No
Meta	form	Dictionary<string, string>	No

**ResponseError** Parameters:
Name	Parameter	Data Type	Required
ErrorCode	form	string	No
FieldName	form	string	No
Message	form	string	No
Meta	form	Dictionary<string, string>	No

**SubUser** Parameters:
Name	Parameter	Data Type	Required	Description
IsMainUser	form	bool	No	Is this user the main user (i.e. the user who created the account)
UserId	form	Guid	No	The sub user's id (GUID)
UserName	form	string	No	The sub user's UserName (i.e. the sign-in username)
Name	form	string	No	The sub user's name
Email	form	string	No	The sub user's email address
IsAdmin	form	bool	No	Does this sub user have admin privileges, such as managing purchases and sub users
CanResolveSearches	form	bool	No	Can this sub user resolve searches (UpdateSearch) they have access to
CanDeleteSearches	form	bool	No	Can this sub user delete searches (DeleteSearch) they have access to
Permissions	form	ArrayOfUserNames	No	The user names for which searches will be made available to the sub user

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>
    <UserId>String</UserId>
  </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>