Get Survey By Id

GET 
/Surveys/GetSurveyById

About Api Returns details of a survey based on its ID.

Request

Query Parameters

SurveyId stringrequired

Header Parameters

ZAMP-KEY stringrequired

Responses

200

This response you will get on success request

application/json

Schema

Schema

success boolean
apiVersion integer
message string

result

object

success boolean

TotalCount integer

data

object[]

Array [

SurveyId integer

Name string

TotalCompleteRequired integer

CPI string

LOI integer

IR integer

LastUpdateTimeStamp date-time

IsSurveyGroupExist integer

LanguageCode string

SurveyEndDate date-time

Device string

IndustryId string

StudyTypes string

IsRecontactSurvey integer

CollectPII integer

LanguageId integer

Conversion string

]

Example (from schema)

{
  "success": true,
  "apiVersion": 1,
  "message": "Request Success",
  "result": {
    "success": true,
    "TotalCount": 1,
    "data": [
      {
        "SurveyId": 294460745,
        "Name": "294458956",
        "TotalCompleteRequired": 854,
        "CPI": "0.60",
        "LOI": 5,
        "IR": 99,
        "LastUpdateTimeStamp": "2022-08-04T11:01:27Z",
        "IsSurveyGroupExist": 1,
        "LanguageCode": "En-US",
        "SurveyEndDate": "2022-08-19T11:01:28Z",
        "Device": "Both",
        "IndustryId": "30",
        "StudyTypes": "ADHOC",
        "IsRecontactSurvey": 0,
        "CollectPII": 0,
        "LanguageId": 4,
        "Conversion": "34.68"
      }
    ]
  }
}

400

Bad Request. Please ensure you are passing all the required params and header info.

application/json

Schema

Schema

message string

Example (from schema)

{
  "message": "Unauthorized"
}

401

Please ensure that you are using the correct API environments and sending the correct ZAMP-KEY in the request header.

application/json

Schema

Schema

message string

Example (from schema)

{
  "message": "ZAMP-KEY key is invalid"
}

404

Please ensure that you are using the correct environments with the correct API name.

500

There is some issue facing at Zamplia Server Side. Please contact support.

application/json

Schema

Schema

message string

Example (from schema)

{
  "message": "Internal server error"
}

Loading...