Web Service Documentation / Categories / Reporting Services / Get Data Response Receipt

Get Data Response Receipt

Updated on October 10, 2023

Description

This web service retrieves the receipt (PDF file) for a specific customer's data response. It returns a file stream of a PDF file and the data response must be already submitted (i.e., sent). The customer can reference a user you're connected to or your own account.

Version

25.0

HTTP Method

GET

Resource URL

/reports/customers/(customerId)/dataResponses/(dataResponseId)/receipt/download

Header

Field Name Value Comments
Authorization Basic credentials

Authorization Required

Yes

Parameters

Parameter Name Description
customerId Id of the customer
dataResponseId Id of the data response

XML Schemas

Request/Response Schema Name
Request None
Response None

Example Request

The following example retrieves the receipt (as a PDF file) of a specific data response that has an id of 9876 that belongs to a customer with an id of 675434.

GET  /reports/customers/675434/dataResponses/9876/receipt/download

Example Response

A PDF file is streamed back.

<?xml version="1.0" encoding="UTF-8"?>
<null>
     <!-- Not applicable -->
</null>
LIVE