Sanctions Search API: v2

AddBulkSearch

Create a bulk search

using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using SanctionsSearch.Api2.ServiceModel.Operations.BulkSearches;
using SanctionsSearch.Api2.ServiceModel.Operations.Base;
using SanctionsSearch.Api2.ServiceModel.Types;

namespace SanctionsSearch.Api2.ServiceModel.Operations.Base
{
    public partial class ArrayOfResponseError
        : List<ResponseError>
    {
    }

    [DataContract]
    public partial class BaseRequest
        : IBaseRequest
    {
        ///<summary>
        ///The authentication credentials
        ///</summary>
        [DataMember]
        [ApiMember(Description="The authentication credentials", IsRequired=true, ParameterType="header, body")]
        public virtual Authentication Authentication { get; set; }
    }

    public partial class BaseResponse
        : IBaseDataResponse, IHasResponseStatus
    {
        ///<summary>
        ///The status of the response
        ///</summary>
        [ApiMember(Description="The status of the response")]
        public virtual ResponseStatus ResponseStatus { get; set; }
    }

    [DataContract]
    public partial class ResponseError
    {
        public ResponseError()
        {
            Meta = new Dictionary<string, string>{};
        }

        [DataMember(Order=1)]
        public virtual string ErrorCode { get; set; }

        [DataMember(Order=2)]
        public virtual string FieldName { get; set; }

        [DataMember(Order=3)]
        public virtual string Message { get; set; }

        [DataMember(Order=4)]
        public virtual Dictionary<string, string> Meta { get; set; }
    }

    [DataContract]
    public partial class ResponseStatus
    {
        public ResponseStatus()
        {
            Meta = new Dictionary<string, string>{};
        }

        [DataMember(Order=1)]
        public virtual string ErrorCode { get; set; }

        [DataMember(Order=2)]
        public virtual string Message { get; set; }

        [DataMember(Order=3)]
        public virtual string StackTrace { get; set; }

        [DataMember(Order=4)]
        public virtual ArrayOfResponseError Errors { get; set; }

        [DataMember(Order=5)]
        public virtual Dictionary<string, string> Meta { get; set; }
    }

}

namespace SanctionsSearch.Api2.ServiceModel.Operations.BulkSearches
{
    [DataContract]
    public partial class AddBulkSearch
        : BaseRequest
    {
        [DataMember]
        public virtual AddBulkSearchRequest Request { get; set; }
    }

    public partial class AddBulkSearchData
        : BaseResponse
    {
        public virtual BulkSearchStatus BulkSearchStatus { get; set; }
    }

    public partial class AddBulkSearchRequest
    {
        public virtual bool IsSanctionsSearch { get; set; }
        public virtual bool IsPepSearch { get; set; }
        public virtual string Type { get; set; }
        public virtual ArrayOfLists SelectedLists { get; set; }
    }

    [DataContract]
    public partial class AddBulkSearchResponse
    {
        [DataMember]
        public virtual AddBulkSearchData Data { get; set; }
    }

}

namespace SanctionsSearch.Api2.ServiceModel.Types
{
    public partial class ArrayOfLists
        : List<string>
    {
    }

    [DataContract]
    public partial class Authentication
    {
        ///<summary>
        ///The API User ID provided by us when you signed up to use our API
        ///</summary>
        [DataMember]
        [ApiMember(Description="The API User ID provided by us when you signed up to use our API", IsRequired=true, ParameterType="header, body")]
        public virtual string ApiUserId { get; set; }

        ///<summary>
        ///The API User Key provided by us when you signed up to use our API
        ///</summary>
        [DataMember]
        [ApiMember(Description="The API User Key provided by us when you signed up to use our API", IsRequired=true, ParameterType="header, body")]
        public virtual string ApiUserKey { get; set; }
    }

    public partial class BulkSearchStatus
    {
        public virtual int BulkSearchId { get; set; }
        public virtual bool Success { get; set; }
        public virtual string Status { get; set; }
        public virtual int Total { get; set; }
        public virtual string Message { get; set; }
        public virtual int Processed { get; set; }
        public virtual bool IsPepSearch { get; set; }
        public virtual bool IsSanctionsSearch { get; set; }
        public virtual int TotalPep { get; set; }
        public virtual int ProcessedPep { get; set; }
        public virtual int TotalSanctions { get; set; }
        public virtual int ProcessedSanctions { get; set; }
    }

}

C# AddBulkSearch 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>

<AddBulkSearch xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
  <Authentication>
    <ApiUserId>String</ApiUserId>
    <ApiUserKey>String</ApiUserKey>
  </Authentication>
  <Request>
    <IsPepSearch>false</IsPepSearch>
    <IsSanctionsSearch>false</IsSanctionsSearch>
    <SelectedLists>
      <ListId>String</ListId>
    </SelectedLists>
    <Type>String</Type>
  </Request>
</AddBulkSearch>

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

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

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