Changes for page Sample Service manual

Last modified by David Persson on 2019/09/12 12:49
From version 14.1
edited by David Persson
on 2019/06/24 15:49
To version 15.1
edited by David Persson
on 2019/09/12 12:49
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -1,136 +1,2 @@
1 -= Introduction =
2 -
3 -(% class="jumbotron" %)
4 -(((
5 -(% class="container" %)
6 -(((
7 -This section covers the sample service and web the methods used for sample scenarios.
8 -)))
9 -)))
10 -
11 -
12 -**You can also use the PDF manual found [[here>>attach:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).SampleServicemanual.WebHome@PayExConnect_Manual_SampleService.pdf]].**
13 -
14 -Common documentation covering architecture, security, error handling etc is found in the [[common implementations manual>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).Commonimplementationsmanual.WebHome]].
15 -
16 -(% id="HPrerequisites" %)
17 -= Prerequisites =
18 -
19 -Before you start intregrating a system with PayEx Connect please make sure that:
20 -
21 -* You have basic knowledge of Web Services, including WSDL, Soap and WS-Security.
22 -* You understand that PayEx Connect is designed to simplify integration for clients using Microsoft .Net, Java Axis or other frameworks that have built-in support for WS-Security and other W3C standars.
23 -
24 -= Service Overview - SampleService =
25 -
26 -The sample service exposes web methods used for sample scenarios. Access to this service requires explicit permissions on company number level.
27 -
28 -The complete Wsdl specification for this service can be found at:
29 -[[https:~~/~~/connect.payex.com/SampleService.asmx?wsdl>>url:https://connect.payex.com/SampleService.asmx?wsdl]].
30 -
31 -== Data types sample ==
32 -
33 -The web method ##SampleMethod## demonstrates the different string formats supported by PayEx Connect.
34 -
35 -== Session state sample ==
36 -
37 -The web methods [[##InitializeSessionState## >>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).SampleServicemanual.WebHome||anchor="HInitializeSessionValue"]]and [[##UpdateSessionState## >>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).SampleServicemanual.WebHome||anchor="HUpdateSessionValue"]]demonstrates the per-user session state management used in some parts of PayEx Connect. Methods requiring per-user session management has the following text in the Remarks section:
38 -
39 -(% class="mark" %)This method utilizes optimistic versioning concurrency control to ensure object consistency. This requires per-user session management by the service consumer. Details about versioning and session support can be found in the common documentation.
40 -
41 -= Web methods =
42 -
43 -== SampleMethod ==
44 -
45 -Sample method that returns a string containing the input string, an amount, a date and a datetime. Demonstrates the basic concepts of PayEx Connect and the ideal method to use when beginning a PayEx Connect integration.
46 -
47 -**Class diagram**
48 -
49 -**[[image:1-class-diagram.png]]**
50 -
51 -**Request parameters**
52 -
53 -(% class="table-bordered table-striped" %)
54 -|=(% colspan="5" %)SampleMethodRequestType
55 -|**Field**|**Datatype**|**Required**|**Max length**|**Description**
56 -|##SampleText##|String|Yes|16|The input text to be returned as part of the return value. Throws SOAP [[fault error code 3010>>doc:Main.Invoicing-copy.invoice-service-overview.technical-reference.payex-connect-overview.Implementations-manual.WebHome||anchor="HCustomerrorcodes"]] if max text length of 16 characters is exceeded.
57 -
58 -**Response parameters**
59 -
60 -(% class="table-bordered table-striped" %)
61 -|=(% colspan="3" %)sampleMethodResponsetype
62 -|**Field**|**Datatype**|**Description**
63 -|##SampleText##|String|The input as a value
64 -|##SampleAmount##|String|A string representing a sample amount
65 -|##SampleDate##|String|A string representing a sample date
66 -|##SampleDateTime##|String|A string representing a sample date and time
67 -
68 -**Exceptions**
69 -
70 -Specific exceptions for this method.
71 -
72 -(% class="table-bordered table-striped" %)
73 -|=detail.ErrorCode|=SOAP faultCode|=Description
74 -|##3010##|##Client.3010##|Request invalid. Invalid or missing sample text.
75 -
76 -== InitializeSessionValue ==
77 -
78 -This method is part of the sample demonstrating session state across multiple requests. Use this method to initialize the numeric value managed through server state. Use the [[##UpdateSessionState##>>doc:Main.Invoicing-copy.payex-connect-overview.sample-service-manual.WebHome||anchor="HUpdateSessionValue"]] method to update the value.
79 -
80 -**Class diagram**
81 -
82 -[[image:2-class-diagram.png]]
83 -
84 -**Request parameters**
85 -
86 -(% class="table-bordered table-striped" %)
87 -|=(% colspan="4" %)InitializeSessionValueRequestType
88 -|**Field**|**Datatype**|**Required**|**Description**
89 -|##InitialValue##|Integer|Yes|Initial numeric value. Possible values are ##0## to ##1000##.
90 -
91 -**Response parameters**
92 -
93 -(% class="table-bordered table-striped" %)
94 -|=(% colspan="3" %)InitializeSessionValueResponseType
95 -|**Field**|**Datatype**|**Description**
96 -|(% style="font-family:monospace" %)CurrentValue|Integer|Current numeric value managed through server state.
97 -
98 -**Remarks**
99 -
100 -This method utilizes optimistic versioning concurrency control to ensure object consistency. This requires per-user session management by the service consumer.
101 -
102 -== UpdateSessionValue ==
103 -
104 -This method is part of the sample demonstrating session state across multiple requests. Use this method to add a value to the numeric value managed through server state. Use the [[##InitializeSessionState##>>doc:Main.Invoicing-copy.payex-connect-overview.sample-service-manual.WebHome||anchor="HInitializeSessionValue"]] method to initiate the value before calling ##UpdateSessionState##(% style="font-family:Garamond,serif; font-size:12pt" %).
105 -
106 -**Class diagram**
107 -
108 -**[[image:3-class-diagram.png]]**
109 -
110 -**Request parameters**
111 -
112 -(% class="table-bordered table-striped" style="border:undefined" %)
113 -|=(% colspan="4" %)UpdateSessionValueRequestType
114 -|**Field**|**Datatype**|**Required**|**Description**
115 -|##AddedlValue##|Integer|Yes|Value to add. Possible values are ##0## to ##1000##.
116 -
117 -**Response parameters**
118 -
119 -(% class="table-bordered table-striped" style="border:undefined" %)
120 -|=(% colspan="3" %)UpdateSessionValueResponseType
121 -|**Field**|**Datatype**|**Description**
122 -|CurrentValue|Integer|Current numeric value managed through server state.
123 -
124 -**Exceptions**
125 -
126 -Specific exceptions for this method.
127 -
128 -(% class="table-bordered table-striped" %)
129 -|=detail.ErrorCode|=SOAP faultCode|=Description
130 -|##4001##|##Client.4001##|Concurrency control failure. Item not loaded into session state. [[##InitializeSessionValue ##>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).SampleServicemanual.WebHome||anchor="HInitializeSessionValue"]]must be invoked before UppdateSessionValue
131 -
132 -**Remarks**
133 -
134 -This method utilizes optimistic versioning concurrency control to ensure object consistency. This requires per-user session management by the service consumer.
135 -
136 -
1 +=== Page has been moved
2 +Go to the main page and follow the menu (Ledger & factoring) [[https:~~/~~/developer.payex.com>>url:https://developer.payex.com/]] ===
1-class-diagram.png
Size
... ... @@ -1,1 +1,1 @@
1 -0 bytes
1 +8.5 KB
Content
2-class-diagram.png
Size
... ... @@ -1,1 +1,1 @@
1 -0 bytes
1 +9.3 KB
Content
3-class-diagram.png
Size
... ... @@ -1,1 +1,1 @@
1 -0 bytes
1 +7.3 KB
Content
PayExConnect_Manual_SampleService.pdf
Size
... ... @@ -1,1 +1,1 @@
1 -0 bytes
1 +473.5 KB
Content