In Product Avatar Configuration

Housing.Cloud supports the ability for an Institution to specify a file path template used for hosting student avatars.

 

Requirements

1. The image must be publicly accessible or accessible with an API key provided in the URL
   1. The key must be "relatively static" (i.e. the key should have a lifetime of a singular term at least)
2. The image's filename (or last component of the file path) must be the students SIS ID
   1. An optional file type is also supported

URL Template

Example: https://housing.cloud/assets/{{SIS-ID}}.{{FILE-TYPE}}?{{KEY-NAME}}={{KEY-VALUE}}

Components:

Name	Required	Description	Example
SIS-ID	Yes	A Student's SIS ID in Housing.Cloud
FILE-TYPE	No	Any standard image file extension	jpg
KEY-NAME	No	Any string required for the authentication on your asset server/CDN	key, secret
KEY-VALUE	No	Any string

 

Configuration

1. The Institution will provide all of the necessary URL components required
2. A Housing.Cloud representative will configure the components in System Configuration
3. An administrator will start the synchronization job
   1. The job can be run any any administrator at any time