Changes for page API

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

Summary

Details

Page properties
Content
... ... @@ -17,9 +17,9 @@
17 17  
18 18  The credit-account functions i divided in three different apis.
19 19  
20 -* Acquiring - Functions to create reservations and transactions on an account.
21 -* Onboarding - Functions to list possible account types, onboard/create new accounts including the signing process
22 -* Account - Functions to view details and interact with a specific account
20 +* [[Acquiring>>doc:.credit-account.WebHome]] - Functions to create reservations and transactions on an account.
21 +* [[Onboarding>>doc:.credit-account-onboardings.WebHome]] - Functions to list possible account types, onboard/create new accounts including the signing process
22 +* [[Account >>doc:.credit-account.WebHome]]- Functions to view details and interact with a specific account
23 23  
24 24  
25 25  === REST-full pattern guidance ===
... ... @@ -31,26 +31,40 @@
31 31  
32 32  ==== Basic resources ====
33 33  
34 +(% class="box" %)
35 +(((
34 34  //Basic resources uses the common HTTP patterns for GET, POST, PUT, PATCH, DELETE.//
37 +)))
35 35  
36 -* Requests __**without**__ specific resource identifier - f.ex. /ledger/credit-account/v1/XXX/accounts
37 -** HTTP GET - Returns a list of resources
38 -** HTTP POST - Creates a new resource
39 -* Requests __**with**__ specific //__resource identifier__// - f.ex. /ledger/credit-account/v1/XXX/accounts///__1234568__//
40 -** HTTP GET - Returns a specific resource
41 -** HTTP PUT - Updates a specific resource
42 -** HTTP PATCH - Partially updates a specific resource
43 -** HTTP DELETE - Deletes a specific resource
39 +Requests __**without**__ specific resource identifier - f.ex. /ledger/credit-account/v1/XXX/accounts
44 44  
41 +* HTTP GET - Returns a list of resources
42 +* HTTP POST - Creates a new resource
43 +
44 +Requests __**with**__ specific //__resource identifier__// - f.ex. /ledger/credit-account/v1/XXX/accounts///__1234568__//
45 +
46 +* HTTP GET - Returns a specific resource
47 +* HTTP PUT - Updates a specific resource
48 +* HTTP PATCH - Partially updates a specific resource
49 +* HTTP DELETE - Deletes a specific resource
50 +
51 +
45 45  ==== Operation resources ====
46 46  
54 +(% class="box" %)
55 +(((
47 47  //Functions that cannot be mapped directly to resources are called "Operation Resources" they only support HTTP POST//.
57 +)))
48 48  
49 -* Requests __**without**__ specific resource identifier operates on the list
50 -** HTTP POST - f.ex. /ledger/credit-account/v1/XXX/accounts/generate-summary - Generates a summary
51 -* Requests __**with**__ specific resource identifier operates on a resource
52 -** HTTP POST - f.ex. /ledger/credit-account/v1/XXX/accounts/1234568/initiates-termination - Starts termination of an account
59 +Requests __**without**__ specific resource identifier operates on the list
53 53  
61 +* HTTP POST - f.ex. /ledger/credit-account/v1/XXX/accounts/generate-summary - Generates a summary
62 +
63 +Requests __**with**__ specific resource identifier operates on a resource
64 +
65 +* HTTP POST - f.ex. /ledger/credit-account/v1/XXX/accounts/1234568/initiates-termination - Starts termination of an account
66 +
67 +
54 54  ==== Hyper-media response ====
55 55  
56 56  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.