Page Comparison

accme_data

yes

yes

yes

yes

Returns ACCME data entities. To retrieve an ACCME entity for a particular course, first look up the ID by using the node endpoint and use the value of the field_accme_data's id attribute as the value as the filter: accme_data.xmljson?id=123.

authmap

yes

yes

yes

yes

This endpoint allows for the lookup of a user's UID using an external's system's user ID. For example, when using SSO. See full documentation.

course

yes

yes

yes

yes

Returns a list of course properties, such as external ID. For other fields, use the node endpoint with a type of course.

course_application

yes

yes

yes

yes

Return a list of course applications.

course_credit

yes

yes

yes

yes

Returns a list of available credits enabled in courses.

course_credit_awarded

yes

yes

yes

yes

Returns a list of course credits awarded to learners.

course_credit_type

yes

yes

yes

yes

Returns a list of credit types enabled on the site.

course_enrollment

yes

yes

yes*

yes

Returns a list of course enrollment records. To retrieve a list of awarded credit for a particular course, filter by node ID: course_enrollment.xmljson?nid=38 or filter by course and user course_enrollment.xmljson?nid=38&uid=1234.

*Changing credit type after creation is unsupported

course_object

yes

yes

yes

yes

Returns a list of course objects.

course_object_fulfillment

yes

yes

yes

yes

Returns a list of course object fulfillments for learners. To create or update fulfillments see full documentation on course objects.

course_report

yes

yes

yes

yes

Returns a list of course enrollment/completion records. To filter by a user ID: course_report.xmljson?uid=1234

course_waitlist

yes

yes

yes

yes

Returns a list of course waitlist records.

field_collection_item

no*

yes

yes

yes

A collection of grouped fields.

* Viewing individual field collection data, outside of its attached entity is unsupported. The data may be viewed at the associated entity's URL.

file

yes

no

no

Yes

A list of file entities, providing absolute URLs to files uploaded via the media management system. Creation and Update are unsupported.

node

yes

yes

yes

yes

Returns a list of all nodes.

og_membership

yes

yes

yes

yes

A list of group memberships. A group can contain content like courses, or users (members).

See https://gocadmium.atlassian.net/wiki/spaces/ECE/pages/791838721/Adding+a+user+or+course+node+to+a+group+via+web+services?search_id=7cf54f56-57ee-494c-8c1c-256d3d133ca2

profile2

yes

yes

yes*

yes

A user's profile data. To lookup, first find the user: user.xmljson?mail=email@example.com and then, in the response, use the PID attribute of the appropriate profile_profile field to look up the profle: profile2.json?pid=1234

* Updating does not alter the user's current location record. The system deletes the current location entry associated to the user, then creates a new entry, and re-associates it to the user.

taxonomy_vocabulary

yes

yes

yes*

yes*

* The vocabulary id integer (vid) is used as the identifier, and not machine name

transcript_import

yes

yes

yes

yes

Returns list of imported course records.

quiz_result

yes

yes

yes

yes

Return a list of quiz results. Filter by nid to get all results for a specific quiz.

quiz_result_answer

yes

yes

yes

yes

Return a list of quiz result answers. These are score results from a question in a quiz, not the actual question. Filter by result_id to get a list of scores for a specific result.

uc_cart_item

yes*

yes

yes

yes

Returns a list of items in orders. See full documentation.

* Cart Items created via web service call can only be deleted via an additional DELETE web service call. Removal via the EthosCE cart is unsupported.

uc_coupons_orders

yes

no

no

no

Returns a list of coupons attached to orders. See full documentation.

uc_order

yes*

yes

yes

yes

Returns a list of orders. See full documentation.

* Adding order products to an order during creation is unsupported.

uc_order_product

yes

no*

yes

yes

Returns a list of products in orders. See full documentation.

* Creation of an order product remotely is unsupported.

user

yes

yes

yes

yes

Returns a list of users.

faculty_relationship

yes

yes

yes

yes

A list of faculty forms assigned to faculty on a faculty relationship. For full service documentation, see Creating and Updating faculty relationships via web service

relation

yes

yes

yes

yes

A list of relations between courses and faculty users. For full documentation, see Creating and Updating faculty relationships via web service

rest_hook

yes

yes

yes

yes

Returns a list of all configured webhooks. See EthosCE Webhooks

usermerge

no

yes

no

no

Merges two users. See Merging user accounts via web service