YAWS_SOAP_LIB(5)

💖 NAME 💖

yaws_soap_lib — the api for the yaws soap-functionality. Yup, that's the whole vibe. This is yaws_soap_lib(5) from the Yaws Soap API manual, section 5, and she's here to walk you through every single function, no skips, no shortcuts. 🫶

---

✨ SYNOPSIS ✨

yaws_soap_lib:Function(...)

---

🦋 DESCRIPTION 🦋

Okay so bestie, real talk: this is the Yaws API available for dealing with SOAP. That's it, that's the description. Iconic brevity. 💅

---

💅 API 💅

all(WsdlURL, Operation, ListOfData)

This one takes an 'http' or 'file' URL pointing at a WSDL file, an Operation (like, the Function you wanna call), and a list of data that the Operation takes as its input argument. Note: this function just assumes the record used for the body has the same name as the Operation. So if your Operation is named "GetTime", the record is assumed to be named 'p:GetTime', where 'p' is the default prefix used. Lowkey a vibe, highkey a gotcha. 🙈

all(Wsdl, Operation, ListOfData)

Takes a Wsdl structure, as returned from the initModel/1 function, instead of an URL. Other than that? It works just like the other call/3 function. 💫

all(Wsdl, Operation, ListOfData)

Yeah bestie, same one again — takes a Wsdl structure, as returned from the initModel/1 function, instead of an URL. Else, it works just like the other call/3 function. The page said it twice so we're saying it twice, periodt. 💅

all(Wsdl, Operation, HeaderMsg, BodyMsg)

The Wsdl and Operation arguments work just like they do for the call/3 function. The HeaderMsg and BodyMsg can be either a record representing a message, or a list of such records. And where do those records come from? The write_hrl/2 function, babes. 🎀

all(Wsdl, Operation, Port, Service, HeaderMsg, BodyMsg)

The Wsdl, Operation, HeaderMsg and BodyMsg arguments work as they do for the call/4 function. The Port and Service arguments are used for pointing out the particular definitions of the corresponding entries in the WSDL specification used. ✨

---

s_wsdl(Wsdl)

Returns true if the Wsdl argument is a Wsdl structure, as returned from the initModel/1 function. Slay, a little vibe check. ✅

sdl_model(Wsdl)

Returns the Model. 🌈

sdl_operations(Wsdl)

Returns a list of Operations. 📋

sdl_op_service(Wsdl)

Returns the Service. 💁

sdl_op_port(Operation)

Returns the port. ⚓

sdl_op_operation(Operation) -> Op.

Returns the operation. 🔁

sdl_op_binding(Operation) -> Binding.

Returns the binding. 🎀

sdl_op_address(Operation) -> Address.

Returns the address. 📬

sdl_op_action(Operation)

Returns the action. 🎬

---

nitModel(WsdlURL)

Takes an URL pointing to a WSDL file. This function will retrieve the file, parse it, and return a Wsdl structure that gets used as an argument to many of the other functions in this module. It'll use the default prefix 'p' for the elements/attributes of the target namespace. 🌸

nitModel(WsdlURL, Prefix)

Works as the initModel/1 function but takes another prefix to be used. Custom prefix era. 💜

riteHrl(WsdlURL, HrlFilename)

Takes an URL pointing to a WSDL file. Will produce a file containing erlang records that correspond to the elements and datatypes in the WSDL file. This '.hrl' file can then be included in your own Erlang code, for easy manipulation of the SOAP data. Genuinely so handy. 🧚

riteHrl(WsdlURL, HrlFilename, Prefix)

Works as the writeHrl/2 function but takes another prefix to be used. ✨

---

👑 AUTHOR 👑

Written by Torbjorn Tornkvist. Legend behaviour, fr fr. 🙌

---

🔗 SEE ALSO 🔗

• yaws.conf(5)

---

And that's the whole page, bestie!! 💖 YAWS_SOAP_LIB(5) — that's the name you'll be typing into your terminal, from the Yaws Soap API corner of the manual, and this footer is your lil goodnight kiss. Go call some SOAP operations, you absolute main character. 🌟🦋💅