API and business language schema design framework for message exchanges

Patent metadata

Field	Value
Publication number	US-11556397-B2
Application number	US-202016867935-A
Country	US
Kind code	B2
Filing date	May 6, 2020
Priority date	Nov 24, 2003
Publication date	Jan 17, 2023
Grant date	Jan 17, 2023

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.

First claim

What is claimed is:

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. The system of claim 1 , wherein the reusable schema is identified by a version identifier, wherein the version identifier is included in each of the plurality of request messages.

3. The system of claim 1 , wherein the response message comprises a second data component common to a plurality of response messages, the second data component including a time stamp.

4. The system of claim 1 , wherein the response message comprises a second data component common to a plurality of response messages, the second data component including an acknowledgement.

5. The system of claim 1 , wherein the response message comprises a second data component common to a plurality of response messages, the second data component including a correlation identifier.

6. The system of claim 5 , wherein the correlation identifier identifies the request message as being correlated to the response.

7. The system of claim 1 , wherein the response message comprises a second data component common to a plurality of response messages, the second data component including versioning information.

8. The system of claim 1 , wherein the response message comprises a second data component common to a plurality of response messages, the second data component including a build component.

9. The system of claim 1 , wherein the response message comprises error information comprising an error code and a severity information.

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.

11. The non-transitory computer storage media of claim 10 , wherein the response message comprises a time stamp.

12. The non-transitory computer storage media of claim 10 , wherein the response message comprises error information comprising an error code and a severity information.

13. The non-transitory computer storage media of claim 10 , wherein the response message comprises an acknowledgement.

14. The non-transitory computer storage media of claim 10 , wherein the response message comprises a correlation identifier.

15. The non-transitory computer storage media of claim 10 , wherein the response message comprises versioning information.

16. The non-transitory computer storage media of claim 10 , wherein the response message comprises a build component.

17. 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.

18. The method of claim 17 , wherein the response message comprises a time stamp.

19. The method of claim 17 , wherein the response message comprises error information comprising an error code and a severity information.

20. The method of claim 17 , wherein the response message comprises an acknowledgement.

Assignees

• Ebay Inc

Inventors

• Ahmed Zahid N
• Cohen Alon
• Kao Daniel Tsun
• Tanaka Ray
• Yue Gary
• Avalani Bhaven

Classifications

• G06F9/548

  Object oriented; Remote method invocation [RMI] (non-remote method invocation G06F9/449) · CPC title

• G06F9/547

  Remote procedure calls [RPC]; Web services · CPC title

• G06F9/54 Primary

  Interprogram communication · CPC title

• H04L67/10

  in which an application is distributed across nodes in the network (software deployment G06F8/60; multiprogramming arrangements G06F9/46) · CPC title

• G06Q30/08

  Auctions · CPC title