OneNote GET sectiongroups/id

Gets details of a specified section group.

Last modified: June 25, 2014

Applies to: apps for SharePoint | OneNote service | SharePoint Server 2013

In this article
Resource URLs
HTTP Request Headers
OAuth scopes
Extended description
Example request
HTTP response headers
Response properties
Example response
Additional resources

The GET verb with the sectiongroups/id resource path represents a specific section group inside a OneNote notebook that is stored in Microsoft OneDrive. This can be a section group in a notebook that is either owned by or shared with the user.

HTML
Copy 
HTTPS://www.onenote.com/api/v1.0/sectiongroups/{section group ID}
Resource information

Protocol

SSL/TLS HTTPS

Response format

JSON

All requests to the OneNote API must include the Authorization header.

Request Header

Value and Description

Authorization

Bearer tokenString
A valid OAuth token provided to the app based on the user credentials and the user having authorized access. For more information, see Authenticate the user for the OneNote API.

Security note Security Note

The Microsoft OneNote API requires OAUTH authentication, so user names and passwords passed in clear text, as is done with Basic authentication, are not accepted. To ensure the security of your user's account credentials, be sure your app doesn't attempt to use Basic authentication, or send account credentials, even when it's over HTTPS.

Request one of the following scopes when your product authenticates the user, depending on what you want the user to be able to see.

Scopes

Scope

Purpose

office.onenote

Grants read permissions to the user's notebooks, section groups, and pages. Request this scope if your product needs to query section groups in any of the user's notebooks.

office.onenote_update_by_app

Grants create, read, update, and delete permissions to pages created by the product. Request this scope if your product only needs to query section groups that the user created through your product.

office.onenote_update

Grants full access to the user's notebooks, section groups, and pages. Request this scope if your product needs to query and update section groups in any of the user's notebooks.

office.onenote_create

Allows your product to enumerate the notebook hierarchy and create pages in any location. Request this scope if your product needs to create pages in any of the user's notebooks.

When you use the GET verb with the /sectiongroups/id endpoint, the OneNote API returns the section groups as a JSON object that conforms to the OData version 4.0 specification.

Copy 
[GET] https://www.onenote.com/api/v1.0/sectiongroups{section group id}

This returns the specified section group, if the user has access to it. You can get a list of section groups by using the section groups resource path. If the user or your application doesn’t have correct permissions to get access to the section group, the OneNote API will return an error code in the 40001-49999 range.

Response Header

Value and Description

Content-Type

Application/json: charset=utf-8

The API always returns data in JSON format.

X-CorrelationId

<GUID>

The correlation ID uniquely identifies the request and can be used when debugging problems.

Property

Value and description

Value type

sectionsUrl

The /sections endpoint where you can get details for all the sections in the section group.

string

sectionGroupsUrl

The /sectiongroups endpoint where you can get details for all the section groups in the section group.

string

self

The endpoint where you can get details about the section group.

string

id

The unique identifier of the section group.

string

name

The name of the section group.

string

createdBy

The user who created the section group.

string

createdTime

The date and time when the section group was created.

An ISO 8601 formatted date.

lastModifiedBy

The user who last modified the section group.

string

lastModifiedTime

The date and time when the section group was last modified.

An ISO 8601 formatted date.

JSON
Copy 
Content-Type: application/json
X-CorrelationId: <GUID>
Status: 200 OK
{
  "@odata.context":"https://edog.onenote.com/api/Beta/$metadata#sectionGroups","value":[
    {
      "sectionsUrl":"https://www.onenote.com/api/v1.0/sectionGroups/section group ID/sections",
"sectionGroupsUrl":"https://www.onenote.com/api/v1.0/sectionGroups/section group ID/sectionGroups",
"id":"section group ID",
"name":"section group name",
"self":"https://www.onenote.com/api/v1.0/sectionGroups/section group ID",
"createdBy":"user name",
"lastModifiedBy":"user name",
"createdTime":"2013-10-05T16:48:53.553Z",
"lastModifiedTime":"2014-01-13T00:53:18.007Z"
    }
  ]
}
Show: