Returns information needed for external panels to show invitations to CV projects

Endpoint URL

http://api.clearvoicesurveys.com/api/v1/member/getuserinvitationinformation?userinvitationguid={userinvitationguid}

Parameters

UserInvitationGuid
string		 Primary key for a user invitation to look up

Required

Response Description

CompletedRewardAmount
decimal number		 Reward amount for completed status
TerminatedRewardAmount
decimal number		 Reward amount for terminated status
OverQuotaRewardAmount
decimal number		 Reward amount for over quota status
PrelimStatusCode
string		 Status code of the user invitation
CakeOfferId
integer		 Cake offer id for the user invitation
ExternalMemberId
string		 External member id for the user invitation
SurveyName
string		 Survey name for the user invitation
SurveyClubAdCampaignGuid
globally unique identifier		 Ad campagin guid for Survey Club
PrcAdCampaignGuid
globally unique identifier		 Ad campaign guid for product report card
ClearVoiceProjectId
integer		 Project Id for the ClearVoice Project tied to the invitation

Example Response

[
  {
    "CompletedRewardAmount": 1.0,
    "TerminatedRewardAmount": 1.0,
    "OverQuotaRewardAmount": 1.0,
    "PrelimStatusCode": "sample string 1",
    "CakeOfferId": 1,
    "ExternalMemberId": "sample string 2",
    "SurveyName": "sample string 3",
    "SurveyClubAdCampaignGuid": "f2c569dc-eb5a-450d-b009-a78ee62471b5",
    "PrcAdCampaignGuid": "c98f9622-a5d7-4bae-882c-f8cc2c959379",
    "ClearVoiceProjectId": 4
  },
  {
    "CompletedRewardAmount": 1.0,
    "TerminatedRewardAmount": 1.0,
    "OverQuotaRewardAmount": 1.0,
    "PrelimStatusCode": "sample string 1",
    "CakeOfferId": 1,
    "ExternalMemberId": "sample string 2",
    "SurveyName": "sample string 3",
    "SurveyClubAdCampaignGuid": "f2c569dc-eb5a-450d-b009-a78ee62471b5",
    "PrcAdCampaignGuid": "c98f9622-a5d7-4bae-882c-f8cc2c959379",
    "ClearVoiceProjectId": 4
  }
]