Staff Notebook Teams

To add a new or existing OneNote notebook to a channel in Microsoft Teams, select Add a tab at the top of the channel and select OneNote. From there, choose an option: To start from scratch, select Create a new notebook, add a name to the Notebook name field, and click Save. To add an existing notebook, select Browse notebooks, choose the notebook and section, and select Save. The course aim to lead and model proper use of OneNote to promotes teamwork and collaboration work. Within the course, the participants learnt on how to add custom sections and content to meet digital documentation and data for the school and allowing feedback amongst teachers and staff professionally to achieve school’s objectives.

Types of Teams are determined by the purpose of the Team. I have taught Teams and I’ve created a course on Teams but I’ve never done much with Microsoft Teams, the hero of remote learning, remote teaching and remote work, here on this site. I’m currently working on a project in Teams outside of the world of education, so I am aware there are some differences between the business and education editions of Teams. However, this site is dedicated to educational technology, so on this long-delayed Day 112 of 365 Ideas for Microsoft 365, we will look at the four types of Teams available in education tenants.

Team meetings are one of the best things in Teams and you can make them even better with these two features. Click on the three ellipse in the floating bar menu and select Start recording to record your team meeting. Click on the Share Screen icon in the floating bar menu to share your screen with meeting participants. This will allow you to. The staff team is where things start to get interesting, but again, it’s a OneNote difference. The staff team gets a staff Notebook, which is in many respects similar to a OneNote Class Notebook. Screenshot of the tabs in an Other type Team Like a class notebook, when you click to open it you have to set it up first.

Creating a New Team

When you open Teams, if you open anywhere else, you’ll want to click on the Teams icon on the far-left column, which we call the “me space”, as opposed to the “we space” that takes up most of the screen in Teams. The me space is where you find your Teams, your assignments, your files, and so on.

When you click on the Teams icon you will see all of the Teams you are either the owner or a member of. In the top right corner of the screen you will see the “Join or create team” button. Click it.

You will now see the “Create a team” box, the “Join a team with a code” box, and possibly some other teams that you can request to join. We are of course going to click on “Create a team”.

We have finally reached the actual topic of this article- the four types of educational Teams- Class, PLC, Staff and Other.

There is of course a brief description under each to help you decide which is right for your current project. One of the differences between types of teams is the OneNote notebook that comes with each team.

Other Team Types

Let’s start generic. The “Other” team type gives you a General channel which comes with Posts and Files tabs, and no built-in OneNote notebook.

You can add a OneNote notebook as a tab. If you do, you can choose to add an existing notebook or create a new one for the Team.

You can add channels, including private channels, add tabs, host live meetings, use all the advanced chat features, share and collaborate on files.

PLC Teams

The PLC Team type has all that, plus it automatically creates a PLC Notebook and places it on a tab for easy access.

This is a regular OneNote Notebook, but set up for use in a PLC. Everything is customizable, of course, but it is set up with sections and directions for you and your peers based on common PLC use cases.

Both the “Other” team and the “PLC” teams have the same settings options for managing the Team.

Really, the biggest difference is the OneNote addition.

Staff Teams

The staff team is where things start to get interesting, but again, it’s a OneNote difference.

The staff team gets a staff Notebook, which is in many respects similar to a OneNote Class Notebook.

Like a class notebook, when you click to open it you have to set it up first. You can start from scratch or using an existing notebook as a template.

This honestly is exactly like a class notebook with the names changed.

It is essentially 4 notebooks in one. You’ll get a collaboration space that everyone has read/edit rights in. You’ll get a Content Library that is read-only for members, and only the “leader” can edit. There is also a “leaser-Only” section that members can’t even see. This is a staging area for the leader to organize content ahead of time that they can share out piece by piece when it is appropriate. They will be able to send pages or sections into the content library, the collaboration space, or distribute a copy to each member’s private notebook. The private notebook is the fourth section. Each member of the staff team gets a private notebook that only they and the leader can see or edit. The team leader sees everyone’s private notebooks, but other members can’t. When you set up the Class Notebook you decide what sections are in everyone’s private notebook.

