Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 22 Next »

ON THIS PAGE

These endpoints allow users to manage their settings in the current network.

/self/

GET

Gets the information associated with the user in the current network.

Parameters

  • Person

Response Body

  • [string] id: the network id
  • [string] login: the user login

  • [string] password: the user password

  • [string] firstName: the user's first name

  • [string] lastName: the user's last name

  • [string] creationDate: the creation date of the network

  • [string] lastModifiedDate: the date that the network was last modified

  • [string] activationDate: the date that the network was last activated

POST

Registers the user in the current BSN.cloud network. The server will return your person credentials, including an auto-generated password, which Postman will store.

Parameters

  • [returnURL]

Request Body

  • Person

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

This call creates a BSN.cloud network: The server will create a network with your credentials as the network owner.

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

  • Permission[]



  • No labels