Get Survey Types

GET 
/Surveys/getStudyTypes

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

Request

Header Parameters

ZAMP-KEY stringrequired

Responses

200

Successful response containing study types

application/json

Schema

Schema

success boolean

Indicates whether the request was successful

apiVersion integer

The version of the API

message string

A message indicating the status of the request

result

object

data

object[]

Array [

id integer

The ID of the study type

STID string

The STID of the study type

description string

The description of the study type

name string

The name of the study type

]

total integer

The total number of study types returned

Example (from schema)

{
  "success": true,
  "apiVersion": 1,
  "message": "Request Success",
  "result": {
    "data": [
      {
        "id": 2,
        "STID": "TRACKER",
        "description": "Tracker Study",
        "name": "Tracker Study"
      }
    ],
    "total": 1
  }
}

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...