GET | /account/eula | Get the account EULA & status |
---|
"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 GetEulaStatusData extends BaseResponse {
/** @param {{termsAndConditions?:string,privacyPolicy?:string,agreeToContact?:boolean,agreeToContactInfo?:string,agreeToContactDate?:string,agreeToTerms?:boolean,agreeToTermsInfo?:string,agreeToTermsDate?:string,agreeToDataProtection?:boolean,agreeToDataProtectionInfo?:string,agreeToDataProtectionDate?:string,responseStatus?:ResponseStatus}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/** @type {string} */
termsAndConditions;
/** @type {string} */
privacyPolicy;
/** @type {boolean} */
agreeToContact;
/** @type {string} */
agreeToContactInfo;
/** @type {?string} */
agreeToContactDate;
/** @type {boolean} */
agreeToTerms;
/** @type {string} */
agreeToTermsInfo;
/** @type {?string} */
agreeToTermsDate;
/** @type {boolean} */
agreeToDataProtection;
/** @type {string} */
agreeToDataProtectionInfo;
/** @type {?string} */
agreeToDataProtectionDate;
}
export class GetEulaStatusResponse {
/** @param {{data?:GetEulaStatusData}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {GetEulaStatusData} */
data;
}
export class GetEulaStatus extends BaseRequest {
/** @param {{subUserName?:string,authentication?:Authentication}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/**
* @type {string}
* @description If this is specified, the information will be for the specified sub user, otherwise it will be for the main user account */
subUserName;
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /account/eula HTTP/1.1 Host: api.sanctionssearch.com Accept: application/xml
HTTP/1.1 200 OK Content-Type: application/xml Content-Length: length <GetEulaStatusResponse 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> <AgreeToContact>false</AgreeToContact> <AgreeToContactDate>0001-01-01T00:00:00</AgreeToContactDate> <AgreeToContactInfo>String</AgreeToContactInfo> <AgreeToDataProtection>false</AgreeToDataProtection> <AgreeToDataProtectionDate>0001-01-01T00:00:00</AgreeToDataProtectionDate> <AgreeToDataProtectionInfo>String</AgreeToDataProtectionInfo> <AgreeToTerms>false</AgreeToTerms> <AgreeToTermsDate>0001-01-01T00:00:00</AgreeToTermsDate> <AgreeToTermsInfo>String</AgreeToTermsInfo> <PrivacyPolicy>String</PrivacyPolicy> <TermsAndConditions>String</TermsAndConditions> </Data> </GetEulaStatusResponse>