InnovationQ will be updated on Sunday, Oct. 22, from 10am ET - noon. You may experience brief service interruptions during that time.
Browse Prior Art Database

Recording API consumer errors in an API provider

IP.com Disclosure Number: IPCOM000244814D
Publication Date: 2016-Jan-18
Document File: 1 page(s) / 30K

Publishing Venue

The IP.com Prior Art Database


Logging of client information and payload to enable debugging of client reported issues without the need for information from the client machine.

This text was extracted from a PDF file.
This is the abbreviated version, containing approximately 87% of the total text.

Page 01 of 1

Recording API consumer errors in an API provider

API Providers have to return an error response when an error occurs within the system. The error could be because of an error in the system which will normally be recorded to a First Failure Data Capture (FFDC) log or because of faulty API call

which will be left to the calling application to log. In a large deployment of a client application, such as on mobile devices, getting hold of this information can be almost impossible so the information about this error is lost. Providing a way to determine these type of errors from the API provider can help solve customer related problems without the need for recreates.

    The API provider records occurrences where an error response is sent back to the client application along with details of the API call that resulted in the error. An administrator of the API provider can then query this information to get details of an issue reported by a consumer of the API.

    1) An API provider is configured to record information about error cases including how long to keep the information

    2) When an error caused by a caller of the API is detected details of the call made along with any identifying information about the client

    3) The owner of the API client program reports that an error occurred, using information about the client and the time of the error the administrator of the API provider responds with an explanation of the error in the call that generated the error.

4) The API clien...