| GET | /clients/template | Get a template for adding a client |
|---|
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using SanctionsSearch.Api2.ServiceModel.Operations.Clients;
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.Clients
{
public partial class AddClientRequest
{
///<summary>
///The full name of the client
///</summary>
[ApiMember(Description="The full name of the client", IsRequired=true)]
public virtual string Name { get; set; }
///<summary>
///The email address of the client
///</summary>
[ApiMember(Description="The email address of the client", IsRequired=true)]
public virtual string Email { get; set; }
///<summary>
///The client's mobile phone number in international format (e.g. '+447123456789')
///</summary>
[ApiMember(Description="The client's mobile phone number in international format (e.g. '+447123456789')", IsRequired=true)]
public virtual string MobileInternational { get; set; }
///<summary>
///The postal code of the client's address. Used in emails sent to the client to help them recognize the communication as genuine
///</summary>
[ApiMember(Description="The postal code of the client's address. Used in emails sent to the client to help them recognize the communication as genuine", IsRequired=true)]
public virtual string PostCode { get; set; }
///<summary>
///Specifies the type of ValidateMe preset. Possible values are 'ValidateMe' for configuring RequiredDocuments, or 'PassportChipVerification' for setting the Passport as Proof of Name
///</summary>
[ApiMember(Description="Specifies the type of ValidateMe preset. Possible values are 'ValidateMe' for configuring RequiredDocuments, or 'PassportChipVerification' for setting the Passport as Proof of Name", IsRequired=true)]
public virtual CreateMobileClientType ProofOfPreset { get; set; }
///<summary>
///The categories of proof and selected documents that the client can use to provide proof. Required if ClientType is set to 'ValidateMe'
///</summary>
[ApiMember(Description="The categories of proof and selected documents that the client can use to provide proof. Required if ClientType is set to 'ValidateMe'")]
public virtual ArrayOfProofOfDocumentCategories ProofOfDocumentCategories { get; set; }
///<summary>
///If the client should be linked to other searches, specify the them here
///</summary>
[ApiMember(Description="If the client should be linked to other searches, specify the them here")]
public virtual ArrayOfLinkedTo LinkedTo { get; set; }
}
[DataContract]
public partial class AddClientTemplate
: BaseRequest
{
}
public partial class AddClientTemplateData
: BaseResponse
{
public virtual AddClientRequest Request { get; set; }
}
[DataContract]
public partial class AddClientTemplateResponse
{
[DataMember]
public virtual AddClientTemplateData Data { get; set; }
}
}
namespace SanctionsSearch.Api2.ServiceModel.Types
{
public partial class ArrayOfLinkedTo
: List<LinkedTo>
{
}
public partial class ArrayOfProofOfDocumentCategories
: List<ProofOfDocumentCategory>
{
}
public partial class ArrayOfProofOfDocuments
: List<ProofOfDocument>
{
}
[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; }
}
[DataContract(Name="CreateMobileClientType", Namespace="http://schemas.servicestack.net/types")]
public enum CreateMobileClientType
{
Undefined,
ValidateMe,
PassportChipVerification,
}
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 ProofOfDocument
{
///<summary>
///The ID of the ProofOfDocument
///</summary>
[ApiMember(Description="The ID of the ProofOfDocument", IsRequired=true)]
public virtual int Id { get; set; }
///<summary>
///The name of the ProofOfDocument
///</summary>
[ApiMember(Description="The name of the ProofOfDocument", IsRequired=true)]
public virtual string Name { get; set; }
}
public partial class ProofOfDocumentCategory
{
///<summary>
///The ID of the ProofOfDocumentCategory
///</summary>
[ApiMember(Description="The ID of the ProofOfDocumentCategory", IsRequired=true)]
public virtual int Id { get; set; }
///<summary>
///The category or subject that requires proof (e.g., 'Name', 'Address', 'Right to work')
///</summary>
[ApiMember(Description="The category or subject that requires proof (e.g., 'Name', 'Address', 'Right to work')", IsRequired=true)]
public virtual string ProofOf { get; set; }
///<summary>
///The documents that can be used to provide proof for the specified category.
///</summary>
[ApiMember(Description="The documents that can be used to provide proof for the specified category.", IsRequired=true)]
public virtual ArrayOfProofOfDocuments ProofOfDocuments { 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 /clients/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":{"name":"String","email":"String","mobileInternational":"String","postCode":"String","proofOfPreset":"Undefined","proofOfDocumentCategories":[{"id":0,"proofOf":"String","proofOfDocuments":[{"id":0,"name":"String"}]}],"linkedTo":[{"clientId":0,"id":0,"type":"String","subtype":"String","status":"String","description":"String","isArchived":false,"name":"String","date":"\/Date(-62135596800000-0000)\/"}]},"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}}