GET | /account/eula | Get the account EULA & status |
---|
// @DataContract
export class Authentication
{
/** @description 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 apiUserId: string;
/** @description 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 apiUserKey: string;
public constructor(init?: Partial<Authentication>) { (Object as any).assign(this, init); }
}
// @DataContract
export class BaseRequest implements IBaseRequest
{
/** @description The authentication credentials */
// @DataMember
// @ApiMember(Description="The authentication credentials", IsRequired=true, ParameterType="header, body")
public authentication: Authentication;
public constructor(init?: Partial<BaseRequest>) { (Object as any).assign(this, init); }
}
// @DataContract
export class ResponseError
{
// @DataMember(Order=1)
public errorCode: string;
// @DataMember(Order=2)
public fieldName: string;
// @DataMember(Order=3)
public message: string;
// @DataMember(Order=4)
public meta: { [index: string]: string; };
public constructor(init?: Partial<ResponseError>) { (Object as any).assign(this, init); }
}
export class ArrayOfResponseError extends Array<ResponseError>
{
public constructor(init?: Partial<ArrayOfResponseError>) { super(); (Object as any).assign(this, init); }
}
// @DataContract
export class ResponseStatus
{
// @DataMember(Order=1)
public errorCode: string;
// @DataMember(Order=2)
public message: string;
// @DataMember(Order=3)
public stackTrace: string;
// @DataMember(Order=4)
public errors: ArrayOfResponseError;
// @DataMember(Order=5)
public meta: { [index: string]: string; };
public constructor(init?: Partial<ResponseStatus>) { (Object as any).assign(this, init); }
}
export class BaseResponse implements IBaseDataResponse, IHasResponseStatus
{
/** @description The status of the response */
// @ApiMember(Description="The status of the response")
public responseStatus: ResponseStatus;
public constructor(init?: Partial<BaseResponse>) { (Object as any).assign(this, init); }
}
export class GetEulaStatusData extends BaseResponse
{
public termsAndConditions: string;
public privacyPolicy: string;
public agreeToContact: boolean;
public agreeToContactInfo: string;
public agreeToContactDate?: string;
public agreeToTerms: boolean;
public agreeToTermsInfo: string;
public agreeToTermsDate?: string;
public agreeToDataProtection: boolean;
public agreeToDataProtectionInfo: string;
public agreeToDataProtectionDate?: string;
public constructor(init?: Partial<GetEulaStatusData>) { super(init); (Object as any).assign(this, init); }
}
// @DataContract
export class GetEulaStatusResponse
{
// @DataMember
public data: GetEulaStatusData;
public constructor(init?: Partial<GetEulaStatusResponse>) { (Object as any).assign(this, init); }
}
// @DataContract
export class GetEulaStatus extends BaseRequest
{
/** @description If this is specified, the information will be for the specified sub user, otherwise it will be for the main user account */
// @DataMember
// @ApiMember(Description="If this is specified, the information will be for the specified sub user, otherwise it will be for the main user account")
public subUserName: string;
public constructor(init?: Partial<GetEulaStatus>) { super(init); (Object as any).assign(this, init); }
}
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 /account/eula HTTP/1.1 Host: api.sanctionssearch.com Accept: application/json
HTTP/1.1 200 OK Content-Type: application/json Content-Length: length {"data":{"termsAndConditions":"String","privacyPolicy":"String","agreeToContact":false,"agreeToContactInfo":"String","agreeToContactDate":"\/Date(-62135596800000-0000)\/","agreeToTerms":false,"agreeToTermsInfo":"String","agreeToTermsDate":"\/Date(-62135596800000-0000)\/","agreeToDataProtection":false,"agreeToDataProtectionInfo":"String","agreeToDataProtectionDate":"\/Date(-62135596800000-0000)\/","responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}}