Sanctions Search API: v1

<back to all web services

UpdateSearchStatus

Update/resolve a sanctions search

namespace Nugo.SanctionsSearch.Api.ServiceModel.Operations

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<DataContract>]
    [<AllowNullLiteral>]
    type ResponseError() = 
        [<DataMember(Order=1)>]
        member val ErrorCode:String = null with get,set

        [<DataMember(Order=2)>]
        member val FieldName:String = null with get,set

        [<DataMember(Order=3)>]
        member val Message:String = null with get,set

    [<AllowNullLiteral>]
    type ArrayOfResponseError() = 
        inherit ResizeArray<ResponseError>()

    [<DataContract>]
    [<AllowNullLiteral>]
    type ResponseStatus() = 
        [<DataMember(Order=1)>]
        member val ErrorCode:String = null with get,set

        [<DataMember(Order=2)>]
        member val Message:String = null with get,set

        [<DataMember(Order=3)>]
        member val StackTrace:String = null with get,set

        [<DataMember(Order=4)>]
        member val Errors:ArrayOfResponseError = null with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type UpdateSearchStatusData() = 
        ///<summary>
        ///Response status object
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="ResponseStatus", Description="Response status object")>]
        member val ResponseStatus:ResponseStatus = null with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type UpdateSearchStatusResponse() = 
        ///<summary>
        ///Response object
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="UpdateSearchStatusData", Description="Response object")>]
        member val Data:UpdateSearchStatusData = null with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type Authentication() = 
        ///<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)>]
        member val ApiUserId:String = null with 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)>]
        member val ApiUserKey:String = null with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type 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)>]
        member val Id:Int64 = new Int64() with 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)>]
        member val ClientInResults:Boolean = new Boolean() with 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)>]
        member val ClientNotInResults:Boolean = new Boolean() with get,set

    ///<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>]
    [<AllowNullLiteral>]
    type UpdateSearchStatus() = 
        ///<summary>
        ///Authentication object
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="Authentication", Description="Authentication object", IsRequired=true)>]
        member val Authentication:Authentication = null with get,set

        ///<summary>
        ///Request object
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="UpdateSearchStatusRequest", Description="Request object", IsRequired=true)>]
        member val Request:UpdateSearchStatusRequest = null with get,set

F# 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>