Delete Person

Introduction

This API deletes the specified person.

Method

Service Name

Service Type

DELETE

personManagement/v1/person

URI: https://api.blackhawknetwork.com/personManagement/v1/person/{personId}

Request Header Attributes

All of these header attributes are optional; however, if a client wants idempotency support then they should specify all three on every request.

Name

Type

Mandatory

Description

requestorId

String

N

A value defined by the client application that can be used to uniquely identify that client application. If the client application does not specify a value, a globally unique identifier will be filled in automatically.

requestId

String

N

A value defined by the client application that can be used to uniquely identify that specific request from the client. This value should be set if the client application wants to take advantage of an idempotent operation on a service.

previousAttempts

Integer

N

The number of times this same request has been attempted unsuccessfully before. A value that is greater than zero will cause the service to view this request as a retry attempt and it will be treated idempotently.

Request Elements

Name

Type

Required

Description

personId

String

Yes

The internal identifier of the person.

Response Elements

None

Error Codes

HTTP Code

Error Code

Description

404

attempt.to.delete.nonexistent.enity

Entity does not exist

Sample Request and Response

DELETE /personManagement/v1/person/V8YMC84NYQLR54Z0V1F0NBST70 HTTP/1.1
requestorId: RZ2JMRQW0SM680Q0MF2M8FBFMR
Content-Type: application/json; charset=UTF-8
Accept: application/json; charset=UTF-8
Host: api.blackhawknetwork.com
Connection: Keep-Alive
User-Agent: Apache-HttpClient/4.2 (java 1.5)
HTTP/1.1 204 No Content
Date: Fri, 06 Jul 2012 20:34:01 GMT
Content-Length: 0
Keep-Alive: timeout=5, max=100
Connection: Keep-Alive

Did this page help you?