Skip to content
This repository was archived by the owner on Apr 18, 2026. It is now read-only.

Server End Points

Jump to bottom
Bob Evans edited this page Oct 8, 2013 · 8 revisions

A Guide to Making Paco Server Requests.

Introduction

The Android, iOS, and GWT clients often need to make server requests to retrieve experiments and other data. Some of the server requests that can be made are enumerated below.

For the Paco production server, request uris begin with quantifiedself.appspot.com

For the Paco development server, begin request uris with 127.0.0.1:8888

Server Endpoints

Experiment Retrieval

/experiments - Returns a JSON string representing the list of all experiments available to the user making the request. The experiment definitions are represented in their entirety (description and inputs).

/experiments?short - Returns a concise JSON string representing the list of all experiments available to the user making the request. The experiment definitions contain only key pieces of information: the experiment’s server id, title, creator, description, informed consent text, start date, end date, and join date.

/experiments?id={ID_LIST} - Returns a JSON string representing the list of experiments whose id’s are represented in the id list. {ID_LIST} is a comma-separated list of numerical experiment id’s corresponding to the experiments to be fetched. Invalid id’s will be disregarded by the server. The experiment definitions are represented in their entirety (description and inputs).

Sample Output

/experiments :


[
  {
    "schedule": {
      "repeatRate": 1,
      "nthOfMonth": 1,
      "weekDaysScheduled": 0,
      "esmFrequency": 3,
      "type": "signalSchedule",
      "times": [
        57600000
      ],
      "byDayOfWeek": false,
      "dayOfMonth": 1,
      "scheduleType": 4,
      "esmPeriodInDays": 0,
      "esmWeekends": false,
      "id": 4052,
      "esmEndHour": 61200000,
      "byDayOfMonth": true,
      "esmStartHour": 32400000
    },
    "informedConsentForm": "Informed consent text",
    "title": "AndroidTest - Fixed, ESM",
    "deleted": false,
    "version": 2,
    "signalingMechanisms": [
      {
        "repeatRate": 1,
        "nthOfMonth": 1,
        "weekDaysScheduled": 0,
        "esmFrequency": 3,
        "type": "signalSchedule",
        "times": [
          57600000
        ],
        "byDayOfWeek": false,
        "dayOfMonth": 1,
        "scheduleType": 4,
        "esmPeriodInDays": 0,
        "esmWeekends": false,
        "id": 4052,
        "esmEndHour": 61200000,
        "byDayOfMonth": true,
        "esmStartHour": 32400000
      }
    ],
    "modifyDate": 1372463062796,
    "fixedDuration": false,
    "publishedUsers": [
    ],
    "feedback": [
      {
        "feedbackType": "display",
        "text": "Thanks for Participating!",
        "id": 4136
      }
    ],
    "webRecommended": false,
    "inputs": [
      {
        "name": "question1",
        "conditional": false,
        "listChoices": [
        ],
        "likertSteps": 5,
        "mandatory": false,
        "text": "question1",
        "id": 4054,
        "responseType": "open text",
        "questionType": "question",
        "invisibleInput": false
      },
      {
        "name": "question2",
        "conditional": false,
        "listChoices": [
        ],
        "likertSteps": 5,
        "mandatory": false,
        "text": "",
        "id": 4055,
        "responseType": "location",
        "questionType": "question",
        "invisibleInput": true
      }
    ],
    "questionsChange": false,
    "id": 4051,
    "creator": "donti@google.com",
    "description": "Description"
  },
  {
    "schedule": {
      "repeatRate": 1,
      "nthOfMonth": 1,
      "weekDaysScheduled": 0,
      "esmFrequency": 3,
      "type": "signalSchedule",
      "times": [
        57600000,
        61200000
      ],
      "byDayOfWeek": false,
      "dayOfMonth": 1,
      "scheduleType": 0,
      "esmPeriodInDays": 0,
      "esmWeekends": false,
      "id": 4041,
      "esmEndHour": 61200000,
      "byDayOfMonth": true,
      "esmStartHour": 32400000
    },
    "informedConsentForm": "Informed Consent Text",
    "title": "AndroidTest - Ongoing, Daily",
    "deleted": false,
    "version": 2,
    "signalingMechanisms": [
      {
        "repeatRate": 1,
        "nthOfMonth": 1,
        "weekDaysScheduled": 0,
        "esmFrequency": 3,
        "type": "signalSchedule",
        "times": [
          57600000,
          61200000
        ],
        "byDayOfWeek": false,
        "dayOfMonth": 1,
        "scheduleType": 0,
        "esmPeriodInDays": 0,
        "esmWeekends": false,
        "id": 4041,
        "esmEndHour": 61200000,
        "byDayOfMonth": true,
        "esmStartHour": 32400000
      }
    ],
    "modifyDate": 1372462954815,
    "fixedDuration": false,
    "publishedUsers": [
    ],
    "feedback": [
      {
        "feedbackType": "display",
        "text": "Thanks for Participating!",
        "id": 4138
      }
    ],
    "webRecommended": false,
    "inputs": [
      {
        "name": "question1",
        "conditional": false,
        "listChoices": [
        ],
        "likertSteps": 5,
        "mandatory": false,
        "text": "question1",
        "id": 4043,
        "responseType": "likert",
        "questionType": "question",
        "invisibleInput": false
      },
      {
        "name": "question2",
        "conditional": false,
        "listChoices": [
          "choice1",
          "choice2",
          "choice3"
        ],
        "likertSteps": 5,
        "mandatory": false,
        "text": "question2",
        "id": 4044,
        "responseType": "list",
        "questionType": "question",
        "invisibleInput": false
      }
    ],
    "questionsChange": false,
    "id": 4040,
    "creator": "donti@google.com",
    "description": "Description"
  },
  {
    "schedule": {
      "repeatRate": 1,
      "nthOfMonth": 1,
      "weekDaysScheduled": 0,
      "esmFrequency": 3,
      "type": "signalSchedule",
      "times": [
        54000000
      ],
      "byDayOfWeek": false,
      "dayOfMonth": 1,
      "scheduleType": 3,
      "esmPeriodInDays": 0,
      "esmWeekends": false,
      "id": 4070,
      "esmEndHour": 61200000,
      "byDayOfMonth": true,
      "esmStartHour": 32400000
    },
    "informedConsentForm": "",
    "title": "AndroidTest - Ongoing, Monthly",
    "deleted": false,
    "version": 2,
    "signalingMechanisms": [
      {
        "repeatRate": 1,
        "nthOfMonth": 1,
        "weekDaysScheduled": 0,
        "esmFrequency": 3,
        "type": "signalSchedule",
        "times": [
          54000000
        ],
        "byDayOfWeek": false,
        "dayOfMonth": 1,
        "scheduleType": 3,
        "esmPeriodInDays": 0,
        "esmWeekends": false,
        "id": 4070,
        "esmEndHour": 61200000,
        "byDayOfMonth": true,
        "esmStartHour": 32400000
      }
    ],
    "modifyDate": 1372718396514,
    "fixedDuration": false,
    "publishedUsers": [
    ],
    "feedback": [
      {
        "feedbackType": "display",
        "text": "Thanks for Participating!",
        "id": 4140
      }
    ],
    "webRecommended": false,
    "inputs": [
      {
        "name": "q1",
        "conditional": false,
        "listChoices": [
        ],
        "likertSteps": 5,
        "mandatory": false,
        "text": "q1",
        "id": 4072,
        "responseType": "likert",
        "questionType": "question",
        "invisibleInput": false
      }
    ],
    "questionsChange": false,
    "id": 4069,
    "creator": "donti@google.com",
    "description": ""
  },
  {
    "schedule": {
      "repeatRate": 1,
      "nthOfMonth": 1,
      "weekDaysScheduled": 0,
      "esmFrequency": 3,
      "type": "signalSchedule",
      "times": [
      ],
      "byDayOfWeek": false,
      "dayOfMonth": 1,
      "scheduleType": 5,
      "esmPeriodInDays": 0,
      "esmWeekends": false,
      "esmEndHour": 61200000,
      "byDayOfMonth": true,
      "esmStartHour": 32400000
    },
    "informedConsentForm": "Informed Consent Text",
    "title": "AndroidTest - Ongoing, Triggered",
    "deleted": false,
    "version": 2,
    "signalingMechanisms": [
      {
        "type": "trigger",
        "delay": 5000,
        "eventCode": 0,
        "id": 4047
      }
    ],
    "modifyDate": 1372463004463,
    "fixedDuration": false,
    "publishedUsers": [
    ],
    "feedback": [
      {
        "feedbackType": "display",
        "text": "Thanks for Participating!",
        "id": 4142
      }
    ],
    "webRecommended": false,
    "inputs": [
      {
        "name": "question1",
        "conditional": false,
        "listChoices": [
        ],
        "likertSteps": 5,
        "mandatory": false,
        "text": "question1",
        "id": 4049,
        "responseType": "likert",
        "questionType": "question",
        "invisibleInput": false
      }
    ],
    "questionsChange": false,
    "id": 4046,
    "creator": "donti@google.com",
    "description": "Description"
  }
]

