Sanctions Search API: v2

DeleteSubUser

Account

The following routes are available for this service:
DELETE	/subusers/delete	Delete a sub user


// @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 DeleteSubUserData extends BaseResponse
{
    /** @description Was the delete successful? */
    // @ApiMember(Description="Was the delete successful?")
    public success: boolean;

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

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

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

// @DataContract
export class DeleteSubUser extends BaseRequest
{
    /** @description The user id of the sub user to delete */
    // @DataMember
    // @ApiMember(Description="The user id of the sub user to delete", IsRequired=true, ParameterType="query")
    public deleteUserId: string;

    /** @description The user id of the user to transfer the sub user's existing searches to */
    // @DataMember
    // @ApiMember(Description="The user id of the user to transfer the sub user's existing searches to", IsRequired=true, ParameterType="query")
    public transferToUserId: string;

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

TypeScript DeleteSubUser DTOs

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

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

DELETE /subusers/delete HTTP/1.1 
Host: api.sanctionssearch.com 
Accept: application/json

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"}}}}