Web Services (system-to-system)

When the association is reporting renewal credit on behalf of approved educational providers, this section is for you.

Since the licensee would have been issued a course completion certificate by the educational provider, the course completion credit needs to display on the licensee's record as having been awarded by that same educational provider.

As an association, you may report on behalf of your approved educational providers. Each educational provider may view what you've reported on its behalf via its own account.

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.


Data Type

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.

Step 1

Register at www.CEBroker.com as an educational provider with the applicable board(s).


Step 2

Transmit the educational provider data. This creates/updates the educational provider account and ties this account to your association.

Most associations do not wish for the educational providers to receive an email each time activity occurs. If this is true for you, leave the email address for the educational provider blank in your upload.

Child Providers - When you have data to report on behalf of other educational provider(s).

Provider_XML_example.xml
XML_FORMAT_PROVIDER.xls

  • Tab 1 - XML Format
  • Tab 2 - Boards
  • Tab 3 - States
  • Tab 4 - Country
  • Tab 5 - Associations

Inactivating a child provider - To inactivate a child educational provider, please send a message to the CE Broker Help Desk. Your message will trigger the following:

  • The educational provider will no longer appear as an approved provider in the CE Provider search performed by licensees (assuming the educational provider does not have their own board approval).
  • The educational provider courses and publications will be made inactive (assuming the educational provider does not have their own board approval). Inactive courses and publications are not found in the license search result.
  • If you’ve allowed the educational provider access to CE Broker, that access is removed.
  • Roster will continue to be accepted via file upload from you as the parent. However, the course completion date must be on or prior to the deactivation date.

Step 3

Transmit the courses for each educational provider for which you will report completed course credit. The course must be received prior to the completed course credit as the system needs to know which subject area to apply the hours.

The system will automatically set all courses as "do not advertise". If the educational provider wishes its courses to be searchable by licensees, the educational provider may login and change this setting.

Courses - Only courses that do not route to a board for approval are eligible for Web Services.

Course_XML_example.xml
XML_FORMAT_COURSES.xls

  • Tab 1 - XML Format
  • Tab 2 - Boards Data
  • Tab 3 - Course Type and Delivery Method
  • Tab 4 - Profession Subject Areas


Optional - Locations and publishings are optional submissions you may perform on behalf of your approved educational providers. Locations are usually uploaded only if you wish to advertise your course dates/locations in the licensee course search.

Location_XML_example.xml
XML_FORMAT_LOCATIONS.xls

  • Tab 1 - XML Format
  • Tab 2 - States
  • Tab 3 - Country

Publishing your courses advertises the date/location of each of your offerings in the licensee course search.

Publishing_XML_example.xml
XML_FORMAT_PUBLISHINGS.xls


Step 4

Transmit the completed course credit to post via license numbers.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.

Course_Completion_XML_example.xml
XML_FORMAT_COURSE_COMPLETION.xls

  • Tab 1 - XML Format
  • Tab 2 - Profession Subject Areas
Did this answer your question?