Sanctions Search API: v2

AddPepSearchNote

PEP

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

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


@DataContract
open class AddPepSearchNote : BaseRequest()
{
    @DataMember
    var request:AddPepSearchNoteRequest? = 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 AddPepSearchNoteRequest : ISearchNoteRequest
{
    var id:Long? = null
    var note:String? = null
    var subUserName:String? = null
}

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

open class AddPepSearchNoteData : 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 AddPepSearchNote DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /peps/notes/add HTTP/1.1 
Host: api.sanctionssearch.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"request":{"id":0,"note":"String","subUserName":"String"},"authentication":{"apiUserId":"String","apiUserKey":"String"}}

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

{"data":{"success":false,"notes":[{"name":"String","date":"\/Date(-62135596800000-0000)\/","content":"String"}],"id":0,"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}}