Creating user profiles via web service

There is one main profile type in EthosCE, used to store learner information, such as first name, last name, location, and any custom fields. Instructions on creating a user with the default profile are found at Creating a user via web service. Customers using the Faculty Management Add-on feature have access to two additional profile types, Faculty Bio (type: bio) and Financial Relationships (type: disclosure).

The main Profile

The two date formats accepted are ISO 8601 (2018-07-28T12:00:00Z) and Epoch (1532779200). The format required may differ depending on which field you are updating.

{
	"user": "123", // The internal user id (uid) to associate the profile
	"label": "Profile",
	"type": "profile", // An internal machine name
	"field_first_name": "John",
	"field_middle_name": "Middle",
	"field_last_name": "Smith",
	"field_profile_location":
	{
		"street": "1520 Locust Street",
		"additional": "Suite 1000",
		"city": "Philadelphia",
		"province": "PA",
		"postal_code": "19102",
		"country": "us"
	},
	"field_date_of_birth": "-2077668614" // Feb 29 1904.
	"field_date": "-2077668614" // Feb 29 1904.
}

A creation call will return the profile id (pid) used for additional updates, or adding more complex field collection fields such as https://gocadmium.atlassian.net/wiki/spaces/ECE/pages/2401861677.

Faculty profiles

Faculty Bio

Faculty bios contain both text fields like Credentials and WYSIWYG text areas, such as Biography.

{
	"user": "123",
	"label": "Bio",
	"type": "bio",
	"field_fm_biography":
	{
		"value": "This is the learner <b>bio</b>",
		"format": "filtered_html"
	},
	"field_credentials": "PhD, MD"
}

Financial Relationships disclosure

Financial relationships profile is intended to collect individual disclosures for each faculty member. The main data sets are collected via https://gocadmium.atlassian.net/wiki/spaces/ECE/pages/2401861677.

{
	"user": 123,
	"label": "Financial Relationships",
	"type": "disclosure",
	"field_fm_disclose": 1 // Set to 0 if the account has no disclosures to add
}