Sanctions Search API: v1

<back to all web services

UpdateSearchStatus

Update/resolve a sanctions search

using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using Nugo.SanctionsSearch.Api.ServiceModel.Operations;
using Nugo.SanctionsSearch.Api.ServiceModel.Types;
using Nugo.SanctionsSearch.Api.ServiceModel.Operations.Base;

namespace Nugo.SanctionsSearch.Api.ServiceModel.Operations
{
    ///<summary>
    ///Update/resolve a sanctions search
    ///</summary>
    [Api(Description="Update/resolve a sanctions search")]
    [ApiResponse(Description="Your request is successful if the \"<em>Data.ResponseStatus.Message</em>\" field is \"<b>Success</b>\".", StatusCode=200)]
    [DataContract]
    public partial class UpdateSearchStatus
        : IBaseRequest
    {
        ///<summary>
        ///Authentication object
        ///</summary>
        [DataMember]
        [ApiMember(DataType="Authentication", Description="Authentication object", IsRequired=true)]
        public virtual Authentication Authentication { get; set; }

        ///<summary>
        ///Request object
        ///</summary>
        [DataMember]
        [ApiMember(DataType="UpdateSearchStatusRequest", Description="Request object", IsRequired=true)]
        public virtual UpdateSearchStatusRequest Request { get; set; }
    }

    [DataContract]
    public partial class UpdateSearchStatusData
        : IBaseDataResponse, IHasResponseStatus
    {
        ///<summary>
        ///Response status object
        ///</summary>
        [DataMember]
        [ApiMember(DataType="ResponseStatus", Description="Response status object")]
        public virtual ResponseStatus ResponseStatus { get; set; }
    }

    [DataContract]
    public partial class UpdateSearchStatusResponse
    {
        ///<summary>
        ///Response object
        ///</summary>
        [DataMember]
        [ApiMember(DataType="UpdateSearchStatusData", Description="Response object")]
        public virtual UpdateSearchStatusData Data { get; set; }
    }

}

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

    [DataContract]
    public partial class ResponseError
    {
        [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; }
    }

    [DataContract]
    public partial class ResponseStatus
    {
        [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; }
    }

}

namespace Nugo.SanctionsSearch.Api.ServiceModel.Types
{
    [DataContract]
    public partial class Authentication
        : IAuthentication
    {
        ///<summary>
        ///The API User ID that will authenticate your request
        ///</summary>
        [DataMember]
        [ApiMember(DataType="string", Description="The API User ID that will authenticate your request", IsRequired=true)]
        public virtual string ApiUserId { get; set; }

        ///<summary>
        ///The API User Key that will authenticate your request
        ///</summary>
        [DataMember]
        [ApiMember(DataType="string", Description="The API User Key that will authenticate your request", IsRequired=true)]
        public virtual string ApiUserKey { get; set; }
    }

    [DataContract]
    public partial class UpdateSearchStatusRequest
    {
        ///<summary>
        ///The ID of the sanctions search that is being resolved/updated.
        ///</summary>
        [DataMember]
        [ApiMember(DataType="integer", Description="The ID of the sanctions search that is being resolved/updated.", Format="int64", IsRequired=true)]
        public virtual long Id { get; set; }

        ///<summary>
        ///Whether the search results <b>did</b> contain the client. Set this to "<b>true</b>" if the client <b>WAS</b> found in the search results.
        ///</summary>
        [DataMember]
        [ApiMember(DataType="boolean", Description="Whether the search results <b>did</b> contain the client. Set this to \"<b>true</b>\" if the client <b>WAS</b> found in the search results.", IsRequired=true)]
        public virtual bool ClientInResults { get; set; }

        ///<summary>
        ///Whether the search results <b>did not</b> contain the client. Set this to "<b>true</b>" if the client <b>WAS NOT</b> found in the search results.
        ///</summary>
        [DataMember]
        [ApiMember(DataType="boolean", Description="Whether the search results <b>did not</b> contain the client. Set this to \"<b>true</b>\" if the client <b>WAS NOT</b> found in the search results.", IsRequired=true)]
        public virtual bool ClientNotInResults { get; set; }
    }

}

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

<UpdateSearchStatus xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
  <Authentication>
    <ApiUserId>String</ApiUserId>
    <ApiUserKey>String</ApiUserKey>
  </Authentication>
  <Request>
    <ClientInResults>false</ClientInResults>
    <ClientNotInResults>false</ClientNotInResults>
    <Id>0</Id>
  </Request>
</UpdateSearchStatus>

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

<UpdateSearchStatusResponse 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>
        </ResponseError>
      </Errors>
    </ResponseStatus>
  </Data>
</UpdateSearchStatusResponse>

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