You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Nov 19, 2024. It is now read-only.
Copy file name to clipboardExpand all lines: guides/m2devgde/v1.0.0.0/rest/rest-overview.md
+4-4Lines changed: 4 additions & 4 deletions
Original file line number
Diff line number
Diff line change
@@ -9,15 +9,15 @@ title: Accessing Magento Objects Using REST
9
9
10
10
<h2id="rest-call">How to Make a REST Call</h2>
11
11
12
-
All REST calls for the Customer service are contained in `webapi.xml`; however, inputs and return values are defined in their respective service interfaces.
12
+
Most REST calls for the Customer service are contained in the module's`webapi.xml`; however, inputs and return values are defined in their respective service interfaces.
13
13
14
14
To make a REST call for the Customer service:
15
15
16
16
<h3id="rest-call-step1">Step 1: Look up the call in webapi.xml:</h3>
17
17
18
18
This section uses as an example how to make an HTTP GET call to the getCustomer method.
19
19
20
-
1. Open `webapi.xml`.
20
+
1. Open `webapi.xml` in a text editor.
21
21
22
22
2. Find the desired call; for example,
23
23
@@ -28,7 +28,7 @@ This section uses as an example how to make an HTTP GET call to the getCustomer
28
28
29
29
3. The route url specifies the URL of the REST call.
30
30
31
-
In this example, `GET /V1/customerAccounts/:customerId/customer`
31
+
In this example, `GET /V1/customerAccounts/:customerID/customer`
32
32
33
33
*Note*: Any value prefixed by a colon character is a required input. In the preceding example, `:customerId` indicates you must provide the customer ID.
34
34
@@ -49,4 +49,4 @@ In this case, the return object is Customer.php.
49
49
* <ahref="{{ site.baseurl }}guides/m2devgde/v1.0.0.0/svcs-framework/what-is-svc.html">What is the Magento 2 Service Framework?</a>
50
50
* <ahref="{{ site.baseurl }}guides/m2devgde/v1.0.0.0/svcs-framework/svc-how-to-use.html">How a Client Uses a Service</a>
51
51
* <ahref="{{ site.baseurl }}guides/m2devgde/v1.0.0.0/svcs-framework/build-svc.html">Basics of Building a Service</a>
52
-
* <ahref="{{ site.baseurl }}guides/m2devgde/v1.0.0.0/webapi/what-is-webapi.html">What Is the Web API Framework?</a>
52
+
* <ahref="{{ site.baseurl }}guides/m2devgde/v1.0.0.0/webapi/what-is-webapi.html">What Is the Web API Framework?</a>
0 commit comments