| Get all the ValidID Searches |
namespace SanctionsSearch.Api2.ServiceModel.Operations.Base
open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations
[<DataContract>]
[<AllowNullLiteral>]
type ResponseError() =
[<DataMember(Order=1)>]
member val ErrorCode:String = null with get,set
[<DataMember(Order=2)>]
member val FieldName:String = null with get,set
[<DataMember(Order=3)>]
member val Message:String = null with get,set
[<DataMember(Order=4)>]
member val Meta:Dictionary<String, String> = new Dictionary<String, String>() with get,set
[<AllowNullLiteral>]
type ArrayOfResponseError() =
inherit ResizeArray<ResponseError>()
[<DataContract>]
[<AllowNullLiteral>]
type ResponseStatus() =
[<DataMember(Order=1)>]
member val ErrorCode:String = null with get,set
[<DataMember(Order=2)>]
member val Message:String = null with get,set
[<DataMember(Order=3)>]
member val StackTrace:String = null with get,set
[<DataMember(Order=4)>]
member val Errors:ArrayOfResponseError = null with get,set
[<DataMember(Order=5)>]
member val Meta:Dictionary<String, String> = new Dictionary<String, String>() with get,set
[<AllowNullLiteral>]
type BaseResponse() =
///<summary>
///The status of the response
///</summary>
[<ApiMember(Description="The status of the response")>]
member val ResponseStatus:ResponseStatus = null with get,set
[<AllowNullLiteral>]
type ValidIdSearchCriteria() =
member val FullName:String = null with get,set
member val DateOfBirth:DateTime = new DateTime() with get,set
member val Gender:String = null with get,set
member val Address:String = null with get,set
[<AllowNullLiteral>]
type ValidIdListItem() =
member val Id:Int32 = new Int32() with get,set
member val Type:Int32 = new Int32() with get,set
member val Score:Nullable<Int32> = new Nullable<Int32>() with get,set
member val Status:String = null with get,set
member val DateSearched:DateTime = new DateTime() with get,set
member val Reference:String = null with get,set
member val PepError:Boolean = new Boolean() with get,set
member val Replaced:Boolean = new Boolean() with get,set
member val ReplacementSearchId:Nullable<Int32> = new Nullable<Int32>() with get,set
member val HasCompletedRequest:Boolean = new Boolean() with get,set
member val HasCompletedSearch:Boolean = new Boolean() with get,set
member val SearchCriteria:ValidIdSearchCriteria = null with get,set
[<AllowNullLiteral>]
type ArrayOfValidIdListItem() =
inherit ResizeArray<ValidIdListItem>()
[<AllowNullLiteral>]
type GetValidIdsData() =
inherit BaseResponse()
member val TotalSearchRecords:Int32 = new Int32() with get,set
member val CurrentPageNum:Int32 = new Int32() with get,set
member val MaxPageNum:Int32 = new Int32() with get,set
member val SearchRecords:ArrayOfValidIdListItem = null with get,set
[<DataContract>]
[<AllowNullLiteral>]
type GetValidIdsResponse() =
[<DataMember>]
member val Data:GetValidIdsData = null with get,set
[<DataContract>]
[<AllowNullLiteral>]
type 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")>]
member val ApiUserId:String = null with 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")>]
member val ApiUserKey:String = null with get,set
[<DataContract>]
[<AllowNullLiteral>]
type BaseRequest() =
///<summary>
///The authentication credentials
///</summary>
[<DataMember>]
[<ApiMember(Description="The authentication credentials", IsRequired=true, ParameterType="header, body")>]
member val Authentication:Authentication = null with get,set
[<AllowNullLiteral>]
type GetValidIdsRequest() =
///<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")>]
member val SubUserName:String = null with get,set
member val Page:Int32 = new Int32() with get,set
member val SortOrder:String = null with get,set
member val NameSearch:String = null with get,set
member val FilterReference:String = null with get,set
member val FilterType:String = null with get,set
member val FilterDateFrom:Nullable<DateTime> = new Nullable<DateTime>() with get,set
member val FilterDateTo:Nullable<DateTime> = new Nullable<DateTime>() with 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")>]
member val FilterUserName:String = null with get,set
[<DataContract>]
[<AllowNullLiteral>]
type GetValidIds() =
inherit BaseRequest()
[<DataMember>]
member val Request:GetValidIdsRequest = null with get,set
To override the Content-type in your clients, use the HTTP Accept Header, append the .soap12 suffix or ?format=soap12
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /soap12 HTTP/1.1
Host: api.sanctionssearch.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<GetValidIds 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>
<NameSearch>String</NameSearch>
<Page>0</Page>
<SortOrder>String</SortOrder>
<SubUserName>String</SubUserName>
</Request>
</GetValidIds>
</soap12:Body>
</soap12:Envelope>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<GetValidIdsResponse 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>
<DateSearched>0001-01-01T00:00:00</DateSearched>
<HasCompletedRequest>false</HasCompletedRequest>
<HasCompletedSearch>false</HasCompletedSearch>
<Id>0</Id>
<PepError>false</PepError>
<Reference>String</Reference>
<Replaced>false</Replaced>
<ReplacementSearchId>0</ReplacementSearchId>
<Score>0</Score>
<SearchCriteria>
<Address>String</Address>
<DateOfBirth>0001-01-01T00:00:00</DateOfBirth>
<FullName>String</FullName>
<Gender>String</Gender>
</SearchCriteria>
<Status>String</Status>
<Type>0</Type>
</SearchRecord>
</SearchRecords>
<TotalSearchRecords>0</TotalSearchRecords>
</Data>
</GetValidIdsResponse>
</soap12:Body>
</soap12:Envelope>