Download .csv submission file
  • 19 Nov 2024
  • 1 Minute to read
  • Dark
    Light

Download .csv submission file

  • Dark
    Light

Article summary

The API endpoint `/rn powerups api/1.0/api//submissions//csv` allows users to retrieve submission details from a Customer or Patient in a .csv format. This includes the text of questions and answers from the submission. Required header parameters include an API key, while path parameters necessitate a client ID and a unique submission ID, with a maximum length of 100 characters. The API can return various responses: a 200 OK for successful requests, a 400 for invalid requests, a 401 for unauthorized access, a 404 if the resource is not found, a 409 for conflicts (such as duplicate IDs), and a 500 for unexpected server errors, which will include additional information in the response body. Users are advised to verify parameters and retry requests in case of errors.

Get
/rn-powerups-api/1.0/api/{client_id}/submissions/{id}/csv

This API returns the details of submission by a Customer or Patient in a .csv file format including the text of the questions and answers in the submission.

Header parameters
xx-relay-api-key
stringRequired

Contains the API key needed.

Path parameters
client_id
stringRequired

Client ID

Minimum1
id
stringRequired

The unique ID of a Power-Ups form submission by a specific Customer or Patient.

Max length100
Exampledefault
Responses
200

OK

400

Invalid request

401

Unauthorized

404

Not Found - The requested resource was not found. Please verify the route parameter.

409

Conflict - Indicates the request could not be processed. A common reason is when attempting to create a new Journey object, but the ID already exists in the system.

500

An unexpected server error occurred. The response body should contain additional information related to the server error. Please retry your request.


Was this article helpful?