Class Teams

The Class team has the most unique features. It has a OneNote Class Notebook. It feels weird to compare the Class Notebook to the Staff Notebook, because normally I do it the other way around, since Class Notebook existed first, even before Teams existed. Whereas the staff notebook, if used inside a school, would have the Principal and possibly other administrators as the “Leader(s)”, and teachers and staff as the members, the Class Notebook of course has the teacher(s) as the leaders and the students as the members. The teacher (and possibly co-teachers)

Can use the teacher-only section to organize the entire curriculum to distribute content, warm-ups, classwork, exit tickets, formative assessments and homework as needed. They can use the Content Library for read only documents like the syllabus, announcements, directions and lab safety protocols. The class can collaborate in the Collaboration Space. Each student has their private Student Notebook that only they and the teacher can see and edit. Once again, the teacher sets up the sections for the notebook.

But there are other differences with a Class team beyond the OneNote notebook. Notice there are additional tabs not seen in the other Team types. Not only are they automatically added in a Class Team, they aren’t even available in the other Team types. Only a Class Team has Assignments. As a result, only a Class Team will have Grades. Once you have some grades added, you can also add the Insights tab, which, as the name indicates, provides insights into the class’, and individuals’ work habits.

Class Teams can sync with many students data systems, so it may be possible to auto-create Teams from the class rosters in your SIS. That data flow works both directions as well, so when you grade in Teams, those grades can sync to many gradebook programs as well.

I will delve more into details of assignments and other features in upcoming articles.

Looking for more? How about the

Remote Learning with Microsoft Teams Course

Sign up to learn how to go from a complete novice in Teams to using Teams for your complete solution for remote learning.

If you like this style of directions and screenshots, walking you through ideas for using Microsoft tools in your classroom, check out my book,

All the Microsoft Tools You Need to Transform Your Classroom: 50 Ideas for using Microsoft Office 365 for Education available on amazon in both Kindle and paperback.

-->

Applies to: Enterprise notebooks on Office 365

Schools, colleges, and universities worldwide use staff notebooks to help promote productivity, engagement, and collaboration.

You can use the staffNotebooks endpoint to perform common tasks for staff notebooks, such as creating staff notebooks and adding or removing leaders or members.

Note

The OneNote API provides the staffNotebooks endpoint for operations that are specific to staff notebooks.

Construct the request URI

  1. To construct the request URI, start with the service root URL for your platform:

    Notebooks on OneDrive for Business

    https://www.onenote.com/api/v1.0/me/notes/

    https://www.onenote.com/api/v1.0/users/{id}/notes/

    SharePoint site notebooks

    https://www.onenote.com/api/v1.0/myOrganization/siteCollections/{id}/sites/{id}/notes/

    Unified group notebooks

    https://www.onenote.com/api/v1.0/myOrganization/groups/{id}/notes/

  2. Append the staffNotebooks endpoint, followed a resource path, as needed:

    ./staffNotebooks[?omkt,sendemail]

    ./staffNotebooks/{notebook-id}

    ./staffNotebooks

    ./staffNotebooks/{notebook-id}

    ./staffNotebooks/{notebook-id}

    ./staffNotebooks/{notebook-id}/members

    ./staffNotebooks/{notebook-id}/leaders

    ./staffNotebooks/{notebook-id}/members/{member-id}

    ./staffNotebooks/{notebook-id}/leaders/{leader-id}

    ./staffNotebooks/{notebook-id}/copySectionsToContentLibrary

Your full request URI will look something like these examples:

https://www.onenote.com/api/v1.0/me/notes/staffNotebooks/{id}/leaders/{id}

https://www.onenote.com/api/v1.0/users/{id}/notes/staffNotebooks/{id}/members

https://www.onenote.com/api/v1.0/myOrganization/siteCollections/{id}/sites/{id}/notes/staffNotebooks

https://www.onenote.com/api/v1.0/myOrganization/groups/{id}/notes/staffNotebooks/{id}

