Sanctions Search API: v2

<back to all web services

UpdateDefaultProofOfDocumentCategories

Clients
The following routes are available for this service:
PUT/clients/proofs/defaultsUpdate the configured default categories of proof and their documents
"use strict";
export class Authentication {
    /** @param {{apiUserId?:string,apiUserKey?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description The API User ID provided by us when you signed up to use our API */
    apiUserId;
    /**
     * @type {string}
     * @description The API User Key provided by us when you signed up to use our API */
    apiUserKey;
}
export class BaseRequest {
    /** @param {{authentication?:Authentication}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {Authentication}
     * @description The authentication credentials */
    authentication;
}
export class ResponseError {
    /** @param {{errorCode?:string,fieldName?:string,message?:string,meta?:{ [index: string]: string; }}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    errorCode;
    /** @type {string} */
    fieldName;
    /** @type {string} */
    message;
    /** @type {{ [index: string]: string; }} */
    meta;
}
export class ArrayOfResponseError extends Array {
    constructor(init) { super(init); Object.assign(this, init) }
}
export class ResponseStatus {
    /** @param {{errorCode?:string,message?:string,stackTrace?:string,errors?:ArrayOfResponseError,meta?:{ [index: string]: string; }}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    errorCode;
    /** @type {string} */
    message;
    /** @type {string} */
    stackTrace;
    /** @type {ArrayOfResponseError} */
    errors;
    /** @type {{ [index: string]: string; }} */
    meta;
}
export class BaseResponse {
    /** @param {{responseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {ResponseStatus}
     * @description The status of the response */
    responseStatus;
}
export class ProofOfDocument {
    /** @param {{id?:number,name?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {number}
     * @description The ID of the ProofOfDocument */
    id;
    /**
     * @type {string}
     * @description The name of the ProofOfDocument */
    name;
}
export class ArrayOfProofOfDocuments extends Array {
    constructor(init) { super(init); Object.assign(this, init) }
}
export class ProofOfDocumentCategory {
    /** @param {{id?:number,proofOf?:string,proofOfDocuments?:ArrayOfProofOfDocuments}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {number}
     * @description The ID of the ProofOfDocumentCategory */
    id;
    /**
     * @type {string}
     * @description The category or subject that requires proof (e.g., 'Name', 'Address', 'Right to work') */
    proofOf;
    /**
     * @type {ArrayOfProofOfDocuments}
     * @description The documents that can be used to provide proof for the specified category. */
    proofOfDocuments;
}
export class ArrayOfProofOfDocumentCategories extends Array {
    constructor(init) { super(init); Object.assign(this, init) }
}
export class UpdateDefaultProofOfDocumentCategoriesData extends BaseResponse {
    /** @param {{proofOfDocumentCategories?:ArrayOfProofOfDocumentCategories,responseStatus?:ResponseStatus}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {ArrayOfProofOfDocumentCategories} */
    proofOfDocumentCategories;
}
export class UpdateDefaultProofOfDocumentCategoriesResponse {
    /** @param {{data?:UpdateDefaultProofOfDocumentCategoriesData}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {UpdateDefaultProofOfDocumentCategoriesData} */
    data;
}
export class UpdateDefaultProofOfDocumentCategoriesRequest {
    /** @param {{proofOfDocumentCategories?:ArrayOfProofOfDocumentCategories}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ArrayOfProofOfDocumentCategories} */
    proofOfDocumentCategories;
}
export class UpdateDefaultProofOfDocumentCategories extends BaseRequest {
    /** @param {{request?:UpdateDefaultProofOfDocumentCategoriesRequest,authentication?:Authentication}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {UpdateDefaultProofOfDocumentCategoriesRequest} */
    request;
}

JavaScript UpdateDefaultProofOfDocumentCategories DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

PUT /clients/proofs/defaults HTTP/1.1 
Host: api.sanctionssearch.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<UpdateDefaultProofOfDocumentCategories xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
  <Authentication>
    <ApiUserId>String</ApiUserId>
    <ApiUserKey>String</ApiUserKey>
  </Authentication>
  <Request>
    <ProofOfDocumentCategories>
      <CategoryId>
        <Id>0</Id>
        <ProofOf>String</ProofOf>
        <ProofOfDocuments>
          <DocumentId>
            <Id>0</Id>
            <Name>String</Name>
          </DocumentId>
        </ProofOfDocuments>
      </CategoryId>
    </ProofOfDocumentCategories>
  </Request>
</UpdateDefaultProofOfDocumentCategories>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<UpdateDefaultProofOfDocumentCategoriesResponse 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>
    <ProofOfDocumentCategories>
      <CategoryId>
        <Id>0</Id>
        <ProofOf>String</ProofOf>
        <ProofOfDocuments>
          <DocumentId>
            <Id>0</Id>
            <Name>String</Name>
          </DocumentId>
        </ProofOfDocuments>
      </CategoryId>
    </ProofOfDocumentCategories>
  </Data>
</UpdateDefaultProofOfDocumentCategoriesResponse>