API | Winquo

Respondent API

HTTP:GET /api/profile/detail/{uid} Retrieves stored respondent profile identified by internal or external UID.

HTTP:POST /api/profile/save Saves a new respondent profile or updates an existing one (data in HTTP:Body).

{
    "UID": "internal-uid",
    "ExternalUID": "external-uid-can-be-null,
    "Language": 1,
    "Gender": 1,
    "Email": "doe@email.com",
    "Name": "John",
    "Surname": "Doe",
    "SurveyUrl" "/survey/?uid={respondent.UID}"
    "CreatedDate": null
}

HTTP:DELETE /api/profile/delete/{uid} Delete a respondent profile by identified internal or external UID (un-completed only).

HTTP:POST /api/survey/save/{uid} Saves survey answers to existing respondent profile identified by internal or external UID. HTTP.Body is string value of Survey answers (comma delimited 145 Likert scale values)

HTTP:GET /api/profile/preview/{uid}?type={reportType} Get report preview as HTML for respondent profile (identified by internal or external UID) and report-type

HTTP:GET /api/profile/download/{uid}?type={reportType} Download report as PDF for respondent profile (identified by internal or external UID) and report-type

Language reference API

HTTP:GET /api/lookup/languages List of supported languages.

[
    {
        "Value": 1,
        "Name": "čeština",
        "ShortName": "cz"
    },
    {
        "Value": 2,
        "Name": "english",
        "ShortName": "eng"
    },
    {
        "Value": 3,
        "Name": "slovenčina",
        "ShortName": "sk"
    },
    {
        "Value": 4,
        "Name": "português",
        "ShortName": "ptBR"
    },
    {
        "Value": 5,
        "Name": "deutsch",
        "ShortName": "de"
    }
]

Gender reference API

HTTP:GET /api/lookup/genders List of supported genders.

[
    {
        "Value": 1,
        "Name": "muž",
        "ShortName": "male"
    },
    {
        "Value": 2,
        "Name": "žena",
        "ShortName": "female"
    }
]

Answer values reference API

HTTP:GET /api/lookup/values List of answer values (Likert scale).

[
  {
    "Value": 1,
    "Name": "100%",
    "ShortName": "high"
  },
  {
    "Value": 2,
    "Name": "75%",
    "ShortName": "more"
  },
  {
    "Value": 3,
    "Name": "50%",
    "ShortName": "middle"
  },
  {
    "Value": 4,
    "Name": "25%",
    "ShortName": "less"
  },
  {
    "Value": 5,
    "Name": "0%",
    "ShortName": "low"
  }
]

Report-type reference API

HTTP:GET /api/lookup/reportTypes List of supported report-types.

[
    {
        "Value": 1,
        "Name": "Master report",
        "ShortName": "master"
    },
    {
        "Value": 2,
        "Name": "Master report [with questions]",
        "ShortName": "questions"
    },
    {
        "Value": 11,
        "Name": "Teams",
        "ShortName": "teams"
    },
    {
        "Value": 12,
        "Name": "Coaching",
        "ShortName": "coaching"
    },
    {
        "Value": 13,
        "Name": "Leadership",
        "ShortName": "leadership"
    },
    {
        "Value": 14,
        "Name": "Changes",
        "ShortName": "changes"
    },
    {
        "Value": 15,
        "Name": "Innovation",
        "ShortName": "innovation"
    },
    {
        "Value": 16,
        "Name": "Career",
        "ShortName": "career"
    }
]