https://www.onenote.com/api/v1.0/me/notes/staffNotebooks/{id}/copySectionsToContentLibrary

Create staff notebooks

To create a staff notebook, send a POST request to the staffNotebooks endpoint.

POST ./staffNotebooks[?omkt,sendemail]

In the message body, send a JSON object with the staff notebook creation parameters.

ParameterDescription
nameThe name of the notebook.
memberSectionsAn array containing one or more section names. These sections are created in each member's section group.
leadersAn array containing one or more principal objects.
membersAn array containing one or more principal objects. A section group is created for each member.
hasLeaderOnlySectionGrouptrue to create a Leader Only section group that's visible to leaders only.
omktURL query parameter that specifies the language for the notebook. Default is en-us. Example: ?omkt=es-es
sendemailURL query parameter that specifies whether to send an email notification when the notebook is created to the leaders and members assigned to the notebook. Default is false.

Using Notebook In Teams


Leaders and members are represented by principal objects, which contain the following properties:
ParameterDescription
idThe Office 365 user principal name.
See the Azure AD Graph API documentation to learn more about users and groups.
principalTypePerson or Group

Supported languages

You can use the omkt={language-code} URL query parameter to create a staff notebook in a specific language. For example:

POST ./staffNotebooks?omkt=de-de

Teams

The following language codes are supported. The default is en-us.

CodeLanguage
bg-bgБългарски (България)
cs-czČeština (Česká republika)
da-dkDansk (Danmark)
de-deDeutsch (Deutschland)
el-grΕλληνικά (Ελλάδα)
en-usEnglish (United States)
es-esEspañol (España)
et-eeEesti (Eesti)
fi-fiSuomi (Suomi)
fr-frFrançais (France)
hi-inहिंदी (भारत)
hr-hrHrvatski (Hrvatska)
hu-huMagyar (Magyarország)
id-idBahasa Indonesia (Indonesia)
it-itItaliano (Italia)
ja-jp日本語 (日本)
kk-kzҚазақ (Қазақстан)
ko-kr한국어 (대한민국)
lt-ltLietuvių (Lietuva)
lv-lvLatviešu (Latvija)
ms-myBahasa Melayu (Asia Tenggara)
nb-noNorsk (Norge)
nl-nlNederlands (Nederland)
pl-plPolski (Polska)
pt-brPortuguês (Brasil)
pt-ptPortuguês (Portugal)
ro-roRomână (România)
ru-ruРусский (Россия)
sk-skSlovenčina (Slovenská republika)
sl-siSlovenski (Slovenija)
sr-Latn-RSSrpski (Rep. Srbija i Rep. Crna Gora)
sv-seSvenska (Sverige)
th-thไทย (ไทย)
tr-trTürkçe (Türkiye)
uk-uaУкраїнська (Україна)
vi-vnTiếng Việt (Việt Nam)
zh-cn简体中文 (中国)
zh-tw繁體中文 (台灣)

Example

The following request creates a staff notebook named Staff Meetings.

This creates a staff notebook with four member section groups, each containing a Handouts, Staff Notes, and Meeting Summaries section. The section group created for each member is only accessible by the member and the leader. It also creates a Leader Only section group that's only visible to the leader. The sendemail=true query parameter specifies to send an email notification to the leader and members when the notebook is created.

Request and response information

The following information applies to POST /staffNotebooks requests.

Request dataDescription
ProtocolAll requests use the SSL/TLS HTTPS protocol.
Authorization header

Bearer {token}, where {token} is a valid OAuth 2.0 access token for your registered app.

If missing or invalid, the request fails with a 401 status code. See Authenticate using Azure AD (enterprise apps).

Content-Type headerapplication/json
Accept headerapplication/json
Permission scopeNotes.ReadWrite.CreatedByApp, Notes.ReadWrite, or Notes.ReadWrite.All

