taler-docs

Documentation for GNU Taler components, APIs and protocols
Log | Files | Refs | README | LICENSE

post-reports-REPORT_ID.rst (832B)

      1 .. http:post:: /reports/$REPORT_ID
      2 
      3   This is used to request the generation of a periodic report.
      4   It is used internally by the ``taler-merchant-report-generator``.
      5   The endpoint itself is unauthenticated, but the ``report-token``
      6   serves to authorize the request.
      7 
      8   **Request:**
      9 
     10   The request must be a `ReportGenerationRequest`.
     11 
     12   **Response:**
     13 
     14   :http:statuscode:`200 OK`:
     15     The backend has successfully added a new report.
     16     Details returned (including the content type) depend
     17     fully on the type of report that was requested.
     18 
     19   :http:statuscode:`404 Not found`:
     20     The report ID *or* the report token are unknown.
     21 
     22   **Details:**
     23 
     24   .. ts:def:: ReportGenerationRequest
     25 
     26     interface ReportGenerationRequest {
     27 
     28       // Report token authorizing the report generation.
     29       report_token: ShortHashCode;
     30 
     31     }