PureBasic

OneNote - Get Page Metadata

See more OneNote Examples

Access a page's metadata by page identifier. PureBasic

IncludeFile "CkHttp.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkJsonObject.pb"

Procedure ChilkatExample()

    success.i = 0

    ; This example assumes the Chilkat API to have been previously unlocked.
    ; See Global Unlock Sample for sample code.

    http.i = CkHttp::ckCreate()
    If http.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    ; Implements the following CURL command:

    ; curl -X GET https://graph.microsoft.com/v1.0/me/onenote/pages/{id} \
    ;   -H 'authorization: Bearer ACCESS_TOKEN'

    ; Use the following online tool to generate HTTP code from a CURL command
    ; Convert a cURL Command to HTTP Source Code

    ; Adds the "Authorization: Bearer ACCESS_TOKEN" header.
    CkHttp::setCkAuthToken(http, "ACCESS_TOKEN")

    CkHttp::ckSetUrlVar(http,"page_id","0-d2298668edd74dccac7f821fa378bf64!41-3A33FCEB9B74CC15!20350")

    sbResponseBody.i = CkStringBuilder::ckCreate()
    If sbResponseBody.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success = CkHttp::ckQuickGetSb(http,"https://graph.microsoft.com/v1.0/me/onenote/pages/{$page_id}",sbResponseBody)
    If success = 0
        Debug CkHttp::ckLastErrorText(http)
        CkHttp::ckDispose(http)
        CkStringBuilder::ckDispose(sbResponseBody)
        ProcedureReturn
    EndIf

    jResp.i = CkJsonObject::ckCreate()
    If jResp.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkJsonObject::ckLoadSb(jResp,sbResponseBody)
    CkJsonObject::setCkEmitCompact(jResp, 0)

    Debug "Response Body:"
    Debug CkJsonObject::ckEmit(jResp)

    respStatusCode.i = CkHttp::ckLastStatus(http)
    Debug "Response Status Code = " + Str(respStatusCode)
    If respStatusCode >= 400
        Debug "Response Header:"
        Debug CkHttp::ckLastHeader(http)
        Debug "Failed."
        CkHttp::ckDispose(http)
        CkStringBuilder::ckDispose(sbResponseBody)
        CkJsonObject::ckDispose(jResp)
        ProcedureReturn
    EndIf

    ; Sample JSON response:
    ; (Sample code for parsing the JSON response is shown below)

    ; {
    ;   "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#users('admin%40chilkat.io')/onenote/pages/$entity",
    ;   "id": "0-d2298668edd74dccac7f821fa378bf64!41-3A33FCEB9B74CC15!20350",
    ;   "self": "https://graph.microsoft.com/v1.0/users/admin@chilkat.io/onenote/pages/0-d2298668edd74dccac7f821fa378bf64!41-3A33FCEB9B74CC15!20350",
    ;   "createdDateTime": "2020-10-23T12:00:44Z",
    ;   "title": "A page with rendered images and an attached file",
    ;   "createdByAppId": "WLID-00000000441C9990",
    ;   "contentUrl": "https://graph.microsoft.com/v1.0/users/admin@chilkat.io/onenote/pages/0-d2298668edd74dccac7f821fa378bf64!41-3A33FCEB9B74CC15!20350/content",
    ;   "lastModifiedDateTime": "2020-10-23T17:00:45.9018633Z",
    ;   "links": {
    ;     "oneNoteClientUrl": {
    ;       "href": "onenote:https://d.docs.live.net/3a33fceb9b74cc15/Documents/Testing%20Notebook/Ddd.one#A%20page%20with%20rendered%20images%20and%20an%20attached%20file&section-id=40f1bd0c-f32c-4f6a-8cc8-d0fc782f7064&page-id=2a8949ff-753a-45df-9a4c-f82743a7ebed&end"
    ;     },
    ;     "oneNoteWebUrl": {
    ;       "href": "https://onedrive.live.com/redir.aspx?cid=3a33fceb9b74cc15&page=edit&resid=3A33FCEB9B74CC15!20344&parId=3A33FCEB9B74CC15!187&wd=target%28Ddd.one%7C40f1bd0c-f32c-4f6a-8cc8-d0fc782f7064%2FA%20page%20with%20rendered%20images%20and%20an%20attached%20file%7C2a8949ff-753a-45df-9a4c-f82743a7ebed%2F%29"
    ;     }
    ;   },
    ;   "parentSection@odata.context": "https://graph.microsoft.com/v1.0/$metadata#users('admin%40chilkat.io')/onenote/pages('0-d2298668edd74dccac7f821fa378bf64%2141-3A33FCEB9B74CC15%2120350')/parentSection/$entity",
    ;   "parentSection": {
    ;     "id": "0-3A33FCEB9B74CC15!20350",
    ;     "displayName": "Ddd",
    ;     "self": "https://graph.microsoft.com/v1.0/users/admin@chilkat.io/onenote/sections/0-3A33FCEB9B74CC15!20350"
    ;   }
    ; }

    ; Sample code for parsing the JSON response...
    ; Use the following online tool to generate parsing code from sample JSON:
    ; Generate Parsing Code from JSON

    odata_context.s = CkJsonObject::ckStringOf(jResp,Chr(34) + "@odata.context" + Chr(34))
    id.s = CkJsonObject::ckStringOf(jResp,"id")
    self.s = CkJsonObject::ckStringOf(jResp,"self")
    createdDateTime.s = CkJsonObject::ckStringOf(jResp,"createdDateTime")
    title.s = CkJsonObject::ckStringOf(jResp,"title")
    createdByAppId.s = CkJsonObject::ckStringOf(jResp,"createdByAppId")
    contentUrl.s = CkJsonObject::ckStringOf(jResp,"contentUrl")
    lastModifiedDateTime.s = CkJsonObject::ckStringOf(jResp,"lastModifiedDateTime")
    linksOneNoteClientUrlHref.s = CkJsonObject::ckStringOf(jResp,"links.oneNoteClientUrl.href")
    linksOneNoteWebUrlHref.s = CkJsonObject::ckStringOf(jResp,"links.oneNoteWebUrl.href")
    parentSectionodata_context.s = CkJsonObject::ckStringOf(jResp,Chr(34) + "parentSection@odata.context" + Chr(34))
    parentSectionId.s = CkJsonObject::ckStringOf(jResp,"parentSection.id")
    parentSectionDisplayName.s = CkJsonObject::ckStringOf(jResp,"parentSection.displayName")
    parentSectionSelf.s = CkJsonObject::ckStringOf(jResp,"parentSection.self")


    CkHttp::ckDispose(http)
    CkStringBuilder::ckDispose(sbResponseBody)
    CkJsonObject::ckDispose(jResp)


    ProcedureReturn
EndProcedure