Sanctions Search API: v2

<back to all web services

GetSearches

Sanctions
The following routes are available for this service:
POST/sanctions/listGet all sanctions searches
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using SanctionsSearch.Api2.ServiceModel.Operations.Searches;
using SanctionsSearch.Api2.ServiceModel.Operations.Base;
using SanctionsSearch.Api2.ServiceModel.Types;

namespace SanctionsSearch.Api2.ServiceModel.Operations.Base
{
    public partial class ArrayOfResponseError
        : List<ResponseError>
    {
    }

    [DataContract]
    public partial class BaseRequest
        : IBaseRequest
    {
        ///<summary>
        ///The authentication credentials
        ///</summary>
        [DataMember]
        [ApiMember(Description="The authentication credentials", IsRequired=true, ParameterType="header, body")]
        public virtual Authentication Authentication { get; set; }
    }

    public partial class BaseResponse
        : IBaseDataResponse, IHasResponseStatus
    {
        ///<summary>
        ///The status of the response
        ///</summary>
        [ApiMember(Description="The status of the response")]
        public virtual ResponseStatus ResponseStatus { get; set; }
    }

    [DataContract]
    public partial class ResponseError
    {
        public ResponseError()
        {
            Meta = new Dictionary<string, string>{};
        }

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

        [DataMember(Order=4)]
        public virtual Dictionary<string, string> Meta { get; set; }
    }

    [DataContract]
    public partial class ResponseStatus
    {
        public ResponseStatus()
        {
            Meta = new Dictionary<string, string>{};
        }

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

        [DataMember(Order=5)]
        public virtual Dictionary<string, string> Meta { get; set; }
    }

}

namespace SanctionsSearch.Api2.ServiceModel.Operations.Searches
{
    [DataContract]
    public partial class GetSearches
        : BaseRequest
    {
        [DataMember]
        public virtual GetSearchesRequest Request { get; set; }
    }

    public partial class GetSearchesData
        : BaseResponse
    {
        public virtual int TotalSearchRecords { get; set; }
        public virtual int CurrentPageNum { get; set; }
        public virtual int MaxPageNum { get; set; }
        public virtual ArrayOfSearchListItem SearchRecords { get; set; }
    }

    public partial class GetSearchesRequest
    {
        ///<summary>
        ///If the searches are being accessed by a sub user, specify their username here to only return searches they have permissions to view
        ///</summary>
        [ApiMember(Description="If the searches are being accessed by a sub user, specify their username here to only return searches they have permissions to view")]
        public virtual string SubUserName { get; set; }

        public virtual bool? ListUnresolvedSearches { get; set; }
        public virtual bool? ListUpdatedSearches { get; set; }
        public virtual bool ListArchivedSearches { get; set; }
        public virtual int Page { get; set; }
        public virtual string SortOrder { get; set; }
        public virtual string NameSearch { get; set; }
        public virtual bool NameSearchExact { get; set; }
        public virtual string FilterReference { get; set; }
        public virtual string FilterType { get; set; }
        public virtual DateTime? FilterDateFrom { get; set; }
        public virtual DateTime? FilterDateTo { get; set; }
        ///<summary>
        ///If set, will only return searches created by the user
        ///</summary>
        [ApiMember(Description="If set, will only return searches created by the user")]
        public virtual string FilterUserName { get; set; }

        public virtual bool IncludeSearchSourcesFull { get; set; }
    }

    [DataContract]
    public partial class GetSearchesResponse
    {
        [DataMember]
        public virtual GetSearchesData Data { get; set; }
    }

}

namespace SanctionsSearch.Api2.ServiceModel.Types
{
    public partial class ArrayOfSearchListItem
        : List<SearchListItem>
    {
    }

    [DataContract]
    public partial class Authentication
    {
        ///<summary>
        ///The API User ID provided by us when you signed up to use our API
        ///</summary>
        [DataMember]
        [ApiMember(Description="The API User ID provided by us when you signed up to use our API", IsRequired=true, ParameterType="header, body")]
        public virtual string ApiUserId { get; set; }

        ///<summary>
        ///The API User Key provided by us when you signed up to use our API
        ///</summary>
        [DataMember]
        [ApiMember(Description="The API User Key provided by us when you signed up to use our API", IsRequired=true, ParameterType="header, body")]
        public virtual string ApiUserKey { get; set; }
    }

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

    public partial class SearchListItem
    {
        public SearchListItem()
        {
            SearchSources = new List<SearchSource>{};
        }

        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 DateTime? DateArchived { get; set; }
        public virtual bool IsArchived { 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; }
        public virtual List<SearchSource> SearchSources { get; set; }
    }

    public partial class SearchSource
    {
        public virtual string ListId { get; set; }
        public virtual string ListName { get; set; }
        public virtual string ListShortName { get; set; }
        public virtual bool? IsAffectedByListUpdate { get; set; }
    }

}

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

{"request":{"subUserName":"String","listUnresolvedSearches":false,"listUpdatedSearches":false,"listArchivedSearches":false,"page":0,"sortOrder":"String","nameSearch":"String","nameSearchExact":false,"filterReference":"String","filterType":"String","filterDateFrom":"\/Date(-62135596800000-0000)\/","filterDateTo":"\/Date(-62135596800000-0000)\/","filterUserName":"String","includeSearchSourcesFull":false},"authentication":{"apiUserId":"String","apiUserKey":"String"}}

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

{"data":{"totalSearchRecords":0,"currentPageNum":0,"maxPageNum":0,"searchRecords":[{"id":0,"searchType":"String","dateSearched":"\/Date(-62135596800000-0000)\/","dateUpdated":"\/Date(-62135596800000-0000)\/","dateArchived":"\/Date(-62135596800000-0000)\/","isArchived":false,"numOfResults":0,"clientInResults":false,"clientNotInResults":false,"affectedByUpdate":false,"searchCriteria":{"name":"String","address":"String","country":"String","dateOfBirth":"String","nationality":"String","reference":"String"},"searchSources":[{"listId":"String","listName":"String","listShortName":"String","isAffectedByListUpdate":false}]}],"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}}