Private Data REST Services
This section contains details about the REST Services flavor of the Private Data Services and Tools documented by framework team.
Retailers must call the Private Data REST Service endpoints with the following request headers:
Table 5-11 Request Header
Name | Value | Required | Description |
---|---|---|---|
Accept |
application/json OR application/xml |
Yes |
Tells the server the MIME-type of the re-source. |
Authorization |
Base64 encoded credentials string |
Yes |
Authenticates a user agent with the server |
List of Endpoints
The table below shows the details of calling the Private Data Service APIs through REST endpoints:
Action | Endpoint Path | Description |
---|---|---|
Get a List of Query Group Types |
/privatedata/config/{action} |
Returns the valid ID types that can be used in private data calls. Method
Accept
Path Parameters
Response Codes
Success Payloads { "types": [ "raf", "supplier", "customer" ] } |
Get Query Group Type Information (for example, Lookup customer ID) |
/privatedata/config/{action}/ {id_type} |
Returns details of the query group type including the customer ID format required to access or re-move PII data. Method
Accept
Path Parameters
Response Codes
Success Payloads { "customerIdFormat": "{%cus-tomer-Id%}::{%divisionId%}::{%groupId%}", "type": "customer" } |
Access PII |
/privatedata/{id_type} |
Retrieves PII in the system Method
Accept
Path Parameters
Query Parameters
Response Codes and Error Mes-sages
Success Payloads
|
Remove PII |
/privatedata/{id_type} |
Removes PII from the system. Method
Accept
Path Parameters
Query Parameters
Response Codes
|
Validate If PII Can Be Removed |
/privatedata/{id_type}/ validate-Forget |
Validates whether a customer can be removed from the system. Method
Accept
Path Parameters
Query Parameters
Response Codes
|
Output Format for Accessing PII
The following output formats are supported by the REST endpoint for accessing PII:
Format | Description |
---|---|
Concise JSON (default) |
Human readable JSON format. Concise but cannot be parsed into a generic stucture at runtime. |
Full JSON |
Full JSON format that can be parsed electronically. Ideal for importing data into the system (a future functionality) |
Human Readable HTML |
Human readable HTML format. |