/experiments?short : <out of date -- short definitions no longer include schedule>


[
  {
    "schedule": {
      "repeatRate": 1,
      "nthOfMonth": 1,
      "weekDaysScheduled": 0,
      "esmFrequency": 3,
      "type": "signalSchedule",
      "times": [
        57600000
      ],
      "byDayOfWeek": false,
      "dayOfMonth": 1,
      "scheduleType": 4,
      "esmPeriodInDays": 0,
      "esmWeekends": false,
      "id": 4052,
      "esmEndHour": 61200000,
      "byDayOfMonth": true,
      "esmStartHour": 32400000
    },
    "informedConsentForm": "Informed consent text",
    "title": "AndroidTest - Fixed, ESM",
    "signalingMechanisms": [
      {
        "repeatRate": 1,
        "nthOfMonth": 1,
        "weekDaysScheduled": 0,
        "esmFrequency": 3,
        "type": "signalSchedule",
        "times": [
          57600000
        ],
        "byDayOfWeek": false,
        "dayOfMonth": 1,
        "scheduleType": 4,
        "esmPeriodInDays": 0,
        "esmWeekends": false,
        "id": 4052,
        "esmEndHour": 61200000,
        "byDayOfMonth": true,
        "esmStartHour": 32400000
      }
    ],
    "fixedDuration": false,
    "id": 4051,
    "creator": "donti@google.com",
    "description": "Description"
  },
  {
    "schedule": {
      "repeatRate": 1,
      "nthOfMonth": 1,
      "weekDaysScheduled": 0,
      "esmFrequency": 3,
      "type": "signalSchedule",
      "times": [
        57600000,
        61200000
      ],
      "byDayOfWeek": false,
      "dayOfMonth": 1,
      "scheduleType": 0,
      "esmPeriodInDays": 0,
      "esmWeekends": false,
      "id": 4041,
      "esmEndHour": 61200000,
      "byDayOfMonth": true,
      "esmStartHour": 32400000
    },
    "informedConsentForm": "Informed Consent Text",
    "title": "AndroidTest - Ongoing, Daily",
    "signalingMechanisms": [
      {
        "repeatRate": 1,
        "nthOfMonth": 1,
        "weekDaysScheduled": 0,
        "esmFrequency": 3,
        "type": "signalSchedule",
        "times": [
          57600000,
          61200000
        ],
        "byDayOfWeek": false,
        "dayOfMonth": 1,
        "scheduleType": 0,
        "esmPeriodInDays": 0,
        "esmWeekends": false,
        "id": 4041,
        "esmEndHour": 61200000,
        "byDayOfMonth": true,
        "esmStartHour": 32400000
      }
    ],
    "fixedDuration": false,
    "id": 4040,
    "creator": "donti@google.com",
    "description": "Description"
  },
  {
    "schedule": {
      "repeatRate": 1,
      "nthOfMonth": 1,
      "weekDaysScheduled": 0,
      "esmFrequency": 3,
      "type": "signalSchedule",
      "times": [
        54000000
      ],
      "byDayOfWeek": false,
      "dayOfMonth": 1,
      "scheduleType": 3,
      "esmPeriodInDays": 0,
      "esmWeekends": false,
      "id": 4070,
      "esmEndHour": 61200000,
      "byDayOfMonth": true,
      "esmStartHour": 32400000
    },
    "informedConsentForm": "",
    "title": "AndroidTest - Ongoing, Monthly",
    "signalingMechanisms": [
      {
        "repeatRate": 1,
        "nthOfMonth": 1,
        "weekDaysScheduled": 0,
        "esmFrequency": 3,
        "type": "signalSchedule",
        "times": [
          54000000
        ],
        "byDayOfWeek": false,
        "dayOfMonth": 1,
        "scheduleType": 3,
        "esmPeriodInDays": 0,
        "esmWeekends": false,
        "id": 4070,
        "esmEndHour": 61200000,
        "byDayOfMonth": true,
        "esmStartHour": 32400000
      }
    ],
    "fixedDuration": false,
    "id": 4069,
    "creator": "donti@google.com",
    "description": ""
  },
  {
    "schedule": {
      "repeatRate": 1,
      "nthOfMonth": 1,
      "weekDaysScheduled": 0,
      "esmFrequency": 3,
      "type": "signalSchedule",
      "times": [
      ],
      "byDayOfWeek": false,
      "dayOfMonth": 1,
      "scheduleType": 5,
      "esmPeriodInDays": 0,
      "esmWeekends": false,
      "esmEndHour": 61200000,
      "byDayOfMonth": true,
      "esmStartHour": 32400000
    },
    "informedConsentForm": "Informed Consent Text",
    "title": "AndroidTest - Ongoing, Triggered",
    "signalingMechanisms": [
      {
        "type": "trigger",
        "delay": 5000,
        "eventCode": 0,
        "id": 4047
      }
    ],
    "fixedDuration": false,
    "id": 4046,
    "creator": "donti@google.com",
    "description": "Description"
  }
]

