| Get 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; }
}
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .soap11 suffix or ?format=soap11
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /soap11 HTTP/1.1
Host: api.sanctionssearch.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: GetSearches
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<GetSearches xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
<Authentication>
<ApiUserId>String</ApiUserId>
<ApiUserKey>String</ApiUserKey>
</Authentication>
<Request>
<FilterDateFrom>0001-01-01T00:00:00</FilterDateFrom>
<FilterDateTo>0001-01-01T00:00:00</FilterDateTo>
<FilterReference>String</FilterReference>
<FilterType>String</FilterType>
<FilterUserName>String</FilterUserName>
<IncludeSearchSourcesFull>false</IncludeSearchSourcesFull>
<ListArchivedSearches>false</ListArchivedSearches>
<ListUnresolvedSearches>false</ListUnresolvedSearches>
<ListUpdatedSearches>false</ListUpdatedSearches>
<NameSearch>String</NameSearch>
<NameSearchExact>false</NameSearchExact>
<Page>0</Page>
<SortOrder>String</SortOrder>
<SubUserName>String</SubUserName>
</Request>
</GetSearches>
</soap:Body>
</soap:Envelope>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<GetSearchesResponse 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>
<CurrentPageNum>0</CurrentPageNum>
<MaxPageNum>0</MaxPageNum>
<SearchRecords>
<SearchRecord>
<AffectedByUpdate>false</AffectedByUpdate>
<ClientInResults>false</ClientInResults>
<ClientNotInResults>false</ClientNotInResults>
<DateArchived>0001-01-01T00:00:00</DateArchived>
<DateSearched>0001-01-01T00:00:00</DateSearched>
<DateUpdated>0001-01-01T00:00:00</DateUpdated>
<Id>0</Id>
<IsArchived>false</IsArchived>
<NumOfResults>0</NumOfResults>
<SearchCriteria>
<Address>String</Address>
<Country>String</Country>
<DateOfBirth>String</DateOfBirth>
<Name>String</Name>
<Nationality>String</Nationality>
<Reference>String</Reference>
</SearchCriteria>
<SearchSources>
<SearchSource>
<IsAffectedByListUpdate>false</IsAffectedByListUpdate>
<ListId>String</ListId>
<ListName>String</ListName>
<ListShortName>String</ListShortName>
</SearchSource>
</SearchSources>
<SearchType>String</SearchType>
</SearchRecord>
</SearchRecords>
<TotalSearchRecords>0</TotalSearchRecords>
</Data>
</GetSearchesResponse>
</soap:Body>
</soap:Envelope>