Deletion

deletePerson

delete

This method deletes a person from the database, given its CPF.

Path parameters

cpfstringRequired

Responses

200

OK

*/*

204

No Content

400

Bad Request

*/*

401

Unauthorized

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

415

Unsupported Media Type

*/*

422

Unprocessable Entity

*/*

500

Internal Server Error

*/*

503

Service Unavailable

*/*

delete

HTTPcURLJavaScriptPython

DELETE /gbs-spid-server/delete/{cpf} HTTP/1.1
Host: <ip>:8082
Accept: */*

{
  "id": "text",
  "message": "text",
  "status": "OK"
}

deletePSBioPerson

delete

This method deletes a person from the PSBio database, given its CPF and MOT (reason for deletion, error or fraud).

Path parameters

cpfstringRequired

motstring · enumRequiredPossible values:

Responses

200

OK

*/*

204

No Content

400

Bad Request

*/*

401

Unauthorized

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

415

Unsupported Media Type

*/*

422

Unprocessable Entity

*/*

500

Internal Server Error

*/*

503

Service Unavailable

*/*

delete

HTTPcURLJavaScriptPython

DELETE /gbs-spid-server/delete/{cpf}/{mot} HTTP/1.1
Host: <ip>:8082
Accept: */*

{
  "id": "text",
  "message": "text",
  "status": "OK"
}

getDeleteResult

get

This method returns the status of a delete transaction, given its TGUID (ID).

Path parameters

idstringRequired

Responses

200

OK

*/*

400

Bad Request

*/*

401

Unauthorized

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

415

Unsupported Media Type

*/*

422

Unprocessable Entity

*/*

500

Internal Server Error

*/*

503

Service Unavailable

*/*

get

HTTPcURLJavaScriptPython

GET /gbs-spid-server/delete/{id} HTTP/1.1
Host: <ip>:8082
Accept: */*

{
  "id": "text",
  "message": "text",
  "status": "OK"
}