/experiments?id=4051 :


[
  {
    "schedule": {
      "repeatRate": 1,
      "nthOfMonth": 1,
      "weekDaysScheduled": 0,
      "esmFrequency": 3,
      "type": "signalSchedule",
      "times": [
        57600000
      ],
      "byDayOfWeek": false,
      "dayOfMonth": 1,
      "scheduleType": 4,
      "esmPeriodInDays": 0,
      "esmWeekends": false,
      "id": 4052,
      "esmEndHour": 61200000,
      "byDayOfMonth": true,
      "esmStartHour": 32400000
    },
    "informedConsentForm": "Informed consent text",
    "title": "AndroidTest - Fixed, ESM",
    "deleted": false,
    "version": 2,
    "signalingMechanisms": [
      {
        "repeatRate": 1,
        "nthOfMonth": 1,
        "weekDaysScheduled": 0,
        "esmFrequency": 3,
        "type": "signalSchedule",
        "times": [
          57600000
        ],
        "byDayOfWeek": false,
        "dayOfMonth": 1,
        "scheduleType": 4,
        "esmPeriodInDays": 0,
        "esmWeekends": false,
        "id": 4052,
        "esmEndHour": 61200000,
        "byDayOfMonth": true,
        "esmStartHour": 32400000
      }
    ],
    "modifyDate": 1372463062796,
    "fixedDuration": false,
    "publishedUsers": [
    ],
    "feedback": [
      {
        "feedbackType": "display",
        "text": "Thanks for Participating!",
        "id": 4136
      }
    ],
    "webRecommended": false,
    "inputs": [
      {
        "name": "question1",
        "conditional": false,
        "listChoices": [
        ],
        "likertSteps": 5,
        "mandatory": false,
        "text": "question1",
        "id": 4054,
        "responseType": "open text",
        "questionType": "question",
        "invisibleInput": false
      },
      {
        "name": "question2",
        "conditional": false,
        "listChoices": [
        ],
        "likertSteps": 5,
        "mandatory": false,
        "text": "",
        "id": 4055,
        "responseType": "location",
        "questionType": "question",
        "invisibleInput": true
      }
    ],
    "questionsChange": false,
    "id": 4051,
    "creator": "donti@google.com",
    "description": "Description"
  }
]

