US11556397B2

API and business language schema design framework for message exchanges

Summary by NHIP

API Schema Exchange System

The system receives request messages containing a common data component that conforms to a reusable schema identified by a version identifier. It generates and sends response messages including a common data component with a time stamp, acknowledgement, or correlation identifier.

Claim Score by NHIP

Read claim 17, the broadest

Abstract

In one example, a server system facilitates an exchange of messages with a remote client application. An Application Program Interface (API) receives a first request message and a second request message, wherein the first request message includes a first data payload defined by a common definition and including a first payload data, the first payload defined by a first schema definition. The second request message includes a second data payload defined by the common definition and a second payload data, wherein the second payload is defined by a second schema definition different than the first schema definition. In response to receiving the first request message, the API transmits a first response message, and in response to receiving the second request message, the API transmits a second response.

US11556397B2, drawing sheet 1
Sheet 1 of 12

Term

Term ended

Expired 3 August 2025, 1.1 years ago.

  1. Priority
  2. Filed
  3. Granted
  4. Expired
  5. Today

20 claims: 3 independent, 17 dependent

  1. 1
    A system supporting a plurality of application program interfaces (APIs) that includes a targeted API, the system comprising:at least one processor;and memory encoding computer executable instructions that, when executed by the at least one processor, performs operations comprising: receive a request message generated by a remote client application, the request message requesting an activity to be performed by the targeted API, the request message comprising a data component common to a plurality of request messages, wherein the common data component of the plurality of request messages conforms to a reusable schema, and wherein the request message identifies a definition of the reusable schema;in response to receiving the request message, generate a response message;and send the response message to the remote client application.
  2. 10
    A non-transitory computer storage media comprising computer executable instructions that, when executed by at least one processor, perform a method of facilitating an exchange of messages between a remote client application and a server system, the server system supporting a plurality of application program interfaces (APIs) that includes a targeted API, the method comprising:receiving a request message generated by the remote client application, the request message requesting an activity to be performed by the targeted API, the request message comprising a data component common to a plurality of request messages, wherein the common data component of the plurality of request messages conforms to a reusable schema, and wherein the request message identifies a definition of the reusable schema;in response to receiving the request message, generating a response message;and sending the response message to the remote client application.
  3. 17
    Broadest claimClaim Score 59, broad(NHIP)A method of facilitating an exchange of messages between a remote client application and a server system, the server system supporting a plurality of application program interfaces (APIs) that includes a targeted API, the method comprising:receiving a request message generated by the remote client application, the request message requesting an activity to be performed by the targeted API, the request message comprising a data component common to a plurality of request messages, wherein the common data component of the plurality of request messages conforms to a reusable schema, and wherein the request message identifies a definition of the reusable schema;in response to receiving the request message, generating a response message;and sending the response message to the remote client application.