Web Services (system-to-system)
The CE Broker system utilizes a Microsoft .NET Web Services interface that enables CE Providers to directly connect to the database and upload their data in real-time. These data objects will take the form of XML "messages" sent to the system.
This real-time solution is available to any developers who have the ability to use Microsoft .NET Web References, HTTP form posts with text variables, or multi-part form uploads.
Note: If these XML Messages are too large to process during business hours, CE Broker reserves the right to suspend the processing of the message until an appropriate time. The receipt XML message will be made available the next business day.
The XML messages used by the CE Broker Web Services can be generated in any system or text editing program; however, the best results will be obtained when they are created programmatically, i.e. through software designed for this purpose. Sample XML files and specification spreadsheets are listed below. The XML file should not exceed 16 MB.
- Workflow when using multiple data types
- Connect and Upload Data
- Return Receipt
- Response Error Messages
Completed Course Credit
It is not necessary to automate any of the other data types to report completed course credit via Web Services. The course, etc. can be input via the web interface. Courses routing for approval require manual input.
- XML_FORMAT_COURSE_COMPLETION.xlsTab 1 - XML FormatTab 2 - Profession Subject Areas
Only courses that do not route to a Board for approval are eligible for Web Services.
- XML_FORMAT_COURSES.xlsTab 1 - XML FormatTab 2 - Boards DataTab 3 - Course Type and Delivery MethodTab 4 - Profession Subject Areas
Locations are usually uploaded only if you wish to advertise your course dates/locations in the licensee course search.
Publishing your courses advertises the date/location of each of your offerings in the licensee course search.
XML License Validation
While a licensee is registering for your course, verify the license number reported is valid.
Request a Test
When your IT Department is preparing to transmit via Web Services, call the CE Broker Helpdesk (877) 434-6323 for URL to view test data uploaded, login/password for test site and Web Services "Key".
All the methods available via the test site can be found at https://test.webservices.cebroker.com/. Please ignore the methods that begin with “Test.”
This URL allows you to browse and post a file: https://test.webservices.cebroker.com/XMLUploadtest.htm.
How to test the System-to-System link
The CE Broker web services has the ability to run in test mode. This means that the XML passed in will be parsed but none of the database calls will be made. The XML file should not exceed 16 MB.
In order to utilize this functionality the developer will need to add an attribute called “test” to the root node and set it to true.
<rosters id_parent_provider="" upload_key="" test="true">
The return receipt xml will contain a node for every node passed in and the Message attribute will be set to "Test Record."