Groups/Regular Endpoints (2017/01)

use this endpoint to manage groups and presentation schedules on the network base url for these endpoints https //api brightsignnetwork com/2017/01/rest/groups/regular get / retrieves a list of groups on the network parameters filter string an filter expressions in the main api (2017/01) docid\ l8mfvfdghpy9xgiuquwcm for filtering search results sort string an expression for sorting the search results the sort expression specifies the entry used for sorting and the ascending/descending (asc/desc) sorting order (e g " \[group] \[autorun] \[version] desc ") marker string a value specifying which page to retrieve this value is useful if the istruncated entry in the response body of the previous get call indicates that the number of group instances exceeds the pagesize pagesize int the maximum number of group instances that can be contained in the response body response body returns a paged list entity (2017/01) docid\ yn3gu asyfisjdxgbjdvb of group entity (2017/01) docid\ t6ak5l6qc 1kpsjzb1lmj instances on a network this will return not more than 100 entities along with the information necessary to return any other remaining pages post / creates a group on the network request body the group entity (2017/01) docid\ t6ak5l6qc 1kpsjzb1lmj 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 group entity (2017/01) docid\ t6ak5l6qc 1kpsjzb1lmj delete / removes groups, specified by a filter, from a network this allows multiple groups to be deleted at once parameters filter string an filter expressions in the main api (2017/01) docid\ l8mfvfdghpy9xgiuquwcm for filtering search results reassignmentgroupid int the identifier of the group instance to which affected devices should be reassigned if this value is negative, the devices will be reassigned to the default “unassigned” group instance if a group instance with the specified positive \[int] id does not exist, the method will return a descriptive error response body returns the number of affected groups as an integer value get /count/ retrieves the number of groups on the network that match the specified filter criteria if no filter is included, this call returns the total number of groups on the network parameters filter string an filter expressions in the main api (2017/01) docid\ l8mfvfdghpy9xgiuquwcm for filtering search results response body the number of groups is returned as an integer value get /{id\ int}/ returns a group, specified by id, on the network parameters id int the unique identifier for the group response body returns the scheduled presentation entity (2017/01) docid 4whgqcyb8gjhu6sqdrfbt put /{id\ int}/ updates the specified group on a network parameters id int the unique identifier for the group request body the group entity (2017/01) docid\ t6ak5l6qc 1kpsjzb1lmj response body on success this method returns a status code 2xx, on failure it returns a status code of 5xx delete /{id\ int}/ removes the specified groups from the network parameters id int the unique identifier for the group reassignmentgroupid int the identifier of the group instance to which affected devices should be reassigned if this value is negative, the devices will be reassigned to the default “unassigned” group instance if a group instance with the specified positive \[int] id does not exist, the method will return a descriptive error response body on success this method returns a status code 2xx, on failure it returns a status code of 5xx get /{name}/ returns a group, specified by name, on the network parameters name string the name of the group response body returns the scheduled presentation entity (2017/01) docid 4whgqcyb8gjhu6sqdrfbt put /{name}/ updates a group, specified by name, on the network parameters name string the name of the group request body the group entity (2017/01) docid\ t6ak5l6qc 1kpsjzb1lmj response body on success this method returns a status code 2xx, on failure it returns a status code of 5xx delete /{name}/ removes a group, specified by name, from the network parameters name string the name of the group reassignmentgroupid int the identifier of the group instance to which affected devices should be reassigned if this value is negative, the devices will be reassigned to the default “unassigned” group instance if a group instance with the specified positive \[int] id does not exist, the method will return a descriptive error response body on success this method returns a status code 2xx, on failure it returns a status code of 5xx get /{groupid\ int}/schedule/ returns a list of the scheduled presentations of the specified group parameters groupid int the unique identifier of the group marker string a value specifying which page to retrieve this value is useful if the istruncated entry in the response body of the previous get call indicates that the number of group instances exceeds the pagesize pagesize int the maximum number of group instances that can be contained in the response body response body returns a list of the scheduled presentations of the specified group post /{groupid\ int}/schedule/ adds a scheduled presentation to the specified group parameters groupid int the unique identifier of the group request body the scheduled presentation entity (2017/01) docid 4whgqcyb8gjhu6sqdrfbt 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 scheduled presentation entity (2017/01) docid 4whgqcyb8gjhu6sqdrfbt get /{groupname}/schedule/ returns a list of the scheduled presentations of the specified group parameters groupname string the name of the group marker string a value specifying which page to retrieve this value is useful if the istruncated entry in the response body of the previous get call indicates that the number of group instances exceeds the pagesize pagesize int the maximum number of group instances that can be contained in the response body response body returns a list of the scheduled presentations of the specified group post /{groupname}/schedule/ adds a scheduled presentation to the specified group parameters groupname string the name of the group request body the scheduled presentation entity (2017/01) docid 4whgqcyb8gjhu6sqdrfbt 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 scheduled presentation entity (2017/01) docid 4whgqcyb8gjhu6sqdrfbt get /{groupid\ int}/schedule/{scheduledpresentationid\ int}/ returns the schedule of the specified presentation in the specified group parameters groupid int the unique identifier of the group scheduledpresentationid int the unique identifier for the scheduled presentation response body returns the scheduled presentation entity (2017/01) docid 4whgqcyb8gjhu6sqdrfbt put /{groupid\ int}/schedule/{scheduledpresentationid\ int}/ updates the specified scheduled presentation in the specified group parameters groupid int the unique identifier of the group scheduledpresentationid int the unique identifier for the scheduled presentation request body the scheduled presentation entity (2017/01) docid 4whgqcyb8gjhu6sqdrfbt response body on success this method returns a status code 2xx, on failure it returns a status code of 5xx delete /{groupid\ int}/schedule/{scheduledpresentationid\ int}/ removes a specified scheduled presentation from the specified group parameters groupid int the unique identifier of the group scheduledpresentationid int the unique identifier for the scheduled presentation response body on success this method returns a status code 2xx, on failure it returns a status code of 5xx get /{groupname}/schedule/{scheduledpresentationid\ int}/ returns the schedule of the specified presentation in the specified group parameters groupname int the name of the group scheduledpresentationid int the unique identifier for the scheduled presentation response body returns the scheduled presentation entity (2017/01) docid 4whgqcyb8gjhu6sqdrfbt put /{groupname}/schedule/{scheduledpresentationid\ int}/ updates the specified scheduled presentation in the specified group parameters groupname int the name of the group scheduledpresentationid int the unique identifier for the scheduled presentation request body the scheduled presentation entity (2017/01) docid 4whgqcyb8gjhu6sqdrfbt response body on success this method returns a status code 2xx, on failure it returns a status code of 5xx delete /{groupname}/schedule/{scheduledpresentationid\ int}/ removes the specified scheduled presentation from the specified group parameters groupname int the name of the group scheduledpresentationid int the unique identifier for the scheduled presentation response body on success this method returns a status code 2xx, on failure it returns a status code of 5xx get /operations/ returns operational permissions granted to roles for specific business operations response body returns the business operations entity (2017/01) docid\ fwdujpp aohpf3res sz get /{id\ int}/permissions/ includes object permissions for a given group instance parameters id int the unique identifier for the group response body returns the permission entity (2017/01) docid\ horbsqti93 eafzzftgmy post /{id\ int}/permissions/ adds permissions to the specified group parameters id int the unique identifier for the group request body the permission entity (2017/01) docid\ horbsqti93 eafzzftgmy response body on success this method returns a status code 2xx, on failure it returns a status code of 5xx delete /{id\ int}/permissions/ removes permissions from a specified group parameters id int the unique identifier for the group request body the permission entity (2017/01) docid\ horbsqti93 eafzzftgmy response body on success this method returns a status code 2xx, on failure it returns a status code of 5xx get /{name}/permissions/ includes object permissions for a given group instance parameters name string the name of the group response body returns the permission entity (2017/01) docid\ horbsqti93 eafzzftgmy post /{name}/permissions/ adds permissions to the specified group parameters name string the name of the group request body the permission entity (2017/01) docid\ horbsqti93 eafzzftgmy response body on success this method returns a status code 2xx, on failure it returns a status code of 5xx delete /{name}/permissions/ removes permissions from the specified group parameters name string the name of the group request body the permission entity (2017/01) docid\ horbsqti93 eafzzftgmy response body on success this method returns a status code 2xx, on failure it returns a status code of 5xx