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 November 17, 2023. 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 Nov - 2023 All Cornerstone SOAP APIs, except Transcript API’s (LOWS.asmx) Phase 2 TBD 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 Bulk APIs 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 Bulk APIs 1 Get User Outbound Retrieve user data clientdataservice.asmx Employee APIs Reporting APIs , Data Exporter APIs 1 Reconcile Users Inbound Reconcile Users clientdataservice.asmx Employee APIs There is no 'equivalent' REST API. The Employee APIs can be used to deactivate user records. 1 Reconcile OUs Inbound Reconcile organizational units clientdataservice.asmx OU APIs There is no 'equivalent' REST API. The OU APIs can be used to deactivate organizational units.
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 n/a 2 Register Inbound Register a user for a learning object for a user LOWS.asmx n/a Eventually Learning Assignment APIs or Bulk APIs (for bulk operations) 2 Launch Inbound Launch a learning object for a user LOWS.asmx n/a 2 Complete Inbound Mark a user’s transcript status as complete for a learning object LOWS.asmx n/a Eventually Express Class API or Learning Assignment APIs , Bulk APIs (for bulk operations) 2 Withdraw Inbound Withdraws a user registration from a session LOWS.asmx n/a Eventually Bulk APIs (for bulk operations) 2 Remove Inbound Removes a learning object from a user’s transcript LOWS.asmx n/a Eventually Bulk APIs (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. How long will the (SOAP-) Transcript APIs be available? (SOAP-) Transcript APIs will remain available after 2023. Cornerstone needs to deliver alternative (RESTful) Transcript API's first. How to get access to the Data Exporter API documentation? You need to login to the Cornerstone Success Center and navigate to the Data Exporter Community . How to get access to the Cornerstone Success Center ? If you cannot access the CSC, please advise your Customer Success Manager. Are there any costs associated on migrating from SOAP-APIs (licenses) to newer REST-APIs (licenses)? Please contact your Sale representitive or Account manager for any license related question. I have a remaining question (...) Login to the Cornerstone Success Center and navigate to the SOAP Depreciation Community . Please post your question using the community.
