Sanctions Search API: v2

<back to all web services

GetBulkSearchHistory

// @DataContract
export class Authentication
{
    /** @description 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 apiUserId: string;

    /** @description 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 apiUserKey: string;

    public constructor(init?: Partial<Authentication>) { (Object as any).assign(this, init); }
}

// @DataContract
export class BaseRequest implements IBaseRequest
{
    /** @description The authentication credentials */
    // @DataMember
    // @ApiMember(Description="The authentication credentials", IsRequired=true, ParameterType="header, body")
    public authentication: Authentication;

    public constructor(init?: Partial<BaseRequest>) { (Object as any).assign(this, init); }
}

// @DataContract
export class ResponseError
{
    // @DataMember(Order=1)
    public errorCode: string;

    // @DataMember(Order=2)
    public fieldName: string;

    // @DataMember(Order=3)
    public message: string;

    // @DataMember(Order=4)
    public meta: { [index: string]: string; };

    public constructor(init?: Partial<ResponseError>) { (Object as any).assign(this, init); }
}

export class ArrayOfResponseError extends Array<ResponseError>
{

    public constructor(init?: Partial<ArrayOfResponseError>) { super(); (Object as any).assign(this, init); }
}

// @DataContract
export class ResponseStatus
{
    // @DataMember(Order=1)
    public errorCode: string;

    // @DataMember(Order=2)
    public message: string;

    // @DataMember(Order=3)
    public stackTrace: string;

    // @DataMember(Order=4)
    public errors: ArrayOfResponseError;

    // @DataMember(Order=5)
    public meta: { [index: string]: string; };

    public constructor(init?: Partial<ResponseStatus>) { (Object as any).assign(this, init); }
}

export class BaseResponse implements IBaseDataResponse, IHasResponseStatus
{
    /** @description The status of the response */
    // @ApiMember(Description="The status of the response")
    public responseStatus: ResponseStatus;

    public constructor(init?: Partial<BaseResponse>) { (Object as any).assign(this, init); }
}

export class BulkSearchStatus
{
    public bulkSearchId: number;
    public success: boolean;
    public status: string;
    public total: number;
    public message: string;
    public processed: number;
    public isPepSearch: boolean;
    public isSanctionsSearch: boolean;
    public totalPep: number;
    public processedPep: number;
    public totalSanctions: number;
    public processedSanctions: number;

    public constructor(init?: Partial<BulkSearchStatus>) { (Object as any).assign(this, init); }
}

export class ArrayOfBulkSearchStatus extends Array<BulkSearchStatus>
{

    public constructor(init?: Partial<ArrayOfBulkSearchStatus>) { super(); (Object as any).assign(this, init); }
}

export class GetBulkSearchHistoryData extends BaseResponse
{
    public bulkSearchList: ArrayOfBulkSearchStatus;
    public currentPageNum: number;
    public maxPageNum: number;
    public totalBulkSearches: number;
    public pageSize: number;

    public constructor(init?: Partial<GetBulkSearchHistoryData>) { super(init); (Object as any).assign(this, init); }
}

// @DataContract
export class GetBulkSearchHistoryResponse
{
    // @DataMember
    public data: GetBulkSearchHistoryData;

    public constructor(init?: Partial<GetBulkSearchHistoryResponse>) { (Object as any).assign(this, init); }
}

export class GetBulkSearchHistoryRequest
{
    public subUserName: string;
    public page: number;
    public sortOrder: string;
    /** @description The user id to filter on, in string format (GUID) */
    // @ApiMember(Description="The user id to filter on, in string format (GUID)")
    public whereUserId: string;

    public whereDateFrom?: string;
    public whereDateTo?: string;
    public whereId?: number;
    public pageSize: number;

    public constructor(init?: Partial<GetBulkSearchHistoryRequest>) { (Object as any).assign(this, init); }
}

// @DataContract
export class GetBulkSearchHistory extends BaseRequest
{
    // @DataMember
    public request: GetBulkSearchHistoryRequest;

    public constructor(init?: Partial<GetBulkSearchHistory>) { super(init); (Object as any).assign(this, init); }
}

TypeScript GetBulkSearchHistory DTOs

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>

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

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

<GetBulkSearchHistoryResponse 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>
    <BulkSearchList>
      <BulkSearch>
        <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>
      </BulkSearch>
    </BulkSearchList>
    <CurrentPageNum>0</CurrentPageNum>
    <MaxPageNum>0</MaxPageNum>
    <PageSize>0</PageSize>
    <TotalBulkSearches>0</TotalBulkSearches>
  </Data>
</GetBulkSearchHistoryResponse>

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