Sanctions Search API: v2

GetBulkSearchStatus

Bulk Search

The following routes are available for this service:
POST	/bulksearch/status	Get a bulk search status

**GetBulkSearchStatus** Parameters:
Name	Parameter	Data Type	Required	Description
Request	body	GetBulkSearchStatusRequest	No

**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
ApiUserKey	header, body	string	Yes	The API User Key provided by us when you signed up to use our API

**GetBulkSearchStatusRequest** Parameters:
Name	Parameter	Data Type	Required	Description
BulkSearchId	form	int	No
SubUserName	form	string	No

**GetBulkSearchStatusResponse** Parameters:
Name	Parameter	Data Type	Required	Description
Data	form	GetBulkSearchStatusData	No

**GetBulkSearchStatusData** Parameters:
Name	Parameter	Data Type	Required	Description
BulkSearchStatus	form	BulkSearchStatus	No

**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

**BulkSearchStatus** Parameters:
Name	Parameter	Data Type	Required
BulkSearchId	form	int	No
Success	form	bool	No
Status	form	string	No
Total	form	int	No
Message	form	string	No
Processed	form	int	No
IsPepSearch	form	bool	No
IsSanctionsSearch	form	bool	No
TotalPep	form	int	No
ProcessedPep	form	int	No
TotalSanctions	form	int	No
ProcessedSanctions	form	int	No

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.

POST /bulksearch/status HTTP/1.1 
Host: api.sanctionssearch.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

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

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

<GetBulkSearchStatusResponse 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>
    <BulkSearchStatus>
      <BulkSearchId>0</BulkSearchId>
      <IsPepSearch>false</IsPepSearch>
      <IsSanctionsSearch>false</IsSanctionsSearch>
      <Message>String</Message>
      <Processed>0</Processed>
      <ProcessedPep>0</ProcessedPep>
      <ProcessedSanctions>0</ProcessedSanctions>
      <Status>String</Status>
      <Success>false</Success>
      <Total>0</Total>
      <TotalPep>0</TotalPep>
      <TotalSanctions>0</TotalSanctions>
    </BulkSearchStatus>
  </Data>
</GetBulkSearchStatusResponse>