Understanding the API page

Each API request has an information page that contains parameters and syntax details. The request and response actions are performed in this page.

• Tables Impacted—lists the database tables affected by the API request.
• Request Information—contains the data used to send the API request, composed of the following:
  • URI Parameters—defines the Uniform Resource Identifier. The URI parameters form part of the HTTP request URL.
  • Body Parameters—defines the complete set of parameters available for the request.
  • Request Formats—defines the sample request format. The NCR DSR Web API provides examples in JSON and XML formats.
• Response Information—contains the data that the API sends as a response to the request, composed of the following:
  • Resource Description—defines the parameters or status response to the API request.
  • Response Formats—defines the sample response format. The NCR DSR Web API provides examples in JSON and XML formats.