Response dataDescription
Success codeA 201 HTTP status code.
Response bodyAn OData representation of the new notebook in JSON format.
In addition to regular notebook properties, staff notebooks also have the following properties:
  • memberSections. The member sections in the notebooks.
  • leaders. The leaders that can access the notebook.
  • member. The members that can access the notebook.
  • hasLeaderOnlySectionGroup. true if the notebook contains a Leader Only section group, otherwise false.
ErrorsIf the request fails, the API returns errors in the @api.diagnostics object in the response body.
X-CorrelationId headerA GUID that uniquely identifies the request. You can use this value along with the value of the Date header when working with Microsoft support to troubleshoot issues.

Update staff notebooks

To update a staff notebook, send a PATCH request to the staffNotebooks/{notebook-id} endpoint.

Note

Currently, only the hasLeaderOnlySectionGroup property can be updated in a PATCH request.

PATCH ./staffNotebooks/{notebook-id}

In the message body, send a JSON object with the update parameter.

ParameterDescription
hasLeaderOnlySectionGrouptrue to add a Leader Only section group that's visible to leaders only. false is not supported.

See these methods for other ways to change staff notebooks: Add members or leaders, Remove members or leaders, Insert sections.

Example

The following request adds a Leader Only section group to the specified staff notebook.

The new Leader Only section group is visible to leaders only.

Request and response information

The following information applies to PATCH ./staffNotebooks/{notebook-id} requests.

Request dataDescription
ProtocolAll requests use the SSL/TLS HTTPS protocol.
Authorization header

Bearer {token}, where {token} is a valid OAuth 2.0 access token for your registered app.

If missing or invalid, the request fails with a 401 status code. See Authenticate using Azure AD (enterprise apps).

Content-Type headerapplication/json
Accept headerapplication/json
Permission scopeNotes.ReadWrite.CreatedByApp, Notes.ReadWrite, or Notes.ReadWrite.All

Response dataDescription
Success codeA 204 HTTP status code.
ErrorsIf the request fails, the API returns errors in the response body.
X-CorrelationId headerA GUID that uniquely identifies the request. You can use this value along with the value of the Date header when working with Microsoft support to troubleshoot issues.

Get staff notebooks

To get one or more staff notebooks, send a GET request to the staffNotebooks endpoint.

Get one or more staff notebooks

Staff Notebook In Teams

GET ./staffNotebooks[?filter,orderby,select,top,skip,expand,count]

Get a specific staff notebook

GET ./staffNotebooks/{notebook-id}[?select,expand]

Notebooks can expand the leaders and members properties. The default sort order is name asc.

Staff notebooks are also returned for GET /notebooks requests, but the results won't include any staff notebook-specific properties.

Example

The following request gets staff notebooks that were created since January 1, 2016.

To learn more about getting notebooks, including supported query string options and examples, see Get OneNote content and structure.

Request and response information

The following information applies to GET /staffNotebooks requests.

Request dataDescription
ProtocolAll requests use the SSL/TLS HTTPS protocol.
Authorization header

Bearer {token}, where {token} is a valid OAuth 2.0 access token for your registered app.

If missing or invalid, the request fails with a 401 status code. See Authenticate using Azure AD (enterprise apps).

Accept headerapplication/json
Permission scopeNotes.Read, Notes.ReadWrite.CreatedByApp, Notes.ReadWrite, or Notes.ReadWrite.All

Response dataDescription
Success codeA 200 HTTP status code.
Response bodyAn OData representation of the staff notebooks in JSON format.
In addition to regular notebook properties, staff notebooks also have the following properties:
  • memberSections. The member sections in the notebooks.
  • leaders. The leaders that can access the notebook.
  • member. The members that can access the notebook.
  • hasLeaderOnlySectionGroup. true if the notebook contains a Leader Only section group, otherwise false.
ErrorsIf the request fails, the API returns errors in the @api.diagnostics object in the response body.
X-CorrelationId headerA GUID that uniquely identifies the request. You can use this value along with the value of the Date header when working with Microsoft support to troubleshoot issues.

Delete staff notebooks

To delete a staff notebook, send a DELETE request to the staffNotebooks/{notebook-id} endpoint.

