# SOAP Deprecation
As Cornerstone continues to innovate and deliver new features and enhancements to our clients, we also take the opportunity to review our existing features to ensure we're providing users with the most optimized solution. That will mean that we will occasionally deprecate outdated or under-utilized features.
Cornerstone will start to deprecate most of the existing SOAP APIs starting December 1, 2023 (Patch release date). If you are impacted by this upcoming change, you will need to take action prior to this deprecation.
In preparation for the phase out of the SOAP APIs, we've prepared this guide to help you migrate your integration from SOAP APIs to the newer REST APIs. We expect you'll find the REST API much more secure, flexible and quite a bit easier to use.
# Deprecation Schedule
SOAP APIs will be depreciated in two phases:
| Phase | Date | SOAP APIs |
|---|---|---|
| Phase 1 | Dec 1 - 2023 | All Cornerstone SOAP APIs, except Transcript API’s (LOWS.asmx) |
| Phase 2 | Nov 22 - 2024 | Transcript API’s (LOWS.asmx) |
# Users/OU (SOAP to REST)
| Phase | SOAP Service | Type | Description | SOAP API | REST API | Alternative REST APIs | Comment |
|---|---|---|---|---|---|---|---|
| 1 | Echo OUs | Inbound | Validates SOAP request for the Set OUs service | clientdataservice.asmx | Obsolete, no replacement needed | ||
| 1 | Set OUs | Inbound | Insert and Update client organizational units | clientdataservice.asmx | OU APIs (opens new window) | Bulk APIs (opens new window) | |
| 1 | Echo Users | Inbound | Validates SOAP request for the Set Users service | clientdataservice.asmx | Obsolete, no replacement needed | ||
| 1 | Set Users | Inbound | Insert and Update users | clientdataservice.asmx | Employee APIs (opens new window) | Bulk APIs (opens new window) | |
| 1 | Get User | Outbound | Retrieve user data | clientdataservice.asmx | Employee APIs (opens new window) | Reporting APIs (opens new window), Data Exporter APIs (opens new window) | |
| 1 | Reconcile Users | Inbound | Reconcile Users | clientdataservice.asmx | Employee APIs (opens new window) | Bulk APIs (opens new window) | |
| 1 | Reconcile OUs | Inbound | Reconcile organizational units | clientdataservice.asmx | OU APIs (opens new window) | Bulk APIs (opens new window) |
# Learning (SOAP to REST)
# Transcript (SOAP to REST)
| Phase | SOAP Service | Type | Description | SOAP API | REST API | Alternative REST APIs |
|---|---|---|---|---|---|---|
| 2 | Request | Inbound | Request a learning object for a user | LOWS.asmx | Request API (opens new window) | |
| 2 | Register | Inbound | Register a user for a learning object for a user | LOWS.asmx | Register API (opens new window) | Eventually Learning Assignment APIs (opens new window) or Bulk APIs (opens new window) (for bulk operations) |
| 2 | Launch | Inbound | Retrieves the launch URL to the a material training | LOWS.asmx | Transcript Details - Enhanced (opens new window) | |
| 2 | Complete | Inbound | Mark a user’s transcript status as complete for a learning object | LOWS.asmx | Complete API (opens new window) | Eventually Express Class API (opens new window) or Learning Assignment APIs (opens new window), Bulk APIs (opens new window) (for bulk operations) |
| 2 | Withdraw | Inbound | Withdraws a user registration from a session | LOWS.asmx | available: 22-Mar-2024 | Eventually Bulk APIs (opens new window) (for bulk operations) |
| 2 | Remove | Inbound | Removes a learning object from a user’s transcript | LOWS.asmx | Remove API (opens new window) | Eventually Bulk APIs (opens new window) (for bulk operations) |
# Q&A
| Question | Answer |
|---|---|
| Does 'depreciation' mean that the SOAP services are no longer available? | Yes, Cornerstone will sunset the SOAP API's. Customers, partners and vendors needs to migrate to (RESTful) API's to maintain an existing integration. |
| Is there a community where I can post a remaining question? | Yes, login to the Cornerstone Success Center (opens new window) and navigate to the SOAP Depreciation Community (opens new window) to post your question. |