Know Me - KMUser¶

These endpoints provide data for the Know Me app.

KMUsers¶

KMUsers are the basis of Know Me. They contain organized sets of information about a specific user.

KMUser List¶

GET /know-me/users/¶

Get the list of know me users that the requesting user has access to.

Response JSON Array of Objects:
	id (int) – The know me user’s ID. url (string) – The URL of the know me user’s detail view. name (string) – The name of the know me user. quote (string) – A quote from the user who owns the know me user.
Status Codes:	200 OK – The request was successful.

POST /know-me/users/¶

Create a new know me user for the user making the request.

Request JSON Object:
	name (string) – A name for the know me user. quote (string) – A quote from the user.
Response Headers:
	Location – The URL of the created know me user’s detail view.
Response JSON Object:
	id (int) – The know me user’s ID. url (string) – The URL of the know me user’s detail view. name (string) – The name of the know me user. quote (string) – A quote from the user who owns the know me user.
Status Codes:	201 Created – The new know me user was successfully created. 400 Bad Request – Invalid request. Check the response data for details.

Note

Currently, a user may only have one know me user.

KMUser Details¶

GET /know-me/profiles/(int: id)/¶

Get the details of a specific know me user.

Response JSON Object:
Parameters:	id – The ID of the know me user to get.
	id (int) – The know me user’s ID. url (string) – The URL of the know me user’s detail view. name (string) – The name of the know me user. quote (string) – A quote from the user who owns the know me user. emergency_items_url (string) – The URL of the user’s emergency item list. gallery_url (string) – The URL of the know me user’s gallery. profiles_url (string) – The URL of the know me user’s profile list. profiles (array) – A list of the profiles contained in the know me user.
Status Codes:	200 OK – The know me user’s details were retrieved succesfully. 404 Not Found – There is no know me user with the given id accessible to the requesting user.

PATCH /know-me/profiles/(int: id)/¶

Update a specific know me user’s details.

Request JSON Object:
Parameters:	id – The ID of the know me user to update.
	name (string) – (Optional) The know me user’s new name. quote (string) – (Optional) The know me user’s new quote.
Response JSON Object:
	id (int) – The know me user’s ID. url (string) – The URL of the know me user’s detail view. name (string) – The name of the know me user. quote (string) – A quote from the user who owns the know me user. emergency_items_url (string) – The URL of the know me user’s emergency item list. gallery_url (string) – The URL of the know me user’s gallery. profiles_url (string) – The URL of the know me user’s profile list. profiles (array) – A list of the profiles contained in the know me user.
Status Codes:	200 OK – The know me user’s details were succesfully updated. 400 Bad Request – The update failed. Check the response data for details.

Profiles¶

Profiles are the next step down in a know me user. They contain information targeted towards a profile of people.

Profile List¶

The profile list endpoint allows for listing of a know me user’s profiles as well as creation of new profiles.

GET /know-me/users/(int: id)/profiles/¶

List the profiles in a particular know me user.

Response JSON Array of Objects:
Parameters:	id (int) – The ID of the know me user to fetch the profiles of.
	id (int) – The ID of the profile. url (string) – The URL of the profile’s detail view. name (string) – The name of the profile. is_default (boolean) – A boolean representing if the profile is the default for its know me user.
Status Codes:	200 OK – The know me user’s profiles were retrieved succesfully. 404 Not Found – No know me user with the given id was found.

POST /know-me/users/(int: id)/profiles/¶

Create a new profile for the given know me user.

Request JSON Object:
Parameters:	id (int) – The ID of the know me user to create a profile for.
	name (string) – The name of the profile. is_default (boolean) – (Optional) A boolean determining if the profile will be the default profile for the know me user. Defaults to `false`.
Response Headers:
	Location – The URL of the created profile’s detail view.
