| GET | /validid/template |
|---|
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 ArrayOfLists() =
inherit ResizeArray<String>()
[<AllowNullLiteral>]
type LinkedTo() =
member val ClientId:Nullable<Int32> = new Nullable<Int32>() with get,set
member val Id:Nullable<Int64> = new Nullable<Int64>() with get,set
member val Type:String = null with get,set
member val Subtype:String = null with get,set
member val Status:String = null with get,set
member val Description:String = null with get,set
member val IsArchived:Nullable<Boolean> = new Nullable<Boolean>() with get,set
member val Name:String = null with get,set
member val Date:Nullable<DateTime> = new Nullable<DateTime>() with get,set
[<AllowNullLiteral>]
type ArrayOfLinkedTo() =
inherit ResizeArray<LinkedTo>()
[<AllowNullLiteral>]
type ValidIdBasicRequest() =
member val Name1:String = null with get,set
member val Name2:String = null with get,set
member val Name3:String = null with get,set
member val DateOfBirth:Nullable<DateTime> = new Nullable<DateTime>() with get,set
member val Gender:String = null with get,set
member val Address1:String = null with get,set
member val Address2:String = null with get,set
member val Address3:String = null with get,set
member val Address4:String = null with get,set
member val Address5:String = null with get,set
member val PostCode:String = null with get,set
[<AllowNullLiteral>]
type ValidIdPassportRequest() =
member val Passport1:String = null with get,set
member val Passport2:String = null with get,set
member val Passport3:String = null with get,set
member val Passport4:String = null with get,set
member val Passport5:String = null with get,set
member val Passport6:String = null with get,set
member val Passport7:String = null with get,set
member val Passport8:String = null with get,set
member val PassportMrzLineOne1:String = null with get,set
member val PassportMrzLineOne2:String = null with get,set
member val PassportMrzLineOne3:String = null with get,set
[<AllowNullLiteral>]
type ValidIdDrivingRequest() =
member val Driving1:String = null with get,set
member val Driving2:String = null with get,set
member val Driving3:String = null with get,set
member val DrivingPostcode:String = null with get,set
member val DrivingMailSort:String = null with get,set
[<AllowNullLiteral>]
type ValidIdBirthRequest() =
member val BirthForeName:String = null with get,set
member val BirthMiddleName:String = null with get,set
member val BirthSurname:String = null with get,set
member val BirthMaidenName:String = null with get,set
member val BirthDistrict:String = null with get,set
member val BirthCertIssueNum:String = null with get,set
[<AllowNullLiteral>]
type ValidIdNIRequest() =
member val NINumber:String = null with get,set
[<AllowNullLiteral>]
type ValidIdNHSRequest() =
member val NHSNumber:String = null with get,set
[<AllowNullLiteral>]
type ValidIdElectricityRequest() =
member val MPANNumber1:String = null with get,set
member val MPANNumber2:String = null with get,set
member val MPANNumber3:String = null with get,set
member val MPANNumber4:String = null with get,set
[<AllowNullLiteral>]
type ValidIdBankRequest() =
member val BankSortCode:String = null with get,set
member val BankAccountNumber:String = null with get,set
[<AllowNullLiteral>]
type ValidIdCardNumberRequest() =
member val CardNumber:String = null with get,set
member val CardType:String = null with get,set
[<AllowNullLiteral>]
type ValidIdTravelVisaRequest() =
member val TravelVisa1:String = null with get,set
member val TravelVisa2:String = null with get,set
member val TravelVisa3:String = null with get,set
member val TravelVisa4:String = null with get,set
member val TravelVisa5:String = null with get,set
member val TravelVisa6:String = null with get,set
member val TravelVisa7:String = null with get,set
member val TravelVisa8:String = null with get,set
member val TravelVisa9:String = null with get,set
[<AllowNullLiteral>]
type ValidIdIdCardRequest() =
member val IdCard1:String = null with get,set
member val IdCard2:String = null with get,set
member val IdCard3:String = null with get,set
member val IdCard4:String = null with get,set
member val IdCard5:String = null with get,set
member val IdCard6:String = null with get,set
member val IdCard7:String = null with get,set
member val IdCard8:String = null with get,set
member val IdCard9:String = null with get,set
member val IdCard10:String = null with get,set
[<AllowNullLiteral>]
type ValidIdPollNumberRequest() =
member val PollNumber:String = null with get,set
[<AllowNullLiteral>]
type ValidIdMarriageRequest() =
member val Forename:String = null with get,set
member val Surname:String = null with get,set
member val PartnerForename:String = null with get,set
member val PartnerSurname:String = null with get,set
member val Date:String = null with get,set
member val District:String = null with get,set
member val CertIssueNum:String = null with get,set
[<AllowNullLiteral>]
type AddValidIdRequest() =
///<summary>
///If the search should be saved against a single Sub User account, specify their username here
///</summary>
[<ApiMember(Description="If the search should be saved against a single Sub User account, specify their username here")>]
member val SubUserName:String = null with get,set
member val Type:String = null with get,set
member val AddPepSearch:Boolean = new Boolean() with get,set
member val PepSearchType:String = null with get,set
member val AddSanctionsSearch:Boolean = new Boolean() with get,set
member val SelectedLists:ArrayOfLists = null with get,set
member val Reference:String = null with get,set
///<summary>
///If the search should be linked to other searches, specify the them here
///</summary>
[<ApiMember(Description="If the search should be linked to other searches, specify the them here")>]
member val LinkedTo:ArrayOfLinkedTo = null with get,set
member val BasicRequest:ValidIdBasicRequest = null with get,set
member val PassportRequest:ValidIdPassportRequest = null with get,set
member val DrivingRequest:ValidIdDrivingRequest = null with get,set
member val BirthRequest:ValidIdBirthRequest = null with get,set
member val NIRequest:ValidIdNIRequest = null with get,set
member val NHSRequest:ValidIdNHSRequest = null with get,set
member val ElectricityRequest:ValidIdElectricityRequest = null with get,set
member val BankRequest:ValidIdBankRequest = null with get,set
member val CardNumberRequest:ValidIdCardNumberRequest = null with get,set
member val TravelVisaRequest:ValidIdTravelVisaRequest = null with get,set
member val IdCardRequest:ValidIdIdCardRequest = null with get,set
member val PollNumberRequest:ValidIdPollNumberRequest = null with get,set
member val MarriageRequest:ValidIdMarriageRequest = null with get,set
member val PassportEnabled:Boolean = new Boolean() with get,set
member val PassportChipEnabled:Boolean = new Boolean() with get,set
member val DrivingEnabled:Boolean = new Boolean() with get,set
member val SmartlinkEnabled:Boolean = new Boolean() with get,set
member val NIEnabled:Boolean = new Boolean() with get,set
member val NHSEnabled:Boolean = new Boolean() with get,set
member val ElectricityEnabled:Boolean = new Boolean() with get,set
member val BankEnabled:Boolean = new Boolean() with get,set
member val CreditActiveEnabled:Boolean = new Boolean() with get,set
member val IdCardEnabled:Boolean = new Boolean() with get,set
member val BankLiveEnabled:Boolean = new Boolean() with get,set
member val CompanyDirectorEnabled:Boolean = new Boolean() with get,set
member val SearchActivityEnabled:Boolean = new Boolean() with get,set
member val PRSEnabled:Boolean = new Boolean() with get,set
[<AllowNullLiteral>]
type AddValidIdTemplateData() =
inherit BaseResponse()
member val Request:AddValidIdRequest = null with get,set
[<DataContract>]
[<AllowNullLiteral>]
type AddValidIdTemplateResponse() =
[<DataMember>]
member val Data:AddValidIdTemplateData = 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
[<DataContract>]
[<AllowNullLiteral>]
type AddValidIdTemplate() =
inherit BaseRequest()
[<DataMember>]
[<ApiMember(IsRequired=true)>]
member val ClientId:Int32 = new Int32() with get,set
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
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /validid/template HTTP/1.1 Host: api.sanctionssearch.com Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"data":{"request":{"subUserName":"String","type":"String","addPepSearch":false,"pepSearchType":"String","addSanctionsSearch":false,"selectedLists":["String"],"reference":"String","linkedTo":[{"clientId":0,"id":0,"type":"String","subtype":"String","status":"String","description":"String","isArchived":false,"name":"String","date":"\/Date(-62135596800000-0000)\/"}],"basicRequest":{"name1":"String","name2":"String","name3":"String","dateOfBirth":"\/Date(-62135596800000-0000)\/","gender":"String","address1":"String","address2":"String","address3":"String","address4":"String","address5":"String","postCode":"String"},"passportRequest":{"passport1":"String","passport2":"String","passport3":"String","passport4":"String","passport5":"String","passport6":"String","passport7":"String","passport8":"String","passportMrzLineOne1":"String","passportMrzLineOne2":"String","passportMrzLineOne3":"String"},"drivingRequest":{"driving1":"String","driving2":"String","driving3":"String","drivingPostcode":"String","drivingMailSort":"String"},"birthRequest":{"birthForeName":"String","birthMiddleName":"String","birthSurname":"String","birthMaidenName":"String","birthDistrict":"String","birthCertIssueNum":"String"},"niRequest":{"niNumber":"String"},"nhsRequest":{"nhsNumber":"String"},"electricityRequest":{"mpanNumber1":"String","mpanNumber2":"String","mpanNumber3":"String","mpanNumber4":"String"},"bankRequest":{"bankSortCode":"String","bankAccountNumber":"String"},"cardNumberRequest":{"cardNumber":"String","cardType":"String"},"travelVisaRequest":{"travelVisa1":"String","travelVisa2":"String","travelVisa3":"String","travelVisa4":"String","travelVisa5":"String","travelVisa6":"String","travelVisa7":"String","travelVisa8":"String","travelVisa9":"String"},"idCardRequest":{"idCard1":"String","idCard2":"String","idCard3":"String","idCard4":"String","idCard5":"String","idCard6":"String","idCard7":"String","idCard8":"String","idCard9":"String","idCard10":"String"},"pollNumberRequest":{"pollNumber":"String"},"marriageRequest":{"forename":"String","surname":"String","partnerForename":"String","partnerSurname":"String","date":"String","district":"String","certIssueNum":"String"},"passportEnabled":false,"passportChipEnabled":false,"drivingEnabled":false,"smartlinkEnabled":false,"niEnabled":false,"nhsEnabled":false,"electricityEnabled":false,"bankEnabled":false,"creditActiveEnabled":false,"idCardEnabled":false,"bankLiveEnabled":false,"companyDirectorEnabled":false,"searchActivityEnabled":false,"prsEnabled":false},"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}}