Returns a specified role on a network
bsn.api.main.roles.retrieve
______________________________________________________________
id
int
A unique identifier for a role instance
______________________________________________________________
200: Returns the Role Entity
304: The resource was not modified since the time specified in the “If-Modified-Since” header
300: The requested representation could not be returned because it is ambiguous (there are multiple requested representations)
400: The request is malformed and therefore invalid
401: The access token is invalid or not specified
403: The supplied access token, though valid, doesn't provide access to this method
404: The server cannot find the requested resource (the path does not exist)
406: The server cannot return the data representation that you requested (as specified in the "Accept" header)
5XX: Any 500 code is an internal server error
Updates a role on a network
bsn.api.main.roles.update
______________________________________________________________
id
int
A unique identifier for a role instance
______________________________________________________________
The Role Entity
______________________________________________________________
204: The role was successfully updated.
300: The requested representation could not be returned because it is ambiguous (there are multiple requested representations)
400: Either the request or request body is malformed and therefore invalid
401: The access token is invalid or not specified
403: The supplied access token, though valid, doesn't provide access to this method
404: The server cannot find the requested resource (the path does not exist)
406: The server cannot return the data representation that you requested (as specified in the "Accept" header)
412: Precondition failed (the resource changed since the time specified in the “If-Unmodified-Since” header value)
415: The server cannot accept the data representation that you sent (as specified in the "Content-Type" header)
5XX: Any 500 code is an internal server error
Removes a role on a network
bsn.api.main.roles.delete
______________________________________________________________
id
int
A unique identifier for a role instance
______________________________________________________________
204: The specified role has been removed
300: The requested representation could not be returned because it is ambiguous (there are multiple requested representations)
400: The request is malformed and therefore invalid
401: The access token is invalid or not specified
403: The supplied access token, though valid, doesn't provide access to this method
404: The server cannot find the requested resource (the path does not exist)
406: The server cannot return the data representation that you requested (as specified in the "Accept" header)
412: Precondition failed (the resource changed since the time specified in the “If-Unmodified-Since” header value)
5XX: Any 500 code is an internal server error
Returns a specified role on a network
bsn.api.main.roles.retrieve
______________________________________________________________
name
string
The name of the role instance
______________________________________________________________
200: Returns the Role Entity
304: The resource was not modified since the time specified in the “If-Modified-Since” header
300: The requested representation could not be returned because it is ambiguous (there are multiple requested representations)
400: The request is malformed and therefore invalid
401: The access token is invalid or not specified
403: The supplied access token, though valid, doesn't provide access to this method
404: The server cannot find the requested resource (the path does not exist)
406: The server cannot return the data representation that you requested (as specified in the "Accept" header)
5XX: Any 500 code is an internal server error
Updates a role on a network
bsn.api.main.roles.update
______________________________________________________________
name
string
The name of the role instance
______________________________________________________________
The Role Entity
______________________________________________________________
204: The role was successfully updated.
300: The requested representation could not be returned because it is ambiguous (there are multiple requested representations)
400: Either the request or request body is malformed and therefore invalid
401: The access token is invalid or not specified
403: The supplied access token, though valid, doesn't provide access to this method
404: The server cannot find the requested resource (the path does not exist)
406: The server cannot return the data representation that you requested (as specified in the "Accept" header)
412: Precondition failed (the resource changed since the time specified in the “If-Unmodified-Since” header value)
415: The server cannot accept the data representation that you sent (as specified in the "Content-Type" header)
5XX: Any 500 code is an internal server error
Removes a role from a network
bsn.api.main.roles.delete
______________________________________________________________
name
string
The name of the role instance
______________________________________________________________
204: The specified role has been removed
300: The requested representation could not be returned because it is ambiguous (there are multiple requested representations)
400: The request is malformed and therefore invalid
401: The access token is invalid or not specified
403: The supplied access token, though valid, doesn't provide access to this method
404: The server cannot find the requested resource (the path does not exist)
406: The server cannot return the data representation that you requested (as specified in the "Accept" header)
412: Precondition failed (the resource changed since the time specified in the “If-Unmodified-Since” header value)
5XX: Any 500 code is an internal server error
Returns operational permissions granted to roles for specific business operations
bsn.api.main.operations.retrieve
______________________________________________________________
200: Returns the Business Operations Entity
300: The requested representation could not be returned because it is ambiguous (there are multiple requested representations)
400: The request is malformed and therefore invalid
401: The access token is invalid or not specified
403: The supplied access token, though valid, doesn't provide access to this method
406: The server cannot return the data representation that you requested (as specified in the "Accept" header)
5XX: Any 500 code is an internal server error
Returns object permissions for a given role instance.
bsn.api.main.roles.retrieve
______________________________________________________________
id
int
A unique identifier for a role
______________________________________________________________
200: Returns an array of Permission entities granted to a given role
300: The requested representation could not be returned because it is ambiguous (there are multiple requested representations)
400: The request is malformed and therefore invalid
401: The access token is invalid or not specified
403: The supplied access token, though valid, doesn't provide access to this method
404: The server cannot find the requested resource (the path does not exist)
406: The server cannot return the data representation that you requested (as specified in the "Accept" header)
5XX: Any 500 code is an internal server error
Add permissions for specified roles on a network
bsn.api.main.roles.update
______________________________________________________________
id
int
A unique identifier for a role
______________________________________________________________
An array of Permission entities
______________________________________________________________
204: The permissions were successfully added to the specified role
400: The request or request body is malformed and therefore invalid
401: The access token is invalid or not specified
403: The supplied access token, though valid, doesn't provide access to this method
404: The server cannot find the requested resource (the path does not exist)
415: The server cannot accept the data representation that you sent (as specified in the "Content-Type" header)
5XX: Any 500 code is an internal server error
Removes permissions for specified roles on a network
bsn.api.main.roles.delete
______________________________________________________________
id
int
A unique identifier for a role
______________________________________________________________
An array of Permission entities
______________________________________________________________
204: The specified permissions have been removed from the role
300: The requested representation could not be returned because it is ambiguous (there are multiple requested representations)
400: The request or request body is malformed and therefore invalid
401: The access token is invalid or not specified
403: The supplied access token, though valid, doesn't provide access to this method
404: The server cannot find the requested resource (the path does not exist)
406: The server cannot return the data representation that you requested (as specified in the "Accept" header)
5XX: Any 500 code is an internal server error
Returns object permissions for a given role instance.
bsn.api.main.roles.retrieve
______________________________________________________________
name
string
The name of the role
______________________________________________________________
200: Returns an array of Permission entities granted to a given role
300: The requested representation could not be returned because it is ambiguous (there are multiple requested representations)
400: The request is malformed and therefore invalid
401: The access token is invalid or not specified
403: The supplied access token, though valid, doesn't provide access to this method
404: The server cannot find the requested resource (the path does not exist)
406: The server cannot return the data representation that you requested (as specified in the "Accept" header)
5XX: Any 500 code is an internal server error
Add permissions for specified roles on a network
bsn.api.main.roles.update
______________________________________________________________
name
string
The name of the role
______________________________________________________________
An array of Permission entities
______________________________________________________________
204: The permissions were successfully added to the specified role
400: The request or request body is malformed and therefore invalid
401: The access token is invalid or not specified
403: The supplied access token, though valid, doesn't provide access to this method
404: The server cannot find the requested resource (the path does not exist)
415: The server cannot accept the data representation that you sent (as specified in the "Content-Type" header)
5XX: Any 500 code is an internal server error
Removes permissions for specified role on a network
bsn.api.main.roles.delete
______________________________________________________________
name
string
The name of the role
______________________________________________________________
An array of Permission entities
______________________________________________________________
204: The specified permissions have been removed from the role
300: The requested representation could not be returned because it is ambiguous (there are multiple requested representations)
400: The request or request body is malformed and therefore invalid
401: The access token is invalid or not specified
403: The supplied access token, though valid, doesn't provide access to this method
404: The server cannot find the requested resource (the path does not exist)
406: The server cannot return the data representation that you requested (as specified in the "Accept" header)
5XX: Any 500 code is an internal server error