Sanctions Search API: v2

<back to all web services

GetCompanyLookups

"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 SearchCriteria {
    /** @param {{name?:string,address?:string,country?:string,dateOfBirth?:string,nationality?:string,reference?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    name;
    /** @type {string} */
    address;
    /** @type {string} */
    country;
    /** @type {string} */
    dateOfBirth;
    /** @type {string} */
    nationality;
    /** @type {string} */
    reference;
}
export class ArrayOfLists extends Array {
    constructor(init) { super(init); Object.assign(this, init) }
}
export class CompanyLookupListItem {
    /** @param {{id?:number,searchCriteria?:SearchCriteria,selectedLists?:ArrayOfLists,date?:string,hasCompanyId?:boolean,hasCompanyDetails?:boolean,hasStartedSearches?:boolean,hasCompletedSearches?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    id;
    /** @type {SearchCriteria} */
    searchCriteria;
    /** @type {ArrayOfLists} */
    selectedLists;
    /** @type {string} */
    date;
    /** @type {boolean} */
    hasCompanyId;
    /** @type {boolean} */
    hasCompanyDetails;
    /** @type {boolean} */
    hasStartedSearches;
    /** @type {boolean} */
    hasCompletedSearches;
}
export class ArrayOfCompanyLookupListItem extends Array {
    constructor(init) { super(init); Object.assign(this, init) }
}
export class GetCompanyLookupsData extends BaseResponse {
    /** @param {{totalRecords?:number,currentPageNum?:number,maxPageNum?:number,companyLookupRecords?:ArrayOfCompanyLookupListItem,responseStatus?:ResponseStatus}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {number} */
    totalRecords;
    /** @type {number} */
    currentPageNum;
    /** @type {number} */
    maxPageNum;
    /** @type {ArrayOfCompanyLookupListItem} */
    companyLookupRecords;
}
export class GetCompanyLookupsResponse {
    /** @param {{data?:GetCompanyLookupsData}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {GetCompanyLookupsData} */
    data;
}
export class GetCompanyLookupsRequest {
    /** @param {{subUserName?:string,listIncompleteSearches?:boolean,page?:number,sortOrder?:string,nameSearch?:string,filterReference?:string,filterDateFrom?:string,filterDateTo?:string,filterUserName?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description If the searches are being accessed by a sub user, specify their username here to only return searches they have permissions to view */
    subUserName;
    /** @type {boolean} */
    listIncompleteSearches;
    /** @type {number} */
    page;
    /** @type {string} */
    sortOrder;
    /** @type {string} */
    nameSearch;
    /** @type {string} */
    filterReference;
    /** @type {?string} */
    filterDateFrom;
    /** @type {?string} */
    filterDateTo;
    /**
     * @type {string}
     * @description If set, will only return searches created by the user */
    filterUserName;
}
export class GetCompanyLookups extends BaseRequest {
    /** @param {{request?:GetCompanyLookupsRequest,authentication?:Authentication}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {GetCompanyLookupsRequest} */
    request;
}

JavaScript GetCompanyLookups DTOs

POST /companylookups/list HTTP/1.1 
Host: api.sanctionssearch.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<GetCompanyLookups xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
  <Authentication>
    <ApiUserId>String</ApiUserId>
    <ApiUserKey>String</ApiUserKey>
  </Authentication>
  <Request>
    <FilterDateFrom>0001-01-01T00:00:00</FilterDateFrom>
    <FilterDateTo>0001-01-01T00:00:00</FilterDateTo>
    <FilterReference>String</FilterReference>
    <FilterUserName>String</FilterUserName>
    <ListIncompleteSearches>false</ListIncompleteSearches>
    <NameSearch>String</NameSearch>
    <Page>0</Page>
    <SortOrder>String</SortOrder>
    <SubUserName>String</SubUserName>
  </Request>
</GetCompanyLookups>

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

<GetCompanyLookupsResponse 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>
    <CompanyLookupRecords>
      <CompanyLookupRecord>
        <Date>0001-01-01T00:00:00</Date>
        <HasCompanyDetails>false</HasCompanyDetails>
        <HasCompanyId>false</HasCompanyId>
        <HasCompletedSearches>false</HasCompletedSearches>
        <HasStartedSearches>false</HasStartedSearches>
        <Id>0</Id>
        <SearchCriteria>
          <Address>String</Address>
          <Country>String</Country>
          <DateOfBirth>String</DateOfBirth>
          <Name>String</Name>
          <Nationality>String</Nationality>
          <Reference>String</Reference>
        </SearchCriteria>
        <SelectedLists>
          <ListId>String</ListId>
        </SelectedLists>
      </CompanyLookupRecord>
    </CompanyLookupRecords>
    <CurrentPageNum>0</CurrentPageNum>
    <MaxPageNum>0</MaxPageNum>
    <TotalRecords>0</TotalRecords>
  </Data>
</GetCompanyLookupsResponse>