| GET | /validid/template |
|---|
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using SanctionsSearch.Api2.ServiceModel.Operations.ValidId;
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.ValidId
{
public partial class 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")]
public virtual string SubUserName { get; set; }
public virtual string Type { get; set; }
public virtual bool AddPepSearch { get; set; }
public virtual string PepSearchType { get; set; }
public virtual bool AddSanctionsSearch { get; set; }
public virtual ArrayOfLists SelectedLists { get; set; }
public virtual string Reference { 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")]
public virtual ArrayOfLinkedTo LinkedTo { get; set; }
public virtual ValidIdBasicRequest BasicRequest { get; set; }
public virtual ValidIdPassportRequest PassportRequest { get; set; }
public virtual ValidIdDrivingRequest DrivingRequest { get; set; }
public virtual ValidIdBirthRequest BirthRequest { get; set; }
public virtual ValidIdNIRequest NIRequest { get; set; }
public virtual ValidIdNHSRequest NHSRequest { get; set; }
public virtual ValidIdElectricityRequest ElectricityRequest { get; set; }
public virtual ValidIdBankRequest BankRequest { get; set; }
public virtual ValidIdCardNumberRequest CardNumberRequest { get; set; }
public virtual ValidIdTravelVisaRequest TravelVisaRequest { get; set; }
public virtual ValidIdIdCardRequest IdCardRequest { get; set; }
public virtual ValidIdPollNumberRequest PollNumberRequest { get; set; }
public virtual ValidIdMarriageRequest MarriageRequest { get; set; }
public virtual bool PassportEnabled { get; set; }
public virtual bool PassportChipEnabled { get; set; }
public virtual bool DrivingEnabled { get; set; }
public virtual bool SmartlinkEnabled { get; set; }
public virtual bool NIEnabled { get; set; }
public virtual bool NHSEnabled { get; set; }
public virtual bool ElectricityEnabled { get; set; }
public virtual bool BankEnabled { get; set; }
public virtual bool CreditActiveEnabled { get; set; }
public virtual bool IdCardEnabled { get; set; }
public virtual bool BankLiveEnabled { get; set; }
public virtual bool CompanyDirectorEnabled { get; set; }
public virtual bool SearchActivityEnabled { get; set; }
public virtual bool PRSEnabled { get; set; }
}
[DataContract]
public partial class AddValidIdTemplate
: BaseRequest
{
[DataMember]
[ApiMember(IsRequired=true)]
public virtual int ClientId { get; set; }
}
public partial class AddValidIdTemplateData
: BaseResponse
{
public virtual AddValidIdRequest Request { get; set; }
}
[DataContract]
public partial class AddValidIdTemplateResponse
{
[DataMember]
public virtual AddValidIdTemplateData Data { get; set; }
}
}
namespace SanctionsSearch.Api2.ServiceModel.Types
{
public partial class ArrayOfLinkedTo
: List<LinkedTo>
{
}
public partial class ArrayOfLists
: List<string>
{
}
[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 LinkedTo
{
public virtual int? ClientId { get; set; }
public virtual long? Id { get; set; }
public virtual string Type { get; set; }
public virtual string Subtype { get; set; }
public virtual string Status { get; set; }
public virtual string Description { get; set; }
public virtual bool? IsArchived { get; set; }
public virtual string Name { get; set; }
public virtual DateTime? Date { get; set; }
}
public partial class ValidIdBankRequest
{
public virtual string BankSortCode { get; set; }
public virtual string BankAccountNumber { get; set; }
}
public partial class ValidIdBasicRequest
{
public virtual string Name1 { get; set; }
public virtual string Name2 { get; set; }
public virtual string Name3 { get; set; }
public virtual DateTime? DateOfBirth { get; set; }
public virtual string Gender { get; set; }
public virtual string Address1 { get; set; }
public virtual string Address2 { get; set; }
public virtual string Address3 { get; set; }
public virtual string Address4 { get; set; }
public virtual string Address5 { get; set; }
public virtual string PostCode { get; set; }
}
public partial class ValidIdBirthRequest
{
public virtual string BirthForeName { get; set; }
public virtual string BirthMiddleName { get; set; }
public virtual string BirthSurname { get; set; }
public virtual string BirthMaidenName { get; set; }
public virtual string BirthDistrict { get; set; }
public virtual string BirthCertIssueNum { get; set; }
}
public partial class ValidIdCardNumberRequest
{
public virtual string CardNumber { get; set; }
public virtual string CardType { get; set; }
}
public partial class ValidIdDrivingRequest
{
public virtual string Driving1 { get; set; }
public virtual string Driving2 { get; set; }
public virtual string Driving3 { get; set; }
public virtual string DrivingPostcode { get; set; }
public virtual string DrivingMailSort { get; set; }
}
public partial class ValidIdElectricityRequest
{
public virtual string MPANNumber1 { get; set; }
public virtual string MPANNumber2 { get; set; }
public virtual string MPANNumber3 { get; set; }
public virtual string MPANNumber4 { get; set; }
}
public partial class ValidIdIdCardRequest
{
public virtual string IdCard1 { get; set; }
public virtual string IdCard2 { get; set; }
public virtual string IdCard3 { get; set; }
public virtual string IdCard4 { get; set; }
public virtual string IdCard5 { get; set; }
public virtual string IdCard6 { get; set; }
public virtual string IdCard7 { get; set; }
public virtual string IdCard8 { get; set; }
public virtual string IdCard9 { get; set; }
public virtual string IdCard10 { get; set; }
}
public partial class ValidIdMarriageRequest
{
public virtual string Forename { get; set; }
public virtual string Surname { get; set; }
public virtual string PartnerForename { get; set; }
public virtual string PartnerSurname { get; set; }
public virtual string Date { get; set; }
public virtual string District { get; set; }
public virtual string CertIssueNum { get; set; }
}
public partial class ValidIdNHSRequest
{
public virtual string NHSNumber { get; set; }
}
public partial class ValidIdNIRequest
{
public virtual string NINumber { get; set; }
}
public partial class ValidIdPassportRequest
{
public virtual string Passport1 { get; set; }
public virtual string Passport2 { get; set; }
public virtual string Passport3 { get; set; }
public virtual string Passport4 { get; set; }
public virtual string Passport5 { get; set; }
public virtual string Passport6 { get; set; }
public virtual string Passport7 { get; set; }
public virtual string Passport8 { get; set; }
public virtual string PassportMrzLineOne1 { get; set; }
public virtual string PassportMrzLineOne2 { get; set; }
public virtual string PassportMrzLineOne3 { get; set; }
}
public partial class ValidIdPollNumberRequest
{
public virtual string PollNumber { get; set; }
}
public partial class ValidIdTravelVisaRequest
{
public virtual string TravelVisa1 { get; set; }
public virtual string TravelVisa2 { get; set; }
public virtual string TravelVisa3 { get; set; }
public virtual string TravelVisa4 { get; set; }
public virtual string TravelVisa5 { get; set; }
public virtual string TravelVisa6 { get; set; }
public virtual string TravelVisa7 { get; set; }
public virtual string TravelVisa8 { get; set; }
public virtual string TravelVisa9 { 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"}}}}