Sanctions Search API: v2

<back to all web services

SaveCompanyLookUp

// @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 SaveCompanyLookUpData extends BaseResponse
{
    /** @description Did the request succeed */
    // @ApiMember(Description="Did the request succeed")
    public success: boolean;

    public constructor(init?: Partial<SaveCompanyLookUpData>) { super(init); (Object as any).assign(this, init); }
}

// @DataContract
export class SaveCompanyLookUpResponse
{
    /** @description The response data */
    // @DataMember
    // @ApiMember(Description="The response data")
    public data: SaveCompanyLookUpData;

    public constructor(init?: Partial<SaveCompanyLookUpResponse>) { (Object as any).assign(this, init); }
}

export class SaveCompanyLookUpRequest
{
    /** @description If the saved document should be kept within a single Sub User account, specify their username here */
    // @ApiMember(Description="If the saved document should be kept within a single Sub User account, specify their username here")
    public subUserName: string;

    /** @description The ID of the search that is being saved */
    // @ApiMember(Description="The ID of the search that is being saved")
    public id: number;

    public constructor(init?: Partial<SaveCompanyLookUpRequest>) { (Object as any).assign(this, init); }
}

// @DataContract
export class SaveCompanyLookUp extends BaseRequest
{
    /** @description The request data */
    // @DataMember
    // @ApiMember(Description="The request data", ParameterType="body")
    public request: SaveCompanyLookUpRequest;

    public constructor(init?: Partial<SaveCompanyLookUp>) { super(init); (Object as any).assign(this, init); }
}

TypeScript SaveCompanyLookUp DTOs

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

{"request":{"subUserName":"String","id":0},"authentication":{"apiUserId":"String","apiUserKey":"String"}}

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

{"data":{"success":false,"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}}