DELETE ./staffNotebooks/{notebook-id}

Example

The following request deletes the specified staff notebook.

Request and response information

The following information applies to DELETE ./staffNotebooks/{notebook-id} requests.

Request dataDescription
ProtocolAll requests use the SSL/TLS HTTPS protocol.
Authorization header

Bearer {token}, where {token} is a valid OAuth 2.0 access token for your registered app.

If missing or invalid, the request fails with a 401 status code. See Authenticate using Azure AD (enterprise apps).

Accept headerapplication/json
Permission scopeNotes.ReadWrite.CreatedByApp, Notes.ReadWrite, or Notes.ReadWrite.All

Response dataDescription
Success codeA 204 HTTP status code.
ErrorsIf the request fails, the API returns errors in the response body.
X-CorrelationId headerA GUID that uniquely identifies the request. You can use this value along with the value of the Date header when working with Microsoft support to troubleshoot issues.

Add members and leaders

Adding leaders and members gives them access to the staff notebook. Adding a member also creates a member section group. This section group is only accessible by the member and the leader, and contains the member sections that are defined for the notebook.

To add a member or leader to a staff notebook, send a POST request to the appropriate endpoint.

Add a member

POST ./staffNotebooks/{notebook-id}/members

Add a leader

POST ./staffNotebooks/{notebook-id}/leaders

Send a JSON principal object in the message body. You can add one member or one leader per request.

Leaders and members are represented by principal objects, which contain the following properties:

ParameterDescription
idThe Office 365 user principal name. See the Azure AD Graph API documentation to learn more about users and groups.
principalTypePerson or Group

Example

The following request adds a leader to the specified staff notebook.

Request and response information

The following information applies to POST /members and POST /leaders requests.

Request dataDescription
ProtocolAll requests use the SSL/TLS HTTPS protocol.
Authorization header

Bearer {token}, where {token} is a valid OAuth 2.0 access token for your registered app.

If missing or invalid, the request fails with a 401 status code. See Authenticate using Azure AD (enterprise apps).

Content-Type headerapplication/json
Accept headerapplication/json
Permission scopeNotes.ReadWrite.CreatedByApp, Notes.ReadWrite, or Notes.ReadWrite.All

Response dataDescription
Success codeA 201 HTTP status code.
Response bodyThe member or leader that was added.
ErrorsIf the request fails, the API returns errors in the @api.diagnostics object in the response body.
X-CorrelationId headerA GUID that uniquely identifies the request. You can use this value along with the value of the Date header when working with Microsoft support to troubleshoot issues.

Remove members and leaders

Removing members and leaders from a staff notebook revokes their access to the notebook, but doesn't delete any content.

To remove a member or leader from a staff notebook, send a DELETE request to the appropriate endpoint.

Remove a member

DELETE ./staffNotebooks/{notebook-id}/members/{member-id}

Remove a leader

DELETE ./staffNotebooks/{notebook-id}/leaders/{leader-id}

You can remove one member or one leader per request.

Example

The following request removes the specified member from the specified staff notebook.

Request and response information

The following information applies to DELETE /members and DELETE /leaders requests.

Request dataDescription
ProtocolAll requests use the SSL/TLS HTTPS protocol.
Authorization header

Bearer {token}, where {token} is a valid OAuth 2.0 access token for your registered app.

If missing or invalid, the request fails with a 401 status code. See Authenticate using Azure AD (enterprise apps).

Accept headerapplication/json
Permission scopeNotes.ReadWrite.CreatedByApp, Notes.ReadWrite, or Notes.ReadWrite.All

Response dataDescription
Success codeA 204 HTTP status code.
ErrorsIf the request fails, the API returns errors in the @api.diagnostics object in the response body.
X-CorrelationId headerA GUID that uniquely identifies the request. You can use this value along with the value of the Date header when working with Microsoft support to troubleshoot issues.

Insert sections

