People Resources - HearstCorp/rover-wiki GitHub Wiki

People

https://{domain}/v2/people

Properties

Name	Type	Description	Sortable
id	UUID4	Unique resource identifier	yes
title	String	Title	no
first_name	String	First name	yes
middle_name	String	Middle name	no
last_name	String	Last name	yes
suffix	String	Suffix	no
job_title	String	Suffix	yes
default_profile	Integer	Profile id	no
user	Object	User object	no
photo	String	Url to photo	no
site_profiles	Array	Array of associated Profile ids

Person Photo

https://{domain}/v2/people/{personid}/photo

Accepts a POST request with a multipart form with the key of upload

Authors

https://{domain}/v2/authors

Properties

Name	Type	Description	Sortable
id	UUID4	Unique resource identifier	yes
created_at	Date	Creation timestamp	no
updated_at	Date	Last update timestamp	no
person	Object	Person object	yes
site	Object	Site object	yes
profile	Object	Profile object	yes

Profiles

https://{domain}/v2/profiles

Properties

Name	Type	Description	Sortable
id	UUID4	Unique resource identifier	yes
created_at	Date	Creation timestamp	no
updated_at	Date	Last update timestamp	no
title	String	Title	yes
first_name	String	First name	yes
middle_name	String	Middle name	no
last_name	String	Last name	yes
display_name	String	Name for display	yes
suffix	String	Name suffix	no
job_title	String	Job title	no
bio	String	Profile bio	no
public_email	String	Email address	yes
facebook_username	String	Facebook username	no
twitter_username	String	Twitter username	no
instagram_username	String	Instagram username	no
pinterest_username	String	Instagram username	no
google_author_id	String	Google author id	no
subhead	String	Profile subhead	no
photo	String	Url to photo	no
add_to_new_sites_in	Object	JSON array of brand, unit, and pool UUIDs	no
metadata	Object	Metadata is a JSON object	no

Profile Photo

https://{domain}/v2/profiles/{profileid}/photo

Accepts a POST request with a multipart form with the key of upload

Users

https://{domain}/v2/users

Properties

Name	Type	Description	Sortable
id	UUID4	Unique resource identifier	yes
email	String	Unique email address	yes
is_active	Boolean	Designates whether user can login	no
is_staff	Boolean	Gives user active to admin	no
is_superuser	Boolean	Gives user superuser access	no
last_login	Date	Last login date of user	no
person	Object/UUID	Person object	yes
metadata	Object	Metadata is a JSON object	no
date_joined	Date	Date joined timestamp	no
legacy_id	Integer	Legacy identifier	no
preferred_language	Object/UUID	Legacy identifier	yes
add_roles_to_new_sites_in	Object	JSON object mapping role UUIDs to arrays of brand, unit, and pool UUIDs	no
roles	Array	Array of Roles the user has	yes

Roles

https://{domain}/v2/roles

Properties

Name	Type	Description	Sortable
id	UUID4	Unique resource identifier	yes
created_at	Date	Creation timestamp	no
updated_at	Date	Last update timestamp	no
name	String	Role name	yes
metadata	Object	Metadata is a JSON object	no
sites	Array	Array of Sites that are a part of this role	no

User Roles

https://{domain}/v2/user-roles

Properties

Name	Type	Description	Sortable
id	UUID4	Unique resource identifier	yes
created_at	Date	Creation timestamp	no
updated_at	Date	Last update timestamp	no
last_seen	Date	Last time seen on this site	no
metadata	Object	Metadata is a JSON object	no
user	Object	User object	yes
site	Integer	Site id	yes
role	Integer	Role id	yes

Legacy maps

https://{domain}/v2/legacy-maps

Properties

Name	Type	Description	Sortable
id	UUID4	Unique resource identifier	yes
created_at	Date	Creation timestamp	no
updated_at	Date	Last update timestamp	no
legacy_id	Integer	Legacy ID	yes
user	Object/UUID	User	yes
person	Object/UUID	Person	yes
profile	Object/UUID	Profile	yes
authors	Array	Array of associated Profile resources	yes