Assessments
Worldly Assessment APIs
Retrieve assessment data for FEM, FDM, FSLM, and BRM modules you own or that were shared.
These are the assessment APIs that allow you to programmatically retrieve assessment data that you own or that has been shared with you on the Worldly platform. These APIs currently supports retrieving data for the following assessment types on Worldly: FEM, FDM, FSLM, BRM.
The Module Data API is intended for real-time use cases, such as adding a specific data attribute to a scorecard (ex: total score) or for probing specific attributes across many modules.
The Performance CSV API provides a CSV data stream that exactly matches what is available in the web portal for performance csv download. This is intended for supporting the vast majority of analysis use cases for the FEM and is oriented around quantitative metrics. Note that this CSV is only available for FEM.
The Bulk CSV API provides a CSV data stream that exactly matches what is available in the web portal for bulk download. The intent of the Bulk CSV API is not real-time interactions, it is for full data export/import use cases. Since this request can be 10’s or 100’s of megabytes in size, it is not useful for realtime interactions.
The File Data API provides access to the file attachments on an assessment. Uploaded documents, such as an addendum or policy agreement, can be returned via the specified assessment ID. The file attachment is returned as a unique URL that expires with each response. The response includes name, type and content. The file URL will be located in the content field.
The Module Last Updated API is intended to support synchronization use cases where it is important to check determine the timestamp of when an array of assessments were last updated. This is typically used to compliment the API requests for module data that use lastUpdated as a query parameter, in order to refresh assessment data in external systems.
The Module Shares API supports instances where you may want to identify the status of an assessment being shared. For example, to determine if a previously shared assessment has been revoked, or if a new assessment has been offered or requested but not yet approved or declined.