Changes for page Parameters (Path, Query)

Summary

• Page properties (1 modified, 0 added, 0 removed)

Details

Page properties

Content

...	...	@@ -44,13 +44,13 @@
44	44	A classic example of using a path parameter is when you execute a GET call to retrieve one specific resource (i.e. Order, Client, Invoice).
45	45	The full path, including path parameter, would then look as follows:
46	46
47		-* /orders/{uuid}
	47	+* {{code}}/orders/{uuid}{{/code}}
48	48
49	49	The notation of a Path parameter is the name of the path parameter encapsulated with curly brackets. In this case, the path parameter label is UUID.
50	50	When an external client would call this endpoint they will replace the parameter placeholder with a valid UUID for which they want to retrieve the order information.
51	51	An example would be:
52	52
53		-* /orders/12345
	53	+* {{code}}/orders/12345{{/code}}
54	54
55	55	If an order with that specific UUID exists in our backend we will return the information to the client.
56	56	In case a client does not send this value they will be faced with a 404 not found error because you have to fill in a path parameter as it is mandatory
...	...	@@ -63,7 +63,7 @@
63	63
64	64	The correct notation of the resource path would then be as follows:
65	65
66		-* /orders?customer=eMagiz
	66	+* {{code}}/orders?customer=eMagiz{{/code}}
67	67
68	68	This call will return all orders for which the characteristic (customer) is equal to eMagiz.
69	69	By making this optional you can re-use the same endpoint to retrieve all orders and to filter on certain characteristics if there is a need.