REST API Documentation

• Introduction

  Communication with Medallia Agile Research RESTful survey API happens via simple HTTP requests to https://api-eu.agileresearch.medallia.com/.
  Medallia Agile Research RESTful survey API adheres to the principles of REST architecture.

• HTTP-request requirements

  To access a resource 4 things are needed:
  

  • URI

    The most complete Unique Resource Identifier looks like this:

    https://api-{region}.agileresearch.medallia.com/{version}/{resource}/{id}?{qry}

    The URI contains of different parts.

    {region}

    sets your endpoint to the correct data region. The complete endpoint for you should be https://api-eu.agileresearch.medallia.com/.

    {version}

    targets a specific version of the API

    {resource}

    defines a resource (method group)

    {id}

    is the resource identifier (the ‘Id’ property of a resource)

    {qry}

    defines the optional URI parameters

  • Format

    Medallia Agile Research RESTful API supports XML and JSON as data-interchange format. Data can be retrieved and accessed in both formats. The format is specified in the Accept HTTP header.

    application/xml

     

    application/json

    Not Formatted, Upper camel case

    When sending us xml content, please add the Content-Type header.

    For all GET methods, the Accept can be omitted; by default we will use application/json.

    
    

    All properties which have the default value (0 for Integer, Empty strings, NULL objects) will not appear in the XML/JSON response. All Date/Time properties are represented in UTC ISO 8601 format.

  • Method

    The HTTP method will reflect the action on a resource. Supported HTTP methods are:

    GET

    to retrieve a resource

    POST

    to create a resource

    PUT

    to update a resource

    DELETE

    to delete a resource

  • Authentication headers

    Each API request should contain the authentication headers.

  As of July 1 2018 all requests need to use HTTPS and TLS v1.2.
  A basic example of an HTTP request can be found at Getting Started example