{"swagger":"2.0","info":{"version":"v1","title":"HelpDesk API","description":"The HelpDesk API provides information about the respondent information. \n\nThe API is based on REST (Representational State Transfer) principles, which makes it very easy to write and test applications. Both JSON and XML data formats are supported.","termsOfService":"Some terms"},"host":"atlashelpdeskapi.gfk.com","schemes":["https","http"],"paths":{"/v1/Respondent/ByEmail/{emailAddress}":{"get":{"tags":["Respondent"],"summary":"Returns the Respondents info.","description":"Get Respondents info related to the supplied EmailAddress.","operationId":"Respondent_GetRespondentsInfoByEmail","consumes":[],"produces":["application/json","text/json","text/xml"],"parameters":[{"name":"emailAddress","in":"path","description":"Respondent EmailAddress","required":true,"type":"string"}],"responses":{"200":{"description":"","schema":{"$ref":"#/definitions/RespondentsList"}},"401":{"description":"Invalid API key"},"500":{"description":"Internal Server Error"}}}},"/v1/Respondent/ByPhone/{phoneNumber}":{"get":{"tags":["Respondent"],"summary":"Returns the Respondents info.","description":"Get Respondents info related to the supplied PhoneNumber.","operationId":"Respondent_GetRespondentsInfoByPhone","consumes":[],"produces":["application/json","text/json","text/xml"],"parameters":[{"name":"phoneNumber","in":"path","description":"Respondnet Phone number","required":true,"type":"string"}],"responses":{"200":{"description":"","schema":{"$ref":"#/definitions/RespondentsList"}},"401":{"description":"Invalid API key"},"500":{"description":"Internal Server Error"}}}},"/v1/Respondent/Balance/ByEmail/{emailAddress}":{"get":{"tags":["Respondent"],"summary":"Returns the Respondent Balance info","operationId":"Respondent_GetRespondentBalanceInfoByEmail","consumes":[],"produces":["application/json","text/json","text/xml"],"parameters":[{"name":"emailAddress","in":"path","description":"Respondent EmailAddress","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/RespondentBalanceList"}}}}},"/v1/Respondent/Balance/ByPhone/{phoneNumber}":{"get":{"tags":["Respondent"],"summary":"Returns the Respondent Balance info","operationId":"Respondent_GetRespondentBalanceInfoByPhone","consumes":[],"produces":["application/json","text/json","text/xml"],"parameters":[{"name":"phoneNumber","in":"path","description":"Respondnet Phone number","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/RespondentBalanceList"}}}}},"/v1/Respondent/BalanceHistory/ByEmail/{emailAddress}/{startDate}/{endDate}":{"get":{"tags":["Respondent"],"summary":"Returns the Respondent Balance History info","operationId":"Respondent_GetRespondentBalanceHistoryInfoByEmail","consumes":[],"produces":["application/json","text/json","text/xml"],"parameters":[{"name":"emailAddress","in":"path","description":"Respondent EmailAddress","required":true,"type":"string"},{"name":"startDate","in":"path","description":"Start Date of the history and format is in yyyy-MM-dd  ex: 2019-01-01","required":true,"type":"string"},{"name":"endDate","in":"path","description":"End Date of the history and format is in yyyy-MM-dd  ex: 2021-07-30","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/RespondentBalanceHistoryList"}}}}},"/v1/Respondent/BalanceHistory/ByPhone/{phoneNumber}/{startDate}/{endDate}":{"get":{"tags":["Respondent"],"summary":"Returns the Respondent Balance History info","operationId":"Respondent_GetRespondentBalanceHistoryInfoByPhone","consumes":[],"produces":["application/json","text/json","text/xml"],"parameters":[{"name":"phoneNumber","in":"path","description":"Respondnet Phone number","required":true,"type":"string"},{"name":"startDate","in":"path","description":"Start Date of the history and format is in yyyy-MM-dd  ex: 2019-01-01","required":true,"type":"string"},{"name":"endDate","in":"path","description":"End Date of the history and format is in yyyy-MM-dd  ex: 2021-07-30","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/RespondentBalanceHistoryList"}}}}},"/v1/Respondent/UnSubscribe/ByPhone/{phoneNumber}":{"post":{"tags":["Respondent"],"summary":"Adds Respondent phone number to SuppressionList","operationId":"Respondent_UnSubscribeRespondentMobile","consumes":[],"produces":["application/json","text/json","text/xml"],"parameters":[{"name":"phoneNumber","in":"path","description":"Respondnet Phone number","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/UnSubscribeRespondentMobileInfo"}}}}},"/v1/Respondent/{respondentId}":{"get":{"tags":["Respondent"],"operationId":"Respondent_GetRespondent","consumes":[],"produces":["application/json","text/json","text/xml"],"parameters":[{"name":"respondentId","in":"path","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/RespondentInfo"}}}}},"/v1/Respondent/{respondentId}/Panels":{"get":{"tags":["Respondent"],"operationId":"Respondent_GetRespondentPanel","consumes":[],"produces":["application/json","text/json","text/xml"],"parameters":[{"name":"respondentId","in":"path","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/RespondentPanelInfo"}}}}},"/v1/Respondent/{respondentID}/SupportDeskTicket":{"post":{"tags":["Respondent"],"summary":"Save SupportDesk Ticket","operationId":"Respondent_SaveSupportDeskTicket","consumes":["application/json","text/json","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","text/xml"],"parameters":[{"name":"respondentID","in":"path","description":"","required":true,"type":"integer","format":"int32"},{"name":"supportTicket","in":"body","description":"","required":true,"schema":{"$ref":"#/definitions/SaveSupportDeskTicket"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/SaveSupportDeskTicketInfo"}}}}},"/v1/Respondent/ByEmailFromAllOrgunits/{emailAddress}":{"get":{"tags":["Respondent"],"summary":"Returns the Respondent Panels info.","description":"Get respondent Panelist info related to the supplied EmailAddress.","operationId":"Respondent_GetRespondentPanelistInfoByEmailFromAllOrgunits","consumes":[],"produces":["application/json","text/json","text/xml"],"parameters":[{"name":"emailAddress","in":"path","description":"Respondent EmailAddress","required":true,"type":"string"}],"responses":{"200":{"description":"","schema":{"$ref":"#/definitions/RespondentPanelistInfo"}},"401":{"description":"Invalid API key"},"500":{"description":"Internal Server Error"}}}},"/v2/Respondent/ByEmail/{emailAddress}":{"get":{"tags":["RespondentOauth"],"summary":"Returns the Respondents info.","description":"Get Respondents info related to the supplied EmailAddress.","operationId":"RespondentOauth_GetRespondentsInfoByEmail","consumes":[],"produces":["application/json","text/json","text/xml"],"parameters":[{"name":"emailAddress","in":"path","description":"Respondent EmailAddress","required":true,"type":"string"}],"responses":{"200":{"description":"","schema":{"$ref":"#/definitions/RespondentsList"}},"401":{"description":"Invalid API key"},"500":{"description":"Internal Server Error"}}}},"/v2/Respondent/ByPhone/{phoneNumber}":{"get":{"tags":["RespondentOauth"],"summary":"Returns the Respondents info.","description":"Get Respondents info related to the supplied PhoneNumber.","operationId":"RespondentOauth_GetRespondentsInfoByPhone","consumes":[],"produces":["application/json","text/json","text/xml"],"parameters":[{"name":"phoneNumber","in":"path","description":"Respondnet Phone number","required":true,"type":"string"}],"responses":{"200":{"description":"","schema":{"$ref":"#/definitions/RespondentsList"}},"401":{"description":"Invalid API key"},"500":{"description":"Internal Server Error"}}}},"/v2/Respondent/Balance/ByEmail/{emailAddress}":{"get":{"tags":["RespondentOauth"],"summary":"Returns the Respondent Balance info","operationId":"RespondentOauth_GetRespondentBalanceInfoByEmail","consumes":[],"produces":["application/json","text/json","text/xml"],"parameters":[{"name":"emailAddress","in":"path","description":"Respondent EmailAddress","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/RespondentBalanceList"}}}}},"/v2/Respondent/Balance/ByPhone/{phoneNumber}":{"get":{"tags":["RespondentOauth"],"summary":"Returns the Respondent Balance info","operationId":"RespondentOauth_GetRespondentBalanceInfoByPhone","consumes":[],"produces":["application/json","text/json","text/xml"],"parameters":[{"name":"phoneNumber","in":"path","description":"Respondnet Phone number","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/RespondentBalanceList"}}}}},"/v2/Respondent/BalanceHistory/ByEmail/{emailAddress}/{startDate}/{endDate}":{"get":{"tags":["RespondentOauth"],"summary":"Returns the Respondent Balance History info","operationId":"RespondentOauth_GetRespondentBalanceHistoryInfoByEmail","consumes":[],"produces":["application/json","text/json","text/xml"],"parameters":[{"name":"emailAddress","in":"path","description":"Respondent EmailAddress","required":true,"type":"string"},{"name":"startDate","in":"path","description":"Start Date of the history and format is in yyyy-MM-dd  ex: 2019-01-01","required":true,"type":"string"},{"name":"endDate","in":"path","description":"End Date of the history and format is in yyyy-MM-dd  ex: 2021-07-30","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/RespondentBalanceHistoryList"}}}}},"/v2/Respondent/BalanceHistory/ByPhone/{phoneNumber}/{startDate}/{endDate}":{"get":{"tags":["RespondentOauth"],"summary":"Returns the Respondent Balance History info","operationId":"RespondentOauth_GetRespondentBalanceHistoryInfoByPhone","consumes":[],"produces":["application/json","text/json","text/xml"],"parameters":[{"name":"phoneNumber","in":"path","description":"Respondnet Phone number","required":true,"type":"string"},{"name":"startDate","in":"path","description":"Start Date of the history and format is in yyyy-MM-dd  ex: 2019-01-01","required":true,"type":"string"},{"name":"endDate","in":"path","description":"End Date of the history and format is in yyyy-MM-dd  ex: 2021-07-30","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/RespondentBalanceHistoryList"}}}}},"/v2/Respondent/UnSubscribe/ByPhone/{phoneNumber}":{"post":{"tags":["RespondentOauth"],"summary":"Adds Respondent phone number to SuppressionList","operationId":"RespondentOauth_UnSubscribeRespondentMobile","consumes":[],"produces":["application/json","text/json","text/xml"],"parameters":[{"name":"phoneNumber","in":"path","description":"Respondnet Phone number","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/UnSubscribeRespondentMobileInfo"}}}}}},"definitions":{"RespondentsList":{"description":"List of Respondents","type":"object","properties":{"Respondents":{"description":"List of Respondents","type":"array","items":{"$ref":"#/definitions/Respondent"}},"ApiResultCode":{"description":"APIResult code 0 means success, 2 failure of API method call","type":"string"},"ResultCount":{"format":"int32","description":"Number of responses returned","type":"integer"},"ApiMessages":{"description":"Contains array of API response messages","type":"array","items":{"type":"string"}}}},"Respondent":{"description":"Respondent data","type":"object","properties":{"RespondentId":{"format":"int32","description":"RespondentId in Atlas","type":"integer"},"AtlasLink":{"description":"AtlasLink for Respondent in Atlas","type":"string"}}},"RespondentBalanceList":{"description":"RespondentBalanceList - List of Respondents Balance info","type":"object","properties":{"RespondentBalance":{"description":"RespondentBalance for Respondent in Atlas","type":"array","items":{"$ref":"#/definitions/RespondentBalance"}},"ApiResultCode":{"description":"APIResult code 0 means success, 2 failure of API method call","type":"string"},"ResultCount":{"format":"int32","description":"Number of responses returned","type":"integer"},"ApiMessages":{"description":"Contains array of API response messages","type":"array","items":{"type":"string"}}}},"RespondentBalance":{"description":"RespondentBalance","type":"object","properties":{"RespondentID":{"format":"int32","type":"integer"},"RespondentBalanceDetails":{"type":"array","items":{"$ref":"#/definitions/RespondentBalanceDetails"}}}},"RespondentBalanceDetails":{"description":"RespondentBalanceDetails","type":"object","properties":{"IncentivePanelID":{"format":"int32","type":"integer"},"CashValue":{"format":"double","type":"number"},"Amount":{"format":"double","type":"number"},"LastTransactionDate":{"format":"date-time","type":"string"}}},"RespondentBalanceHistoryList":{"description":"RespondentBalanceHistoryList - List of Respondents Balance history info","type":"object","properties":{"RespondentBalanceHistory":{"description":"RespondentBalanceHistory for Respondent in Atlas","type":"array","items":{"$ref":"#/definitions/RespondentBalanceHistory"}},"ApiResultCode":{"description":"APIResult code 0 means success, 2 failure of API method call","type":"string"},"ResultCount":{"format":"int32","description":"Number of responses returned","type":"integer"},"ApiMessages":{"description":"Contains array of API response messages","type":"array","items":{"type":"string"}}}},"RespondentBalanceHistory":{"description":"RespondentBalanceHistory","type":"object","properties":{"RespondentID":{"format":"int32","type":"integer"},"RespondentBalanceHistoryDetails":{"type":"array","items":{"$ref":"#/definitions/RespondentBalanceHistoryDetails"}}}},"RespondentBalanceHistoryDetails":{"description":"RespondentBalanceHistoryDetails","type":"object","properties":{"RespondentIncentiveAccountID":{"format":"int64","type":"integer"},"TransactionPanelID":{"format":"int32","type":"integer"},"IncentivePanelID":{"format":"int32","type":"integer"},"ProjectID":{"format":"int32","type":"integer"},"OperationalProjectID":{"type":"string"},"ProjectName":{"type":"string"},"ProjectDescription":{"type":"string"},"PublicDescription":{"type":"string"},"Amount":{"format":"double","type":"number"},"CashValue":{"format":"double","type":"number"},"Code":{"type":"string"},"IncentiveTypeId":{"format":"int32","type":"integer"},"DateCreated":{"format":"date-time","type":"string"},"Label":{"type":"string"},"IncentiveInstanceID":{"format":"int32","type":"integer"},"IncentiveInstanceLabel":{"type":"string"},"SurveyLabelExternal":{"type":"string"},"Description":{"type":"string"},"Notes":{"type":"string"},"VoucherLink":{"type":"string"},"ValidThrough":{"type":"string"}}},"UnSubscribeRespondentMobileInfo":{"description":"UnSubscribe Respondent MobileInfo","type":"object","properties":{"Message":{"description":"List of Respondents","type":"string"},"ApiResultCode":{"description":"APIResult code 0 means success, 2 failure of API method call","type":"string"},"ResultCount":{"format":"int32","description":"Number of responses returned","type":"integer"},"ApiMessages":{"description":"Contains array of API response messages","type":"array","items":{"type":"string"}}}},"RespondentInfo":{"description":"","type":"object","properties":{"Respondent":{"$ref":"#/definitions/RespondentData","description":""},"ApiResultCode":{"description":"APIResult code 0 means success, 2 failure of API method call","type":"string"},"ResultCount":{"format":"int32","description":"Number of responses returned","type":"integer"},"ApiMessages":{"description":"Contains array of API response messages","type":"array","items":{"type":"string"}}}},"RespondentData":{"description":"","type":"object","properties":{"RespondentId":{"format":"int32","description":"RespondentId in Atlas","type":"integer"},"FirstName":{"description":"FirstName for Respondent in Atlas","type":"string"},"LastName":{"description":"LastName for Respondent in Atlas","type":"string"},"ExternalRespID":{"description":"ExternalRespID for Respondent in Atlas","type":"string"},"Age":{"format":"int32","description":"Age for Respondent in Atlas","type":"integer"},"GenderID":{"format":"int32","description":"GenderID for Respondent in Atlas","type":"integer"},"LastSurveyInvitation":{"format":"date-time","description":"LastSurveyInvitation for Respondent in Atlas","type":"string"},"LastSurveyComplete":{"format":"date-time","description":"LastSurveyComplete for Respondent in Atlas","type":"string"},"LastPortalLogin":{"format":"date-time","description":"LastPortalLogin for Respondent in Atlas","type":"string"},"SignupSourceInfo":{"description":"SignupSourceInfo for Respondent in Atlas","type":"string"},"bbc1_425":{"description":"bbc1_425","type":"string"},"BBC_redemptionLocked":{"description":"BBC_redemptionLocked","type":"string"},"PIMP":{"description":"PIMP","type":"string"},"GXL_NIQ_HP_HHID":{"type":"string"},"GXL_ID":{"type":"string"},"SGP_RealityMine_App_PIN":{"type":"string"},"SGP_RealityMine_Return_URI":{"type":"string"}}},"RespondentPanelInfo":{"description":"","type":"object","properties":{"RespondentPanelData":{"description":"","type":"array","items":{"$ref":"#/definitions/RespondentPanelData"}},"ApiResultCode":{"description":"APIResult code 0 means success, 2 failure of API method call","type":"string"},"ResultCount":{"format":"int32","description":"Number of responses returned","type":"integer"},"ApiMessages":{"description":"Contains array of API response messages","type":"array","items":{"type":"string"}}}},"RespondentPanelData":{"description":"","type":"object","properties":{"PanelID":{"format":"int32","description":"","type":"integer"},"PanelName":{"description":"PanelName for Respondent in Atlas","type":"string"},"RespondentPanelStatusCode":{"description":"RespondentPanelStatusCode for Respondent in Atlas","type":"string"},"RespondentPanelStatusDescription":{"description":"RespondentPanelStatusDescription for Respondent in Atlas","type":"string"},"StatusLastModifiedDate":{"format":"date-time","description":"StatusLastModifiedDate for Respondent in Atlas","type":"string"},"FirstActiveDate":{"format":"date-time","description":"FirstActiveDate for Respondent in Atlas","type":"string"},"EndingBalance":{"format":"double","description":"EndingBalance","type":"number"}}},"SaveSupportDeskTicket":{"description":"","type":"object","properties":{"SupportDeskTicketID":{"description":"","type":"string"},"RespondentID":{"format":"int32","description":"","type":"integer"},"TicketDate":{"format":"date-time","description":"","type":"string"},"Subject":{"description":"","type":"string"},"TicketLink":{"description":"","type":"string"}}},"SaveSupportDeskTicketInfo":{"description":"","type":"object","properties":{"Message":{"description":"List of Respondents","type":"string"},"ApiResultCode":{"description":"APIResult code 0 means success, 2 failure of API method call","type":"string"},"ResultCount":{"format":"int32","description":"Number of responses returned","type":"integer"},"ApiMessages":{"description":"Contains array of API response messages","type":"array","items":{"type":"string"}}}},"RespondentPanelistInfo":{"description":"List of Respondents","type":"object","properties":{"Panels":{"description":"List of PanelsData","type":"array","items":{"$ref":"#/definitions/RespondentPanelsData"}},"ApiResultCode":{"description":"APIResult code 0 means success, 2 failure of API method call","type":"string"},"ResultCount":{"format":"int32","description":"Number of responses returned","type":"integer"},"ApiMessages":{"description":"Contains array of API response messages","type":"array","items":{"type":"string"}}}},"RespondentPanelsData":{"description":"Respondent data","type":"object","properties":{"OrgUnitID":{"format":"int32","description":"OrgUnitID","type":"integer"},"OrgUnitname":{"description":"OrgUnitname","type":"string"},"PanelID":{"format":"int32","description":"PanelID","type":"integer"},"PanelName":{"description":"PanelName","type":"string"},"RespondentPanelStatusCode":{"description":"RespondentPanelStatusCode","type":"string"},"RespondentId":{"format":"int32","description":"RespondentId","type":"integer"},"InOneID":{"format":"int32","type":"integer"}}}},"securityDefinitions":{"Key":{"type":"apiKey","description":"API Key for Authentication","name":"Key","in":"url"}}}