Self Endpoints (2017/01)

these endpoints allow users to manage their settings in the current network base url for these endpoints https //api brightsignnetwork com/2017/01/rest/self get / returns the information associated with the person (the requestor) response body returns the person entity (2017/01) docid 6vgk0 je3ozujtoa6ukpt put / updates a person's information request body the person entity (2017/01) docid 6vgk0 je3ozujtoa6ukpt response body on success this method returns a status code 2xx, on failure it returns a status code of 5xx get /networks/ returns the networks associated with a person response body returns a complete list of network entity (2017/01) docid\ fjr 4zfseox o boabxvy instances associated with a person post /networks/ creates a network for the person request body the network entity (2017/01) docid\ fjr 4zfseox o boabxvy response body returns a 201 status code and the new resource created and referenced by the uri (given by the location header field) in the response the response includes the network entity (see network entity (2017/01) docid\ fjr 4zfseox o boabxvy ) get /networks/{id\ int}/ returns a list of networks associated with a specified id parameter id int the unique identifier for a network response body returns the network entity (2017/01) docid\ fjr 4zfseox o boabxvy get /networks/{name}/ returns a list of networks associated with a specified name parameter name string the name of a network response body returns the network entity (2017/01) docid\ fjr 4zfseox o boabxvy get /networks/{id\ int}/settings/ returns the settings associated with a specified network parameter id int the unique identifier for a network response body returns the network settings entity (2017/01) docid\ s2 brxukxi4xqtu33dwil put /networks/{id\ int}/settings/ update the settings associated with a specified network parameter id int the network identifier request body the network settings entity (2017/01) docid\ s2 brxukxi4xqtu33dwil response body on success this method returns a status code 2xx, on failure it returns a status code of 5xx get /networks/{name}/settings/ get the settings associated with a specified network parameter name string the network name response body returns the network settings entity (2017/01) docid\ s2 brxukxi4xqtu33dwil put /networks/{name}/settings/ update the settings associated with a specified network parameter id string the network name request body the network settings entity (2017/01) docid\ s2 brxukxi4xqtu33dwil response body on success this method returns a status code 2xx, on failure it returns a status code of 5xx get /users/ returns all user entities that the customer is associated with over all networks where the person has a user record response body returns an array of user entities (see user entity (2017/01) docid\ t8i22gqufe stmwntiebe ) if the user is a member of multiple networks, or to a single user entity (2017/01) docid\ t8i22gqufe stmwntiebe if the user is only a member of one network, or nothing if the user is not a member of any network get /users/{userid\ int}/ returns information about a specified user on a network parameter id int the unique identifier for a user response body returns the user entity (2017/01) docid\ t8i22gqufe stmwntiebe get /users/{userid\ int}/profile/ returns the user profile settings parameter id int the unique identifier for a user response body the return type is object, where property names are profile keys and the profile values are those property values post /users/{userid\ int}/profile/ creates the user profile property parameter id int the unique identifier for a user request body pair \<string, string> a key value pair there should be not more than 100 properties per user, and each property value should be not more than 64kb response body returns a 201 status code, the key value pair, and a link to the get method to retrieve it get /users/{userid\ int}/profile/{key}/ returns the value of a user profile key parameters id int the unique identifier for the user key string the name of the profile property response body returns the value of the requested user profile key put /users/{userid\ int}/profile/{key}/ sets a property value in a user profile parameters id int the unique identifier for the user key string the name of the profile property request body value string the profile property value to update response body returns http status code 201 if the property value is defined for first time, or status code 204 if the property already exists and has been updated delete /users/{userid\ int}/profile/{key}/ removes a user profile property parameters id int the unique identifier for the user key string the name of the profile property response body on success this method returns a status code 2xx, on failure it returns a status code of 5xx get /users/{userid\ int}/notifications/ returns the user notification settings parameter id int the unique identifier for the user response body returns the user notification settings entity (2017/01) docid 1ylewggkuua4k2zrgmequ put /users/{userid\ int}/notifications/ updates the user notification settings parameter id int the unique identifier for the user request body the user notification settings entity (2017/01) docid 1ylewggkuua4k2zrgmequ response body on success this method returns a status code 2xx, on failure it returns a status code of 5xx get /users/{userid\ int}/permissions/ returns permissions for a given user parameter id int the unique identifier for the user response body returns an array of permission entity (2017/01) docid\ horbsqti93 eafzzftgmy entities