Versions Compared
Key
- This line was added.
- This line was removed.
- Formatting was changed.
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 /
GET
Returns the information associated with the person (the requestor).
Response Body
Returns thePerson Entity
PUTPUT /
Updates a person's information.
Request Body
The Person Entity
______________________________________________________________
Response Body
On success this method returns a status code 2XX, on failure it returns a status code of 5XX.
GET /Networks/
GETReturns the networks associated with a person
Response Body
Returns aReturns a complete list ofNetwork Entity instances associated with a person.
POST /Networks/
POSTCreates a network for the person.
Request Body
______________________________________________________________
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).
Endpoints:
| Table of Contents | ||||||
|---|---|---|---|---|---|---|
|
GET /Networks/{id:int}/
Returns a list of networks associated with a specified id.
Parameter
[int] id: id int
The unique identifier for a network
______________________________________________________________
Response Body
Returns
the Network Entity
GET /Networks/{name}/
Returns a list of networks associated with a specified name.
Parameter
[string] name: name string
The name of a network
______________________________________________________________
Response Body
Returns
the Network Entity
GET /Networks/{id:int}/Settings/
Returns the settings associated with a specified network.
Parameter
[int] id: The network identifierid int
The unique identifier for a network
______________________________________________________________
Response Body
Returns
PUT /Networks/{id:int}/Settings/
Update the settings associated with a specified network
Parameter
[int] id: id int
The network identifier
______________________________________________________________
Request Body
______________________________________________________________
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
[string] name: name string
The network name
______________________________________________________________
Response Body
Returns
PUT /Networks/{name}/Settings/
Update the settings associated with a specified network
Parameter
[string] id: The network nameid string
The network name
______________________________________________________________
Request Body
______________________________________________________________
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) if the user is a member of multiple networks, or to a
single User Entity 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}/
[int] id: The Returns information about a specified user on a network
Parameter
Parameters
id int
The unique identifier for a user
______________________________________________________________
Response Body
Returns the User Entity
GET /Users/{userid:int}/Profile/
Returns the user profile settings
Parameter
[int] id: 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
[int] id: 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
[int] id: id int
The unique identifier for the user
[string] key: The name 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
[int] id: id int
The unique identifier for the user
[string] key: The name key string
The name of the profile property
______________________________________________________________
Request Body
[string] value: The 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
[int] id: id int
The unique identifier for the user
[string] key: The name 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
[int] id: id int
The unique identifier for the user
______________________________________________________________
Response Body
Returns
the User Notification Settings Entity
PUT /Users/{userid:int}/Notifications/
Updates the user notification settings
Parameter
[int] id: id int
The unique identifier for the user
______________________________________________________________
Request Body
The User Notification Settings Entity
______________________________________________________________
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
[int] id: A id int
The unique identifier for
the user
______________________________________________________________
Response Body
Returns an array
of Permission Entity entities
Endpoints:
| Table of Contents | ||||||
|---|---|---|---|---|---|---|
|