{ "info": { "_postman_id": "82d64aec-f0b2-4797-9df9-1f39b4f758d7", "name": "IP Member Management", "description": "For use when Adding, Updating, and Viewing Member details within the Toluna Integrated Panel (IP) Platform.", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json" }, "item": [ { "name": "v2", "item": [ { "name": "Member Add via API - V2", "request": { "method": "POST", "header": [ { "key": "Content-Type", "name": "Content-Type", "type": "text", "value": "application/json" }, { "key": "Accept", "value": "application/json;version=2.0", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"PartnerGUID\": \"{{panelGUID}}\",\n \"MemberCode\": \"IP-V2-Test\",\n \"PostalCode\": \"\",\n \"BirthDate\": \"06/21/1985\",\n \"IsActive\": true,\n \"IsTest\": false,\n \"IsPIIDataRegulated\": false,\n \"AnsweredQuestions\": [\n {\n \"QuestionID\": 1001007,\n \"AnswerID\": 2000247\n },\n {\n \"QuestionID\": 1001101,\n \"AnswerID\": 2002275\n },\n {\n \"QuestionID\": 1001107,\n \"AnswerID\": 2002330\n },\n {\n \"QuestionID\": 1001012,\n \"AnswerID\": 2000270\n },\n {\n \"QuestionID\": 1005145,\n \"AnswerID\": 2796316\n },\n {\n \"QuestionID\": 1001102,\n \"AnswerID\": 2002280\n },\n {\n \"QuestionID\": 1012395,\n \"AnswerID\": 3056609\n }\n ]\n}" }, "url": { "raw": "{{IP_CORE_URL}}/IntegratedPanelService/api/Respondent", "host": [ "{{IP_CORE_URL}}" ], "path": [ "IntegratedPanelService", "api", "Respondent" ] }, "description": "**Description** \n\nExisting Members can be updated using HTTP PUT. “PartnerGUID” and “MemberCode” are required. Combine them with optional properties to update a Member according to your requirements.\n\n\n\n**Request Details**\n\n| Property | Description |\n|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| PartnerGUID | Unique Partner Code (Please request from Toluna if you don’t have one) |\n| MemberCode | Unique Respondent Code from the Partner |\n| Active | (Optional) Defaults TRUE.  When TRUE, Member is eligible to take Surveys.  When FALSE, Member is excluded from the Survey Routing pool. |\n| GenderID | (Optional) Values from the data mapping file.  |\n| EducationID | (Optional) Values from the data mapping file. |\n| EthnicityID | (Optional) Values from the data mapping file. |\n| RaceID | (Optional) Values from the data mapping file. |\n| BirthDate | (Optional) MM/DD/YYYY format |\n| PostalCode | (Optional) |\n| IsTest | (Optional) Defaults FALSE.  When TRUE the Member by-passes all Toluna duplication validation routines.  Among other things, this makes the eligible to take Surveys multiple times from the same physical machine.  Should be used ONLY during testing. |\n\n\n**Notes:**\n\n- Only new Members can be added. To update, use the PUT route noted below\n- Optional Properties can be excluded from the request. “GenderID”, “EducationID”, “EthnicityID”, and “RaceID” can also take “0” to indicate “no value”.\n- Invalid Property data typically returns a 400 response.\n\n\n---\n\n**Possible Responses**\n\n| Response Code | Etiology, actions |\n|---------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| 200 | OK.  Request processed normally, existing Member Panelist was updated without issue. |\n| 400 | Bad Request.  Request is malformed or incomplete.  Review message details and take appropriate action. |\n| 500 | Internal Error.  An exception occurred while processing the request. Contact Toluna for resolution. Toluna will likely have the details captured in its logs |\n\n\n---" }, "response": [ { "name": "Member Update via API - Use Member for testing", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "name": "Content-Type", "type": "text", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\r\n \"PartnerGUID\": \"XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX\",\r\n \"MemberCode\": \"111\",\r\n \"IsTest\": \"true\"\r\n}\r\n" }, "url": { "raw": "{{host}}/IntegratedPanelService/api/Respondent", "host": [ "{{host}}" ], "path": [ "IntegratedPanelService", "api", "Respondent" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "Text", "header": [], "cookie": [], "body": "" }, { "name": "Member Update via API - Deactivate Member", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "name": "Content-Type", "type": "text", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"PartnerGUID\": \"XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX\",\n \"MemberCode\": \"111\",\n \"Active\": \"false\"\n}" }, "url": { "raw": "{{host}}/IntegratedPanelService/api/Respondent", "host": [ "{{host}}" ], "path": [ "IntegratedPanelService", "api", "Respondent" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [], "cookie": [], "body": "" } ] }, { "name": "Member GET using API - V2", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json;version=2.0", "type": "text" } ], "url": { "raw": "{{IP_CORE_URL}}/IntegratedPanelService/api/Respondent/?memberCode=IP-V2-Test&partnerGuid={{panelGUID}}", "host": [ "{{IP_CORE_URL}}" ], "path": [ "IntegratedPanelService", "api", "Respondent", "" ], "query": [ { "key": "memberCode", "value": "IP-V2-Test", "description": "Unique Respondent Code from the Partner" }, { "key": "partnerGuid", "value": "{{panelGUID}}", "description": "Unique Partner Code (Please request this from Toluna if you don’t have one)" } ] }, "description": "**Description** \n\nA partner can get details for members in the Toluna IP database using an HTTP GET.\n\n\n---\n\n\n**Parameters**\n\n| Name | Description |\n|-------------|-----------------------------------------------------------------------------|\n| memberCode | Unique Respondent Code from the Partner |\n| partnerGuid | Unique Partner Code (Please request this from Toluna if you don’t have one) |\n\n\n---\n\n\n**Possible Responses**\n\n| Response Code | Etiology, actions |\n|---------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| 200 | OK.  Request processed normally, existing Member Panelist was updated without issue. |\n| 400 | Bad Request.  Request is malformed or incomplete.  Review message details and take appropriate action. |\n| 500 | Internal Error.  An exception occurred while processing the request. Contact Toluna for resolution. Toluna will likely have the details captured in its logs |\n\n\n---" }, "response": [] }, { "name": "Member Update via API - V2", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "name": "Content-Type", "type": "text", "value": "application/json" }, { "key": "Accept", "value": "application/json;version=2.0", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"PartnerGUID\": \"{{panelGUID}}\",\n \"MemberCode\": \"IP-V2-Test\",\n \"AnsweredQuestions\": [\n {\n \"QuestionID\": 1001101,\n \"AnswerID\": 3050770\n },\n {\n \"QuestionID\": 1001107,\n \"AnswerID\": 2796394\n }\n ]\n}" }, "url": { "raw": "{{IP_CORE_URL}}/IntegratedPanelService/api/Respondent", "host": [ "{{IP_CORE_URL}}" ], "path": [ "IntegratedPanelService", "api", "Respondent" ] }, "description": "**Description** \n\nExisting Members can be updated using HTTP PUT. “PartnerGUID” and “MemberCode” are required. Combine them with optional properties to update a Member according to your requirements.\n\n\n\n**Request Details**\n\n| Property | Description |\n|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| PartnerGUID | Unique Partner Code (Please request from Toluna if you don’t have one) |\n| MemberCode | Unique Respondent Code from the Partner |\n| Active | (Optional) Defaults TRUE.  When TRUE, Member is eligible to take Surveys.  When FALSE, Member is excluded from the Survey Routing pool. |\n| GenderID | (Optional) Values from the data mapping file.  |\n| EducationID | (Optional) Values from the data mapping file. |\n| EthnicityID | (Optional) Values from the data mapping file. |\n| RaceID | (Optional) Values from the data mapping file. |\n| BirthDate | (Optional) MM/DD/YYYY format |\n| PostalCode | (Optional) |\n| IsTest | (Optional) Defaults FALSE.  When TRUE the Member by-passes all Toluna duplication validation routines.  Among other things, this makes the eligible to take Surveys multiple times from the same physical machine.  Should be used ONLY during testing. |\n\n\n**Notes:**\n\n- Only new Members can be added. To update, use the PUT route noted below\n- Optional Properties can be excluded from the request. “GenderID”, “EducationID”, “EthnicityID”, and “RaceID” can also take “0” to indicate “no value”.\n- Invalid Property data typically returns a 400 response.\n\n\n---\n\n**Possible Responses**\n\n| Response Code | Etiology, actions |\n|---------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| 200 | OK.  Request processed normally, existing Member Panelist was updated without issue. |\n| 400 | Bad Request.  Request is malformed or incomplete.  Review message details and take appropriate action. |\n| 500 | Internal Error.  An exception occurred while processing the request. Contact Toluna for resolution. Toluna will likely have the details captured in its logs |\n\n\n---" }, "response": [] } ], "protocolProfileBehavior": {} } ], "protocolProfileBehavior": {} }