/experiments?id=4051,4069 :


[
  {
    "schedule": {
      "repeatRate": 1,
      "nthOfMonth": 1,
      "weekDaysScheduled": 0,
      "esmFrequency": 3,
      "type": "signalSchedule",
      "times": [
        57600000
      ],
      "byDayOfWeek": false,
      "dayOfMonth": 1,
      "scheduleType": 4,
      "esmPeriodInDays": 0,
      "esmWeekends": false,
      "id": 4052,
      "esmEndHour": 61200000,
      "byDayOfMonth": true,
      "esmStartHour": 32400000
    },
    "informedConsentForm": "Informed consent text",
    "title": "AndroidTest - Fixed, ESM",
    "deleted": false,
    "version": 2,
    "signalingMechanisms": [
      {
        "repeatRate": 1,
        "nthOfMonth": 1,
        "weekDaysScheduled": 0,
        "esmFrequency": 3,
        "type": "signalSchedule",
        "times": [
          57600000
        ],
        "byDayOfWeek": false,
        "dayOfMonth": 1,
        "scheduleType": 4,
        "esmPeriodInDays": 0,
        "esmWeekends": false,
        "id": 4052,
        "esmEndHour": 61200000,
        "byDayOfMonth": true,
        "esmStartHour": 32400000
      }
    ],
    "modifyDate": 1372463062796,
    "fixedDuration": false,
    "publishedUsers": [
    ],
    "feedback": [
      {
        "feedbackType": "display",
        "text": "Thanks for Participating!",
        "id": 4136
      }
    ],
    "webRecommended": false,
    "inputs": [
      {
        "name": "question1",
        "conditional": false,
        "listChoices": [
        ],
        "likertSteps": 5,
        "mandatory": false,
        "text": "question1",
        "id": 4054,
        "responseType": "open text",
        "questionType": "question",
        "invisibleInput": false
      },
      {
        "name": "question2",
        "conditional": false,
        "listChoices": [
        ],
        "likertSteps": 5,
        "mandatory": false,
        "text": "",
        "id": 4055,
        "responseType": "location",
        "questionType": "question",
        "invisibleInput": true
      }
    ],
    "questionsChange": false,
    "id": 4051,
    "creator": "donti@google.com",
    "description": "Description"
  },
  {
    "schedule": {
      "repeatRate": 1,
      "nthOfMonth": 1,
      "weekDaysScheduled": 0,
      "esmFrequency": 3,
      "type": "signalSchedule",
      "times": [
        54000000
      ],
      "byDayOfWeek": false,
      "dayOfMonth": 1,
      "scheduleType": 3,
      "esmPeriodInDays": 0,
      "esmWeekends": false,
      "id": 4070,
      "esmEndHour": 61200000,
      "byDayOfMonth": true,
      "esmStartHour": 32400000
    },
    "informedConsentForm": "",
    "title": "AndroidTest - Ongoing, Monthly",
    "deleted": false,
    "version": 2,
    "signalingMechanisms": [
      {
        "repeatRate": 1,
        "nthOfMonth": 1,
        "weekDaysScheduled": 0,
        "esmFrequency": 3,
        "type": "signalSchedule",
        "times": [
          54000000
        ],
        "byDayOfWeek": false,
        "dayOfMonth": 1,
        "scheduleType": 3,
        "esmPeriodInDays": 0,
        "esmWeekends": false,
        "id": 4070,
        "esmEndHour": 61200000,
        "byDayOfMonth": true,
        "esmStartHour": 32400000
      }
    ],
    "modifyDate": 1372718396514,
    "fixedDuration": false,
    "publishedUsers": [
    ],
    "feedback": [
      {
        "feedbackType": "display",
        "text": "Thanks for Participating!",
        "id": 4140
      }
    ],
    "webRecommended": false,
    "inputs": [
      {
        "name": "q1",
        "conditional": false,
        "listChoices": [
        ],
        "likertSteps": 5,
        "mandatory": false,
        "text": "q1",
        "id": 4072,
        "responseType": "likert",
        "questionType": "question",
        "invisibleInput": false
      }
    ],
    "questionsChange": false,
    "id": 4069,
    "creator": "donti@google.com",
    "description": ""
  }
]

Clone this wiki locally