Sanctions Search API: v1

GetListSearches

Sanctions

The following routes are available for this service:
POST	/searches/list	Get all sanctions searches

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
{
    [ApiResponse(Description="Your request is successful if the \"<em>Data.ResponseStatus.Message</em>\" field is \"<b>Success</b>\".", StatusCode=200)]
    [DataContract]
    public partial class GetListSearches
        : IBaseRequest
    {
        [DataMember]
        public virtual Authentication Authentication { get; set; }

        [DataMember]
        public virtual int Page { get; set; }

        [DataMember]
        public virtual string SortOrder { get; set; }

        [DataMember]
        public virtual string NameSearch { get; set; }
    }

    [DataContract]
    public partial class GetListSearchesData
        : IBaseDataResponse, IHasResponseStatus
    {
        [DataMember]
        public virtual ResponseStatus ResponseStatus { get; set; }

        [DataMember]
        public virtual int TotalSearchRecords { get; set; }

        [DataMember]
        public virtual int CurrentPageNum { get; set; }

        [DataMember]
        public virtual int MaxPageNum { get; set; }

        [DataMember]
        public virtual ArrayOfSearchListItem SearchRecords { get; set; }
    }

    [DataContract]
    public partial class GetListSearchesResponse
    {
        [DataMember]
        public virtual GetListSearchesData 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
{
    public partial class ArrayOfSearchListItem
        : List<SearchListItem>
    {
    }

    [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; }
    }

    public partial class SearchCriteria
    {
        public virtual string Name { get; set; }
        public virtual string DateOfBirth { get; set; }
        public virtual string CountryOfBirth { get; set; }
        public virtual string Nationality { get; set; }
        public virtual string Address { get; set; }
    }

    public partial class SearchListItem
    {
        public virtual long Id { get; set; }
        public virtual string SearchType { get; set; }
        public virtual DateTime DateSearched { get; set; }
        public virtual DateTime DateUpdated { get; set; }
        public virtual int NumOfResults { get; set; }
        public virtual bool ClientInResults { get; set; }
        public virtual bool ClientNotInResults { get; set; }
        public virtual bool AffectedByUpdate { get; set; }
        public virtual SearchCriteria SearchCriteria { get; set; }
    }

}

C# GetListSearches 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 /searches/list HTTP/1.1 
Host: api.sanctionssearch.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"Authentication":{"ApiUserId":"String","ApiUserKey":"String"},"Page":0,"SortOrder":"String","NameSearch":"String"}

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

{"Data":{"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String"}]},"TotalSearchRecords":0,"CurrentPageNum":0,"MaxPageNum":0,"SearchRecords":[{"Id":0,"SearchType":"String","DateSearched":"\/Date(-62135596800000-0000)\/","DateUpdated":"\/Date(-62135596800000-0000)\/","NumOfResults":0,"ClientInResults":false,"ClientNotInResults":false,"AffectedByUpdate":false,"SearchCriteria":{"Name":"String","DateOfBirth":"String","CountryOfBirth":"String","Nationality":"String","Address":"String"}}]}}