Library Component Questions
Get all Component Questions
This endpoint retrieves a list of Component Questions.
GET /api/v2/library/componentquestions/
Query Parameters
The following parameters may be used to filter the Component Questions in the response.
| Parameter | Description |
|---|---|
| component | Filter Component Questions by its Component ID. |
| search | Filter Component Questions by performing a textual search on its ID, text or description. |
GET /api/v2/library/componentquestions/ HTTP/1.1
Accept: application/json
Authorization: Token "YOUR SDE ACCESS TOKEN"
HTTP/1.1 200 OK
Content-Type: application/json
{
"results": [
{
"id": "AQ1",
"text": "What cardholder data elements are stored?",
"description": "",
"answers": [
"AA1",
"AA2"
],
"component": "SC2",
"created": "2023-08-22T10:47:24.946501-04:00",
"updated": "2023-08-22T15:33:35.874367-04:00",
"db_id": 1
},
{
"id": "AQ2",
"text": "Does this component handle personally identifiable information from citizens of the European Union?",
"description": "",
"answers": [
"AA3"
],
"component": "CSC1",
"created": "2023-08-22T10:47:24.946501-04:00",
"updated": "2023-08-22T15:33:35.874367-04:00",
"db_id": 2
}
]
}
Expand Parameters
See the Expand Parameters section for more details.
| Parameter | Description |
|---|---|
| answers | The answers field is expanded. |
| component | The component field is expanded. |
GET /api/v2/library/componentquestions/?expand=answers,component
Accept: application/json
Authorization: Token: "YOUR SDE ACCESS TOKEN"
HTTP/1.1 200 OK
Content-Type: application/json
{
"results": [
{
"id": "AQ1",
"text": "What cardholder data elements are stored?",
"description": "",
"answers": [
{
"id": 1,
"item_id": "AA1",
"text": "CAV2 / CVC2 / CVV2 / CID",
"description": "",
"attribute": "AT1",
"sub_questions": []
},
{
"id": 2,
"item_id": "AA2",
"text": "Magnetic strip or chip full track data",
"description": "",
"attribute": "AT2",
"sub_questions": "AQ5"
}
],
"component": {
"id": 5,
"item_id": "SC2",
"title": "Generic database"
},
"created": "2023-08-23T15:09:23.690673-04:00",
"updated": "2023-08-23T15:11:35.114961-04:00",
"db_id": 1
},
{
"id": "AQ2",
"text": "Does this component handle personally identifiable information from citizens of the European Union?",
"description": "",
"answers": [
{
"id": 3,
"item_id": "AA3",
"text": "Yes",
"description": "",
"attribute": "AT2",
"sub_questions": ""
}
],
"component": {
"id": 26,
"item_id": "SC23",
"title": "PayPal"
},
"created": "2023-08-22T10:47:24.946501-04:00",
"updated": "2023-08-22T15:33:35.874367-04:00",
"db_id": 2
}
]
}
Get a specific Component Question
This endpoint retrieves a specific Component Question.
GET /api/v2/library/componentquestions/{component_question_id}/
URL Parameters
| Parameter | Description |
|---|---|
| component_question_id | The id of the Component Question to retrieve. |
GET /api/v2/library/componentquestions/AQ1/ HTTP/1.1
Accept: application/json
Authorization: Token "YOUR SDE ACCESS TOKEN"
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "AQ1",
"text": "What cardholder data elements are stored?",
"description": "",
"answers": [
"AA1",
"AA2"
],
"component": "SC2",
"created": "2023-08-22T10:47:24.946501-04:00",
"updated": "2023-08-22T15:33:35.874367-04:00",
"db_id": 1
}
Expand Parameters
See the Expand Parameters section for more details.
| Parameter | Description |
|---|---|
| answers | The answers field is expanded. |
| component | The component field is expanded. |
GET /api/v2/library/componentquestions/AQ1/?expand=answers,component
Accept: application/json
Authorization: Token: "YOUR SDE ACCESS TOKEN"
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "AQ1",
"text": "What cardholder data elements are stored?",
"description": "",
"answers": [
{
"id": 1,
"item_id": "AA1",
"text": "CAV2 / CVC2 / CVV2 / CID",
"description": "",
"attribute": "AT1"
},
{
"id": 2,
"item_id": "AA2",
"text": "Magnetic strip or chip full track data",
"description": "",
"attribute": "AT2"
}
],
"component": {
"id": 5,
"item_id": "SC2",
"title": "Generic database"
},
"created": "2023-08-23T15:09:23.690673-04:00",
"updated": "2023-08-23T15:11:35.114961-04:00",
"db_id": 1
}