Sanctions Search API: v2

<back to all web services

GetProofOfDocumentCategories

import java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    @DataContract
    public static class GetProofOfDocumentCategories extends BaseRequest
    {
        @DataMember
        public Boolean onlyDefaults = null;
        
        public Boolean isOnlyDefaults() { return onlyDefaults; }
        public GetProofOfDocumentCategories setOnlyDefaults(Boolean value) { this.onlyDefaults = value; return this; }
    }

    @DataContract
    public static class BaseRequest implements IBaseRequest
    {
        /**
        * The authentication credentials
        */
        @DataMember
        @ApiMember(Description="The authentication credentials", IsRequired=true, ParameterType="header, body")
        public Authentication authentication = null;
        
        public Authentication getAuthentication() { return authentication; }
        public BaseRequest setAuthentication(Authentication value) { this.authentication = value; return this; }
    }

    @DataContract
    public static class Authentication
    {
        /**
        * The API User ID provided by us when you signed up to use our API
        */
        @DataMember
        @ApiMember(Description="The API User ID provided by us when you signed up to use our API", IsRequired=true, ParameterType="header, body")
        public String apiUserId = null;

        /**
        * The API User Key provided by us when you signed up to use our API
        */
        @DataMember
        @ApiMember(Description="The API User Key provided by us when you signed up to use our API", IsRequired=true, ParameterType="header, body")
        public String apiUserKey = null;
        
        public String getApiUserId() { return apiUserId; }
        public Authentication setApiUserId(String value) { this.apiUserId = value; return this; }
        public String getApiUserKey() { return apiUserKey; }
        public Authentication setApiUserKey(String value) { this.apiUserKey = value; return this; }
    }

    @DataContract
    public static class GetProofOfDocumentCategoriesResponse
    {
        @DataMember
        public GetProofOfDocumentCategoriesData data = null;
        
        public GetProofOfDocumentCategoriesData getData() { return data; }
        public GetProofOfDocumentCategoriesResponse setData(GetProofOfDocumentCategoriesData value) { this.data = value; return this; }
    }

    public static class GetProofOfDocumentCategoriesData extends BaseResponse
    {
        public ArrayOfProofOfDocumentCategories proofOfDocumentCategories = null;
        
        public ArrayOfProofOfDocumentCategories getProofOfDocumentCategories() { return proofOfDocumentCategories; }
        public GetProofOfDocumentCategoriesData setProofOfDocumentCategories(ArrayOfProofOfDocumentCategories value) { this.proofOfDocumentCategories = value; return this; }
    }

    public static class BaseResponse implements IBaseDataResponse, IHasResponseStatus
    {
        /**
        * The status of the response
        */
        @ApiMember(Description="The status of the response")
        public ResponseStatus responseStatus = null;
        
        public ResponseStatus getResponseStatus() { return responseStatus; }
        public BaseResponse setResponseStatus(ResponseStatus value) { this.responseStatus = value; return this; }
    }

    public static class ArrayOfResponseError extends ArrayList<ResponseError>
    {
        
    }

    public static class ArrayOfProofOfDocumentCategories extends ArrayList<ProofOfDocumentCategory>
    {
        
    }

    public static class ProofOfDocumentCategory
    {
        /**
        * The ID of the ProofOfDocumentCategory
        */
        @ApiMember(Description="The ID of the ProofOfDocumentCategory", IsRequired=true)
        public Integer id = null;

        /**
        * The category or subject that requires proof (e.g., 'Name', 'Address', 'Right to work')
        */
        @ApiMember(Description="The category or subject that requires proof (e.g., 'Name', 'Address', 'Right to work')", IsRequired=true)
        public String proofOf = null;

        /**
        * The documents that can be used to provide proof for the specified category.
        */
        @ApiMember(Description="The documents that can be used to provide proof for the specified category.", IsRequired=true)
        public ArrayOfProofOfDocuments proofOfDocuments = null;
        
        public Integer getId() { return id; }
        public ProofOfDocumentCategory setId(Integer value) { this.id = value; return this; }
        public String getProofOf() { return proofOf; }
        public ProofOfDocumentCategory setProofOf(String value) { this.proofOf = value; return this; }
        public ArrayOfProofOfDocuments getProofOfDocuments() { return proofOfDocuments; }
        public ProofOfDocumentCategory setProofOfDocuments(ArrayOfProofOfDocuments value) { this.proofOfDocuments = value; return this; }
    }

    public static class ArrayOfProofOfDocuments extends ArrayList<ProofOfDocument>
    {
        
    }

    public static class ProofOfDocument
    {
        /**
        * The ID of the ProofOfDocument
        */
        @ApiMember(Description="The ID of the ProofOfDocument", IsRequired=true)
        public Integer id = null;

        /**
        * The name of the ProofOfDocument
        */
        @ApiMember(Description="The name of the ProofOfDocument", IsRequired=true)
        public String name = null;
        
        public Integer getId() { return id; }
        public ProofOfDocument setId(Integer value) { this.id = value; return this; }
        public String getName() { return name; }
        public ProofOfDocument setName(String value) { this.name = value; return this; }
    }

}

Java GetProofOfDocumentCategories DTOs

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

HTTP + 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>

<GetProofOfDocumentCategories xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
  <Authentication>
    <ApiUserId>String</ApiUserId>
    <ApiUserKey>String</ApiUserKey>
  </Authentication>
  <OnlyDefaults>false</OnlyDefaults>
</GetProofOfDocumentCategories>

</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>

<GetProofOfDocumentCategoriesResponse 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>
</GetProofOfDocumentCategoriesResponse>

</soap12:Body>
</soap12:Envelope>