...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
borderColor | #3D3D3D |
---|---|
bgColor | #F4F4F4 |
titleColor | #3D3D3D |
borderWidth | 0 |
titleBGColor | #3D3D3D |
borderStyle | solid |
...
ON THIS PAGE
Table of Contents | ||||
---|---|---|---|---|
|
These endpoints allow users to manage their settings in the current network.
/self/
GET
Gets Base URL for these endpoints: https://api.brightsignnetwork.com/2017/01/REST/Self
GET /
Returns the information associated with the user in the current networkperson (the requestor).
Response Body
id:
login: The user's login name
password: The user password. This may return "null".
firstName: The user's first name
lastName: The user's last name
creationDate:
lastModifiedDate:
activationDate:
POST
Registers the user in the current network.
Parameters
...
Returns the Person Entity
PUT /
Updates a person's information.
Request Body
The Person Entity
Response Body
Person
PUT
Updates the users information in the current network.
Request Body
Person
/self/profile
GET
Gets the users profile settings.
Response Body
Dictionary<string, string>
POST
Updates the users profile settings.
Request Body
KeyValuePair<string, string>
Response Body
KeyValuePair<string, string>
/self/profile/{key}
GET
Gets the users profile settings.
Response Body
String
PUT
Updates the users profile settings.
Request Body
String
Response Body
[KeyValuePair<string, string>]
DELETE
Deletes the users profile settings.
/self/networks/
GET
Retrieves all networks associated with the user.
Response Body
Network[]:
The network description includes the following information:- id: the network id
- name: the network owner
- creationDate: date the network was created
- lockoutDate:
- isLockedOut: true/false
- lastLockoutDate:
- settings: device and user token information, and whether automatic subscription management and tagged playlists are enabled/disabled
- subscription: the id, level (whether the network has a Content, Control, or Management Cloud), and creation/last modified/expiration dates
POST
Create a network that will be associated with the user.
Parameters
key
:
Request Body
Network
Response Body
Network
/self/networks/{networkId}/
/self/networks/{networkName}/
GET
Retrieve the network name.
Request Body
Network
/self/networks/{networkId}/settings/
GET
Retrieve the network settings.
Response Body
Network Settings
/self/networks/{networkName}/settings/
PUT
Request Body
Network Settings
/self/networks/{networkId}/subscription/
/self/networks/{networkName}/subscription/
GET
Gets the network subscription information for the user.
Response Body
Network Subscription
/self/users/
GET
Gets the names of the user(s) on the current network
Response Body
User[]
/self/users/{userId}/
GET
Gets the id(s) of the users on the current network
Response Body
User
/self/users/{userId}/role
GET
Gets the role(s) of the users on the current network
Response Body
Role
/self/users/{userId}/role/permissions
GET
Gets the role permissions of the users on the current network
Response Body
Permission[]
Dictionary<string, string>
/self/users/{userId}/profile/
POST
Request Body
[KeyValuePair<string, string>]
Response Body
[KeyValuePair<string, string>]
/self/users/{userId}/profile/{key}
GET
Retrieve the user profile.
Response Body
String
PUT
Update the user profile.
Request Body
String
Response Body
[KeyValuePair<string, string>]
DELETE
Delete the user profile.
/self/users/{userId}/notifications/
GET
Get user notification settings.
Response Body
UserNotificationSettings
PUT
Update user notification settings.
Request Body
UserNotificationSettings
/self/users/{userId}/permissions/
GET
Get user permissions.
Response Body
...
______________________________________________________________
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 instances associated with a person.
POST /Networks/
Creates a network for the person.
Request Body
The Network Entity
______________________________________________________________
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).
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
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
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
PUT /Networks/{id:int}/Settings/
Update the settings associated with a specified network
Parameter
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
name
string
The network name
______________________________________________________________
Response Body
Returns the Network Settings Entity
PUT /Networks/{name}/Settings/
Update the settings associated with a specified network
Parameter
id
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}/
Returns information about a specified user on a network
Parameter
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
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
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
______________________________________________________________
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 entities