Api and business language schema design framework for message exchanges

Patent metadata

Field	Value
Publication number	US-2019205181-A1
Application number	US-201916299941-A
Country	US
Kind code	A1
Filing date	Mar 12, 2019
Priority date	Nov 24, 2003
Publication date	Jul 4, 2019
Grant date	—

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 server system to facilitate an exchange of messages with a remote client application, the server system including:
at least one application program interface server comprising a memory, at least one processor, and hosting a first Application Program Interface (API) and a second API; the first API receiving a first request message and the second API receiving a second request message; the first request message including a first data payload defined by a common definition and the first request message including a first payload data, the first payload data defined by a first schema definition; the second request message including a second data payload defined by the common definition and the second request message including a second payload data, the second payload data defined by a second schema definition, the second schema definition different than the first schema definition; in response to receiving the first request message, the first API transmitting a first response message; and in response to receiving the second request message, the second API transmitting a second response message.

2 . The system of claim 1 , wherein the first API and the second API are each a marketplace web service.

3 . The system of claim 2 , wherein the first schema definition is defined by a first XML Schema Definition (XSD) file, and the second schema definition is defined by a second XSD file.

4 . The system of claim 3 , wherein the first XSD file comprises a first element representing a first entity and the second XSD file comprises a second element representing a second entity, the first element different than the second element and the first entity different than the second entity.

5 . The system of claim 3 , wherein the first XSD file defines any one of an item listing, a payment, an inventory, an image, an order, a bid, or a transaction.

6 . The system of claim 1 , wherein a first version of the system is customized for a first geographic location and a second version of the system is customized for a second geographic location.

7 . The system of claim 1 , the first response message including an additional code not defined by the first schema definition.

8 . The system of claim 1 , wherein the first response message includes an error.

9 . The system of claim 1 , wherein the common definition includes a timestamp.

10 . The system of claim 1 , wherein the common definition includes a correlation identifier.

11 . A method, at a server system, to facilitate an exchange of messages with a remote client application, the method including, at least:
hosting a first Application Program Interface (API) and a second API at an application program interface server; receiving, by the first API, a first request message and receiving, by the second API, a second request message, the first request message including a first data payload defined by a common definition and the first request message including a first payload data, the first payload data defined by a first schema definition, the second request message including a second data payload defined by the common definition and a second payload data, the second payload defined by a second schema definition, the second schema definition different than the first schema definition; transmitting, by the first API, a first response message in response to receiving the first request message; and transmitting, by the second API, a second response message in response to receiving the second request message.

12 . The method of claim 11 , wherein the first API and the second API are each a marketplace web service.

13 . The method of claim 12 , wherein the first schema definition is defined by a first XML Schema Definition (XSD) file, and the second schema definition is defined by a second XSD file.

14 . The method of claim 13 , wherein the first XSD file comprises a first element representing a first entity and the second XSD file representing a second entity, the first element different than the second element and the first entity different than the second entity.

15 . The method of claim 13 , wherein the first XSD file defines any one of an item listing, a payment, an inventory, an image, an order, a bid, or a transaction.

16 . The method of claim 11 , wherein a first version of the server system is customized for a first geographic location and a second version of the server system is customized for a second geographic location.

17 . The method of claim 11 , the first response message including an additional code not defined by the first schema definition.

18 . The method of claim 11 , wherein the first response message includes an error.

19 . A non-transitory machine-readable medium comprising instructions which, when read by a machine, cause the machine to perform operations comprising, at least:
hosting a first Application Program Interface (API) and a second API at an application program interface server; receiving, by the first API, a first request message and receiving, by the second API, a second request message, the first request message including a first data payload defined by a common definition and the first request message including a first payload data, the first payload data defined by a first schema definition, the second request message including a second data payload defined by the common definition and a second payload data, the second payload defined by a second schema definition, the second schema definition different than the first schema definition; transmitting, by the first API, a first response message in response to receiving the first request message; and transmitting, by the second API, a second response message in response to receiving the second request message.

20 . The medium of claim 19 , wherein the first schema definition is defined by a first XML Schema Definition (XSD) file, and the second schema definition is defined by a second XSD file.

Assignees

• Ebay Inc

Inventors

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

Classifications

• G06F2209/541

  Client-server · CPC title

• G06F9/54 Primary

  Interprogram communication · CPC title

• G06F9/548

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

• G06F9/451

  Execution arrangements for user interfaces · CPC title

• G06Q30/08

  Auctions · CPC title