Use copySectionsToContentLibrary to copy specific sections from Office 365 notebooks and insert them into the Content Library of a staff notebook. A Content Library is a section group inside the staff notebook that has Read/Write permissions for leaders and Read permission for members.

To insert sections into a staff notebook, send a POST request to the copySectionsToContentLibrary endpoint of the target staff notebook. For example:

POST ./staffNotebooks/{notebook-id}/copySectionsToContentLibrary

In the message body, send a JSON object with the sectionIds parameter.

ParameterDescription
sectionIdsAn array that contains the IDs of the sections that you want to insert into the staff notebook.

The user must have access to the target sections and notebook (owned or shared). All targets must be in the same tenant.

Example

The following request inserts two sections into the Content Library of the specified staff notebook.

Request and response information

The following information applies to POST /copySectionsToContentLibrary requests.

Request dataDescription
ProtocolAll requests use the SSL/TLS HTTPS protocol.
Authorization header

Bearer {token}, where {token} is a valid OAuth 2.0 access token for your registered app.

If missing or invalid, the request fails with a 401 status code. See Authenticate using Azure AD (enterprise apps).

Content-Type headerapplication/json
Accept headerapplication/json
Permission scopeNotes.ReadWrite.CreatedByApp, Notes.ReadWrite, or Notes.ReadWrite.All

Response dataDescription
Success codeA 201 HTTP status code.
ErrorsIf the create request fails, the API returns errors in the response body.
X-CorrelationId headerA GUID that uniquely identifies the request. You can use this value along with the value of the Date header when working with Microsoft support to troubleshoot issues.

Construct the OneNote service root URL

The OneNote service root URL uses the following format for all calls to the OneNote API.

https://www.onenote.com/api/{version}/{location}/notes/

The version segment in the URL represents the version of the OneNote API that you want to use.

  • Use v1.0 for stable production code.

  • Use beta to try out a feature that's in development. Features and functionality in beta may change, so you shouldn't use it in your production code.

The location segment in the URL represents the location of the notebooks that you want to access:

  • Notebooks on OneDrive for Business

    • Use me for OneNote content that’s owned by the current user.

    • Use users/{id} for OneNote content that the specified user (in the URL) has shared with the current user. Use the Azure AD Graph API to get user IDs.

  • SharePoint site notebooks

    • Team sites and other SharePoint sites can contain OneNote notebooks in their document libraries.

    • Use myOrganization/siteCollections/{id}/sites/{id} for OneNote content in a site in the tenant that the current user is logged into. Only the current tenant is supported, accessed using the myOrganization keyword. Learn how to get site IDs.

  • Unified group notebooks Sid meier%27s simgolf mac.

    • Unified groups (also called Office 365 groups) are part of the Office 365 connected experience. Group members can share notebooks, files, and email.

    • Use myOrganization/groups/{id} for OneNote content in the specified group that the current user is a member of. Unified groups are the only supported group type. Use the Azure AD Graph API to get group IDs.

Use the FromUrl method to get the site collection and site IDs

You can use the FromUrl method to get the site collection and site IDs for a specified absolute site URL. You should make this call only when needed, and then store the values for future use.

The format of the site URL depends on your configuration, for example https://domain.sharepoint.com/site-a or https://domain.com/sites/site-a.

Example request

GET https://www.onenote.com/api/v1.0/myOrganization/siteCollections/FromUrl(url='{full-path-to-SharePoint-site}')

Delete Staff Notebook In Teams

Authorization: Bearer {token}

Accept: application/json

Example response

Requirements for using FromUrl and working with SharePoint site notebooks:

  • You can only create OneNote notebooks, section groups, sections, and pages on sites that have a default document library. (Some site templates don't create a default document library.) However, GET requests return OneNote content from all document libraries on the site.

  • The OneNote service root URL is immutable, meaning you can't use a SharePoint REST API site path and then tack the notes endpoint onto it.

  • The user on whose behalf you're calling must be a member of the site.

  • FromUrl works only with sites that have been indexed. It may take several hours to index a new site.

See also

  • OneNote staff notebooks (overview and features)