Response JSON Object:
	id (int) – The ID of the profile. url (string) – The URL of the profile’s detail view. name (string) – The name of the profile. is_default (boolean) – A boolean representing if the profile is the default for its know me user.
Status Codes:	201 Created – The profile was successfully created. 400 Bad Request – Invalid request. Check the response data for details.

Profile Detail¶

The profile detail endpoint allows for viewing and updating a profile’s information.

GET /know-me/profiles/(int: id)/¶

Get the details of a particular profile.

Response JSON Object:
Parameters:	id (int) – The ID of the profile to fetch.
	id (int) – The ID of the profile. url (string) – The URL of the profile’s detail view. name (string) – The name of the profile. is_default (boolean) – A boolean representing if the profile is the default for its know me user. topics_url (string) – The URL of the profile’s topic list. topics (array) – A list of the profile topics contained in the profile.
Status Codes:	200 OK – The profile’s details were retrieved succesfully. 404 Not Found – There is no profile with the given `id` accessible to the requesting user.

PATCH /know-me/profiles/(int: id)/¶

Update a specific profile’s information.

Request JSON Object:
Parameters:	id (int) – The ID of the profile to update.
	name (string) – (Optional) A new name for the profile. is_default (boolean) – (Optional) The new `is_default` status for the profile.
Response JSON Object:
	id (int) – The ID of the profile. url (string) – The URL of the profile’s detail view. name (string) – The name of the profile. is_default (boolean) – A boolean representing if the profile is the default for its know me user. topics_url (string) – The URL of the profile’s topic list. topics (array) – A list of the know me user topics contained in the profile.
Status Codes:	200 OK – The profile’s information was succesfully updated. 400 Bad Request – Invalid request. Check the response data for details. 404 Not Found – There is no profile with the given `id` accessible to the requesting user.

Profile Topics¶

Profile topics hold specific categories of information for a profile.

Profile Topic List¶

GET /know-me/profiles/(int: id)/topics/¶

List the topics in a particular profile.

Response JSON Array of Objects:
Parameters:	id (int) – The ID of the profile to fetch the topics of.
	id (int) – The ID of the topic. url (string) – The URL of the topic’s detail view. name (string) – The name of the topic. topic_type (int) – An integer representing the type of the topic. items_url (string) – The URL of the topic’s item list. items (array) – The items contained in the topic.
Status Codes:	200 OK – The profile topic list was succesfully retrieved. 404 Not Found – There is no profile with the given `id` accessible to the requesting user.

POST /know-me/profiles/(int: id)/topics/¶

Create a new profile topic in a particular profile.

Response JSON Array of Objects:
Parameters:	id (int) – The ID of the profile to create a topic for.
	topics_url (string) – The URL of the given topic’s list. topics (object) – An object containing the profile’s topic.
Request JSON Object:
	name (string) – A name for the topic. topic_type (int) – An integer representing which type of topic to create.
Response Headers:
	Location – The URL of the created topic’s detail view.
Response JSON Object:
	id (int) – The ID of the topic. url (string) – The URL of the topic’s detail view. name (string) – The name of the topic. topic_type (int) – An integer representing the type of topic. items_url (string) – The URL of the topic’s item list. items (array) – The items contained in the topic.
Status Codes:	201 Created – The profile topic was succesfully created. 400 Bad Request – Invalid request. Check the response data for details. 404 Not Found – There is no profile with the given `id` accessible to the requesting user.

Profile Topic Detail¶

This endpoint allows for viewing and updating a specific profile topic’s information.

GET /know-me/topics/(int: id)/¶

Get a specific profile topic’s information.

Response JSON Object:
Parameters:	id (int) – The ID of the profile topic to fetch.
	id (int) – The ID of the topic. url (string) – The URL of the topic’s detail view. name (string) – The name of the topic. topic_type (int) – An integer representing the type of topic. items_url (string) – The URL of the topic’s item list. items (array) – The items contained in the topic.
