Rest - Work - Agency Projects - Session Groups

From Views API Documentation
Jump to navigation Jump to search

Purpose

Used for administering the association of session groups with agency projects in the Views system.

Base URL

https://app.viewsapp.net/api/restful/work/agencyprojects/id/sessiongroups

  • id - This is the id of the agency project

Note: If the Agency Project has been archived, this API becomes read only.

Getting the list of session groups

curl --url <Base URL> -u<username>:<password> -H Content-Type:text/xml

This will return a list of session groups that are associated with the agency project.

Adding session groups to an Agency Project

You can add a single session group via the following: 

curl --url <Base URL>/<sid> -u<username>:<password> -H Content-Type:text/xml -X PUT
  • sid - The ID of the session group to add

You can also upload a a list of session groups to add to the agency project via the following URL 

curl --url <Base URL> -u<username>:<password> -H Content-Type:text/xml -X PUT

<sessiongroups>
    <sessiongroup>1</sessiongroup>
    <sessiongroup>2</sessiongroup>
    <sessiongroup>3</sessiongroup>
</sessiongroups>

Used for administering participant registrations on session groups in the Views system.

Removing a session group from an Agency Project

You can remove a single session group from an agency project via the following: 

curl --url <Base URL>/<sid> -u<username>:<password> -H Content-Type:text/xml -X DELETE
  • sid - The ID of the session group to add

You can also upload a a list of session groups to remove from the agency project via the following URL 

curl --url <Base URL> -u<username>:<password> -H Content-Type:text/xml -X DELETE

<sessiongroups>
    <sessiongroup>1</sessiongroup>
    <sessiongroup>2</sessiongroup>
    <sessiongroup>3</sessiongroup>
</sessiongroups>
Retrieved from ‘https://www.substance.net/views-api-docs/index.php?title=Rest_-_Work_-_Agency_Projects_-_Session_Groups&oldid=274’