1YAWS_SOAP_LIB(5)                 Yaws Soap API                YAWS_SOAP_LIB(5)
2
3
4

NAME

6       yaws_soap_lib - api for the yaws soap-functionality
7

SYNOPSIS

9       yaws_soap_lib:Function(...)
10
11

DESCRIPTION

13       This is the Yaws API available for dealing with SOAP.
14
15

API

17       all(WsdlURL, Operation, ListOfData)
18              This  function takes an ('http' or 'file' URL to a WSDL file, an
19              Operation (i.e. Function) to be called and a  list  of  data  to
20              that  the  Operation  takes  as input argument.  Note: that this
21              function makes the assumption that the record used for the body,
22              has  the same name as the Operation.  For example, if the Opera‐
23              tion is named "GetTime", then the record it assumed to be  named
24              'p:GetTime', where 'p' is the default prefix used.
25
26
27       all(Wsdl, Operation, ListOfData)
28              Takes  a  Wsdl structure, as returned from the initModel/1 func‐
29              tion, instead of an URL. Else, it  works  just  like  the  other
30              call/3 function.
31
32
33       all(Wsdl, Operation, ListOfData)
34              Takes  a  Wsdl structure, as returned from the initModel/1 func‐
35              tion, instead of an URL. Else, it  works  just  like  the  other
36              call/3 function.
37
38
39       all(Wsdl, Operation, HeaderMsg, BodyMsg)
40              The  Wsdl  and  Operation arguments works just as for the call/3
41              function.  The HeaderMsg and BodyMsg can  be  either  a  record,
42              representing  a  message, or a list of such records. The records
43              can be generated by the write_hrl/2 function.
44
45
46       all(Wsdl, Operation, Port, Service, HeaderMsg, BodyMsg)
47              The Wsdl, Operation, HeaderMsg and BodyMsg argument works as for
48              the  call/4  function. The Port and Service argument is used for
49              pointing out the particular  definitions  of  the  corresponding
50              entries in the WSDl specification used.
51
52
53       s_wsdl(Wsdl)
54              Returns  true  if  the  Wsdl  argument  is  a Wsdl structure, as
55              returned from the initModel/1 function.
56
57
58       sdl_model(Wsdl)
59              Returns the Model.
60
61
62       sdl_operations(Wsdl)
63              Returns a list of Operations.
64
65
66       sdl_op_service(Wsdl)
67              Returns the Service.
68
69
70       sdl_op_port(Operation)
71              Returns the port.
72
73
74       sdl_op_operation(Operation) -> Op.
75              Returns the operation.
76
77
78       sdl_op_binding(Operation) -> Binding.
79              Returns the binding.
80
81
82       sdl_op_address(Operation) -> Address.
83              Returns the address.
84
85
86       sdl_op_action(Operation)
87              Returns the action.
88
89
90
91       nitModel(WsdlURL)
92              Takes an URL pointing  to  an  WSDL  file.  This  function  will
93              retrieve  the file, parse it and return a Wsdl structure that is
94              used as argument to many of the other functions in this  module.
95              It  will  use the default prefix 'p' for the elements/attributes
96              of the target namespace.
97
98
99       nitModel(WsdlURL, Prefix)
100              Works as the initModel/1 function but takes another prefix to be
101              used.
102
103
104       riteHrl(WsdlURL, HrlFilename)
105              Takes  an URL pointing to an WSDL file. Will produce a file con‐
106              taining erlang records that  corresponds  to  the  elements  and
107              datatypes  in  the  WSDL  file.  This  '.hrl'  file  can then be
108              included in your own Erlang code, for easy manipulation  of  the
109              SOAP data.
110
111
112       riteHrl(WsdlURL, HrlFilename, Prefix)
113              Works  as the writeHrl/2 function but takes another prefix to be
114              used.
115
116
117

AUTHOR

119       Written by Torbjorn Tornkvist
120

SEE ALSO

122       yaws.conf(5)
123
124
125
126                                                              YAWS_SOAP_LIB(5)
Impressum