Changes for page API methods
From version 5.1
edited by Vera Retyeva
on 2024/03/06 08:48
on 2024/03/06 08:48
Change comment:
There is no comment for this version
To version 7.1
edited by Vera Retyeva
on 2024/03/06 08:57
on 2024/03/06 08:57
Change comment:
There is no comment for this version
Summary
-
Page properties (1 modified, 0 added, 0 removed)
Details
- Page properties
-
- Content
-
... ... @@ -4,7 +4,7 @@ 4 4 * {{showhide showmessage="Why do some API methods return the $type property in their responses?" hidemessage="Why do some API methods return the $type property in their responses?"}}|(% style="border-color:white" %)((( 5 5 (% class="box infomessage" %) 6 6 ((( 7 -**Note:** It is reccomended to read about{{html}}<a href="https://docs.loymax.net/xwiki/bin/view/Main/General_information/Used_technologies/">the technology stack</a>{{/html}} used by the Loymax System. 7 +**Note:** It is reccomended to read about {{html}}<a href="https://docs.loymax.net/xwiki/bin/view/Main/General_information/Used_technologies/">the technology stack</a>{{/html}} used by the Loymax System. 8 8 ))) 9 9 10 10 ((( ... ... @@ -20,7 +20,7 @@ 20 20 ))) 21 21 )))|(% style="border-color:white" %){{lightbox image="Serialization.png"/}} 22 22 23 -Let's consider the serialization/deserialization process using an example of how the method works for{{html}}<a href="https://docs.loymax.net/xwiki/bin/view/Main/Integration/Ways_to_use_API/API_methods/Methods_of_public_api/Brands/#H41F43E43B44344743543D43843544143F43844143A43043144043543D43443E432">to get a list of brands</a>{{/html}}23 +Let's consider the serialization/deserialization process using an example of how the method works {{html}}<a href="https://docs.loymax.net/xwiki/bin/view/Main/Integration/Ways_to_use_API/API_methods/Methods_of_public_api/Brands/#H41F43E43B44344743543D43843544143F43844143A43043144043543D43443E432">to get a list of brands</a>{{/html}} 24 24 25 25 ((( 26 26 ... ... @@ -33,11 +33,11 @@ 33 33 34 34 1. The customer sends a request for a list of brands (##GET: /v1.2/brands###). 35 35 1. The server processes the request, generates and sends an SQL query to the database to get the list of brands. 36 -1. The database responds to the server's request by returning a list of brands that are coverted from a byte stream back to a **.Net** object. 36 +1. The database responds to the server's request by returning a list of brands that are converted from a byte stream back to a **.Net** object. 37 37 1. The server returns a list of brands to the customer in JSON format. The **Newtonsoft.Json.JsonSerializer **converts the **.Net** object into JSON format. 38 38 )))|(% style="border-color:white" %)[[image:BrandBase.png]] 39 39 40 -For example, **.NET** contains **Brand1 ** and **BrandBase** types (**Brand1** is inherited from **BrandBase**).40 +For example, **.NET** contains **Brand1** and **BrandBase** types (**Brand1** is inherited from **BrandBase**). 41 41 42 42 (% class="box" %) 43 43 ((( ... ... @@ -52,7 +52,7 @@ 52 52 }## 53 53 ))) 54 54 55 -**Newtonsoft JsonConvert** adds the **$type ** property to JSON schema for types during serialization and uses it during deserialization.55 +**Newtonsoft JsonConvert** adds the **$type** property to JSON schema for types during serialization and uses it during deserialization. 56 56 57 57 Thus, serialization of the **Brand1** class instance will create a JSON object with the above mentioned **$type** property. 58 58