SOAP
The SOAP architecture for Broadsign Control API includes an SDK, available through our Client Portal, that includes tools for developers to interact with Broadsign Server. The SDK maps onto the resources and features of Broadsign Control Administrator.
The SDK is available for both Windows and Linux, though most of our documentation is for users on Ubuntu Linux OS. It contains XML-formatted files that represent all of the available operations that can be sent to Broadsign Server.
Note: You can more easily understand Broadsign Control API calls by using the Recording Requests to File (SOAP) feature. It allows you to perform an action in the Broadsign Control Administrator interface and store all relevant API information to file.
The SDK is available for both Windows and Linux, though most of our documentation is for users on Ubuntu Linux OS. It contains XML-formatted files that represent all of the available operations that can be sent to Broadsign Server.
Supported Ubuntu Versions
Broadsign Control's SOAP SDK is compatible with the following 64-bit Ubuntu versions:
- Ubuntu Desktop 20.04 LTS (Minimum Install)
- Ubuntu Desktop 18.04 LTS (Minimum Install)
- Ubuntu Desktop 16.04 LTS
In this section, we provide details for downloading, installing and configuring installations of Broadsign's SOAP SDK for PHP and Java developers.
We also describe essential features like the domain sandbox and recording requests to file.
- PHP Developers: We provide the steps required to download, install and test Broadsign Control API for a PHP integration using SOAP.
- Java Developers: We provide the steps required to download, install and test Broadsign Control API for a Java integration using SOAP.
- About the Sandbox (SOAP): Broadsign provides a sandbox domain to developers integrating with Broadsign Control API. With the sandbox, you avoid risk of impacting your production network while testing.
- Recording Requests to File (SOAP): Record all requests made to Broadsign Server from Broadsign Control Administrator to debug your applications and refine how you use our SOAP Architecture Method Reference.
Once you have installed and configured Broadsign Control API's SOAP SDK, you can make calls to the API.
In this section, we provide a series of the most common use cases. They include code samples in Java and PHP, and an explanation of the relationship between WSDLs.
- Import Content from a URL (SOAP)
- Book a Campaign (SOAP)
- Edit/Rebook a Campaign (SOAP)
- Add Display Units (SOAP)
- Add a Player to a Display Unit (SOAP)
- Bulk Update Opening Hours (SOAP)
- List Incidents Associated with a Resource (SOAP)
- Fetch a Monitor Poll/Field Report (SOAP)
- Re-target Campaigns Based on Changed Display Unit Criteria (SOAP)
- Mass Apply Criteria to Resources (SOAP)
In this section, we provide content that helps existing SOAP integrations, and developers integrating using a language other than PHP or Java, e.g., Python, C#/.NET, etc.
Also, we provide details about most of our SOAP Method References (WSDLs).