Sanctions Search API: v2

AddSearchNote

Sanctions

The following routes are available for this service:
POST	/sanctions/notes/add	Add a note to an existing sanctions search

import java.math.*
import java.util.*
import net.servicestack.client.*
import com.google.gson.annotations.*
import com.google.gson.reflect.*


@DataContract
open class AddSearchNote : BaseRequest()
{
    @DataMember
    var request:AddSearchNoteRequest? = null
}

@DataContract
open class BaseRequest : IBaseRequest
{
    /**
    * The authentication credentials
    */
    @DataMember
    @ApiMember(Description="The authentication credentials", IsRequired=true, ParameterType="header, body")
    var authentication:Authentication? = null
}

@DataContract
open class Authentication
{
    /**
    * 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")
    var apiUserId:String? = null

    /**
    * 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")
    var apiUserKey:String? = null
}

open class AddSearchNoteRequest : ISearchNoteRequest
{
    var id:Long? = null
    var note:String? = null
    var subUserName:String? = null
}

@DataContract
open class AddSearchNoteResponse
{
    @DataMember
    @SerializedName("data") var Data:AddSearchNoteData? = null
}

open class AddSearchNoteData : BaseResponse()
{
    var success:Boolean? = null
    var notes:ArrayOfSearchNote? = null
    var id:Long? = null
}

open class BaseResponse : IBaseDataResponse, IHasResponseStatus
{
    /**
    * The status of the response
    */
    @ApiMember(Description="The status of the response")
    var responseStatus:ResponseStatus? = null
}

open class ArrayOfResponseError : ArrayList<ResponseError>()
{
}

open class ArrayOfSearchNote : ArrayList<SearchNote>()
{
}

open class SearchNote
{
    var name:String? = null
    var date:Date? = null
    var content:String? = null
}

Kotlin AddSearchNote DTOs

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 /sanctions/notes/add HTTP/1.1 
Host: api.sanctionssearch.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

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

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

<AddSearchNoteResponse 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>
    <Id>0</Id>
    <Notes>
      <Note>
        <Content>String</Content>
        <Date>0001-01-01T00:00:00</Date>
        <Name>String</Name>
      </Note>
    </Notes>
    <Success>false</Success>
  </Data>
</AddSearchNoteResponse>