Update a PSIDref List

By David Boyajian

Follow the format below to update a PSIDref List

Overview:

There are 2 ways to update the PSIDref list. 

1: You may change 1 item in the list using a PATCH call.

2: You may replace the entire contents of the list using a PUT api call. 

PUT endpoint is not yet available in dev.


Option 1 - PATCH API Call:

Valid operations for the PATCH endpoint are "add" & "remove" - "replace" operations will be ignored.

The entire PSIDref list will be returned in the response with http code 200.

Sample Request for Add: 

PATCH surveys/:survey_id/PSIDref
{
    "value":"abc",
    "operation": "add"
}


Result 


Response Code

200

Response Body

{
    "PSIDRef": [
        "75xxee23-370b-a8ye-e601-e1fzz59284c8",
        "94xx7b3b-4608-01y4-b908-8aezzab971e1",
        "24xx7db6-8507-47y9-9c67-0c6zz6244d98",
        "599446a6-6388-4ffe-4c37-9bdc9f6e6edc",
        "685330d0-a8f2-df6f-ae28-7eb89d290277",
        "abc"
    ]
}

Sample Request for Remove:

PATCH surveys/:survey_id/PSIDref
{
    "value":"abc",
    "operation": "remove"
}


Result 


Response Code

200

Response Body

{
    "PSIDRef": [
        "75xxee23-370b-a8ye-e601-e1fzz59284c8",
        "94xx7b3b-4608-01y4-b908-8aezzab971e1",
        "24xx7db6-8507-47y9-9c67-0c6zz6244d98",
        "599446a6-6388-4ffe-4c37-9bdc9f6e6edc",
        "685330d0-a8f2-df6f-ae28-7eb89d290277"
    ]
}

Option 2 - PUT API Call:

Not yet available in dev.

The entire PSIDref list will be returned in the response with http code 200.

Sample Request: 

PUT surveys/:survey_id/PSIDref
{
    "PSIDRef": [
        "75xxee23-370b-a8ye-e601-e1fzz59284c8",
        "94xx7b3b-4608-01y4-b908-8aezzab971e1",
        "24xx7db6-8507-47y9-9c67-0c6zz6244d98",
        "599446a6-6388-4ffe-4c37-9bdc9f6e6edc",
        "685330d0-a8f2-df6f-ae28-7eb89d290277",
	"abc"
    ]
}


Result 


Response Code

200

Response Body

{
    "PSIDRef": [
        "75xxee23-370b-a8ye-e601-e1fzz59284c8",
        "94xx7b3b-4608-01y4-b908-8aezzab971e1",
        "24xx7db6-8507-47y9-9c67-0c6zz6244d98",
        "599446a6-6388-4ffe-4c37-9bdc9f6e6edc",
        "685330d0-a8f2-df6f-ae28-7eb89d290277",
	"abc"
    ]
}

Related content