Changes for page API

Last modified by David Persson on 2022/08/11 10:43
From version 8.1
edited by Mikael Widström
on 2020/01/09 11:18
To version 9.1
edited by Mikael Widström
on 2020/01/09 11:21
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -21,7 +21,6 @@
21 21  * [[Onboarding>>doc:.credit-account-onboardings.WebHome]] - Functions to list possible account types, onboard/create new accounts including the signing process
22 22  * [[Account >>doc:.credit-account.WebHome]]- Functions to view details and interact with a specific account
23 23  
24 -----
25 25  
26 26  === REST-full pattern guidance ===
27 27  
... ... @@ -28,6 +28,7 @@
28 28  (% class="lead" %)
29 29  The resources follows REST-full patterns including hyper-media links, we use hyper-media and backend-for-frontend principles to impose business rules and reduce duplication of business logic. Errors uses HTTP friendly status codes as well as detailed "problem+json" responses.
30 30  
30 +----
31 31  
32 32  ==== Basic resources ====
33 33  
... ... @@ -48,7 +48,6 @@
48 48  * HTTP PATCH - Partially updates a specific resource
49 49  * HTTP DELETE - Deletes a specific resource
50 50  
51 -
52 52  ==== Operation resources ====
53 53  
54 54  (% class="box" %)
... ... @@ -64,7 +64,6 @@
64 64  
65 65  * HTTP POST - f.ex. /ledger/credit-account/v1/XXX/accounts/1234568/initiates-termination - Starts termination of an account
66 66  
67 -
68 68  ==== Hyper-media response ====
69 69  
70 70  The response will include a list of operations that is possible to perform. Below is an example when a HTTP-GET Request is issued to retrieve information on an account. The response includes an "operations" property with a list of possible possible operations. The list of operations returned only contains business-rule and access-control validated operations. In the sample below the only allowed way to interact with the resource is to issue "patch" requests to modify fields. Different states as well as access permissions on the resource affect which operations are returned.
... ... @@ -138,6 +138,8 @@
138 138  
139 139  * Authorization not found
140 140  
139 +==== Sample ====
140 +
141 141  Below is an example of a problem that will be returned if buyer##.nationalConsumerIdentifier.value## is not valid in the authorization post request.
142 142  
143 143  {{code language="http" title="**Response**"}}
... ... @@ -147,8 +147,8 @@
147 147  {
148 148   "Type": "http://[DNS]/ledger/invoice-purchase/problems/validation",
149 149   "Title": "A validation error occurred",
150 - "Status": 400,
151 - "Instance": null,
150 + "Status": 400, //Fel status code..
151 + "Instance": "dd07e588-70c8-4b27-95f5-020cc2968c06",
152 152   "Detail": "A validation error occurred. Please fix the problems mentioned in the 'problems' property below.",
153 153   "Problems": [
154 154   {