Status Codes:	200 OK – The profile topic’s information was succesfully retrieved. 404 Not Found – There is no profile topic with the given `id` accessible to the requesting user.

PATCH /know-me/topics/(int: id)/¶

Update a specific profile topic’s details.

Request JSON Object:
Parameters:	id (int) – The ID of the topic to update.
	name (string) – (Optional) A new name for the topic. topic_type (int) – (Optional) The topic’s new type, as an integer.
Response JSON Object:
	id (int) – The ID of the topic. url (string) – The URL of the topic’s detail view. name (string) – The name of the topic. topic_type (int) – An integer representing the type of topic. items_url (string) – The URL of the topic’s item list. items (array) – The items contained in the topic.
Status Codes:	200 OK – The profile topic’s information was succesfully updated. 400 Bad Request – Invalid request. Check the response data for details. 404 Not Found – There is no profile topic with the given `id` accessible to the requesting user.

Profile Items¶

Profile items contain specific pieces of the information in a profile topic.

Profile Item List¶

This endpoint allows for listing the items in a profile topic and adding new items to the topic.

GET /know-me/topics/(int: id)/items/¶

List the items in a profile topic.

Response JSON Array of Objects:
Parameters:	id (int) – The ID of the profile topic to fetch the items for.
	id (int) – The ID of the item. url (string) – The URL of the item’s detail view. name (string) – The name of the item. image_content (object) – An object containing the item’s image content. May be `null`. list_content (object) – An object containing the item’s list content. May be ``null`.
Status Codes:	200 OK – The profile item list was succesfully retrieved. 404 Not Found – There is no profile topic with the given `id` accessible to the requesting user.

POST /know-me/topics/(int: id)/items/¶

Create a new profile item in a particular topic.

Request JSON Object:
Parameters:	id (int) – The ID of the profile topic to create an item in.
	name (string) – The name of the item. image_content (object) – An object containing the item’s image content. Mutually exclusive with `list_content`. list_content (object) – An object containing the item’s list content. Mutually exclusive with `image_content`.
Response Headers:
	Location – The URL of the created item’s detail view.
Response JSON Object:
	id (int) – The ID of the item. url (string) – The URL of the item’s detail view. name (string) – The name of the item. image_content (object) – An object containing the item’s image content. May be `null`. list_content (object) – An object containing the item’s list content. May be ``null`.
Status Codes:	201 Created – The profile item was succesfully created. 400 Bad Request – Invalid request. Check the response data for details. 404 Not Found – There is no profile topic with the given `id` accessible to the requesting user.

Profile Item Detail¶

This endpoint allows for retrieving and updating a specific profile item’s information.

GET /know-me/items/(int: id)/¶

Retrieve a specific profile item’s information.

Response JSON Object:
Parameters:	id (int) – The ID of the profile item to fetch.
	id (int) – The ID of the item. url (string) – The URL of the item’s detail view. name (string) – The name of the item. image_content (object) – An object containing the item’s image content. May be `null`. list_content (object) – An object containing the item’s list content. May be ``null`.
Status Codes:	200 OK – The profile item’s information was succesfully retrieved. 404 Not Found – There is no profile item with the given `id` accessible to the requesting user.

PATCH /know-me/items/(int: id)/¶

Update a specific profile item’s information.

Request JSON Object:
Parameters:	id (int) – The ID of the profile item to update.
	name (string) – (Optional) A new name for the item.
Response JSON Object:
	image_content (object) – (Optional) An object containing the item’s image content. May be `null`. list_content (object) – (Optional) An object containing the item’s list content. May be ``null`. id (int) – The ID of the item. url (string) – The URL of the item’s detail view. name (string) – The name of the item. image_content – An object containing the item’s image content. May be `null`. list_content – An object containing the item’s list content. May be ``null`.
Status Codes:	200 OK – The profile item’s information was succesfully updated. 404 Not Found – There is no profile item with the given `id` accessible to the requesting user.