Sanctions Search API: v2

<back to all web services

AddSearchNote

import java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    @DataContract
    public static class AddSearchNote extends BaseRequest
    {
        @DataMember
        public AddSearchNoteRequest request = null;
        
        public AddSearchNoteRequest getRequest() { return request; }
        public AddSearchNote setRequest(AddSearchNoteRequest value) { this.request = value; return this; }
    }

    @DataContract
    public static class BaseRequest implements IBaseRequest
    {
        /**
        * The authentication credentials
        */
        @DataMember
        @ApiMember(Description="The authentication credentials", IsRequired=true, ParameterType="header, body")
        public Authentication authentication = null;
        
        public Authentication getAuthentication() { return authentication; }
        public BaseRequest setAuthentication(Authentication value) { this.authentication = value; return this; }
    }

    @DataContract
    public static 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")
        public String apiUserId = 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")
        public String apiUserKey = null;
        
        public String getApiUserId() { return apiUserId; }
        public Authentication setApiUserId(String value) { this.apiUserId = value; return this; }
        public String getApiUserKey() { return apiUserKey; }
        public Authentication setApiUserKey(String value) { this.apiUserKey = value; return this; }
    }

    public static class AddSearchNoteRequest implements ISearchNoteRequest
    {
        public Long id = null;
        public String note = null;
        public String subUserName = null;
        
        public Long getId() { return id; }
        public AddSearchNoteRequest setId(Long value) { this.id = value; return this; }
        public String getNote() { return note; }
        public AddSearchNoteRequest setNote(String value) { this.note = value; return this; }
        public String getSubUserName() { return subUserName; }
        public AddSearchNoteRequest setSubUserName(String value) { this.subUserName = value; return this; }
    }

    @DataContract
    public static class AddSearchNoteResponse
    {
        @DataMember
        public AddSearchNoteData data = null;
        
        public AddSearchNoteData getData() { return data; }
        public AddSearchNoteResponse setData(AddSearchNoteData value) { this.data = value; return this; }
    }

    public static class AddSearchNoteData extends BaseResponse
    {
        public Boolean success = null;
        public ArrayOfSearchNote notes = null;
        public Long id = null;
        
        public Boolean isSuccess() { return success; }
        public AddSearchNoteData setSuccess(Boolean value) { this.success = value; return this; }
        public ArrayOfSearchNote getNotes() { return notes; }
        public AddSearchNoteData setNotes(ArrayOfSearchNote value) { this.notes = value; return this; }
        public Long getId() { return id; }
        public AddSearchNoteData setId(Long value) { this.id = value; return this; }
    }

    public static class BaseResponse implements IBaseDataResponse, IHasResponseStatus
    {
        /**
        * The status of the response
        */
        @ApiMember(Description="The status of the response")
        public ResponseStatus responseStatus = null;
        
        public ResponseStatus getResponseStatus() { return responseStatus; }
        public BaseResponse setResponseStatus(ResponseStatus value) { this.responseStatus = value; return this; }
    }

    public static class ArrayOfResponseError extends ArrayList<ResponseError>
    {
        
    }

    public static class ArrayOfSearchNote extends ArrayList<SearchNote>
    {
        
    }

    public static class SearchNote
    {
        public String name = null;
        public Date date = null;
        public String content = null;
        
        public String getName() { return name; }
        public SearchNote setName(String value) { this.name = value; return this; }
        public Date getDate() { return date; }
        public SearchNote setDate(Date value) { this.date = value; return this; }
        public String getContent() { return content; }
        public SearchNote setContent(String value) { this.content = value; return this; }
    }

}

Java AddSearchNote DTOs

POST /sanctions/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"}}}}