PureBasic

List Plans for a Group

See more Microsoft Tasks and Plans Examples

Demonstrates how to retrieve a list of plannerPlan objects owned by a group object.

See https://docs.microsoft.com/en-us/graph/api/plannergroup-list-plans?view=graph-rest-1.0 for more information.

PureBasic

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

Procedure ChilkatExample()

    success.i = 0

    ; This example requires 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

    ; The Microsoft Planner REST API requires an OAuth2 token with the Group.ReadWrite.All scope.
    ; Use your previously obtained access token as shown here:
    ;    Get Microsoft Graph OAuth2 Access Token with Group.ReadWrite.All scope.

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

    success = CkJsonObject::ckLoadFile(jsonToken,"qa_data/tokens/msGraphGroup.json")
    If success = 0
        Debug CkJsonObject::ckLastErrorText(jsonToken)
        CkHttp::ckDispose(http)
        CkJsonObject::ckDispose(jsonToken)
        ProcedureReturn
    EndIf

    CkHttp::setCkAuthToken(http, CkJsonObject::ckStringOf(jsonToken,"access_token"))

    ; Send a GET request to https://graph.microsoft.com/v1.0/groups/{group-id}/planner/plans
    strResponse.s = CkHttp::ckQuickGetStr(http,"https://graph.microsoft.com/v1.0/groups/{group-id}/planner/plans")
    If CkHttp::ckLastMethodSuccess(http) = 0
        Debug CkHttp::ckLastErrorText(http)
        CkHttp::ckDispose(http)
        CkJsonObject::ckDispose(jsonToken)
        ProcedureReturn
    EndIf

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

    CkJsonObject::ckLoad(json,strResponse)
    CkJsonObject::setCkEmitCompact(json, 0)

    If CkHttp::ckLastStatus(http) <> 200
        Debug CkJsonObject::ckEmit(json)
        Debug "Failed, response status code = " + Str(CkHttp::ckLastStatus(http))
        CkHttp::ckDispose(http)
        CkJsonObject::ckDispose(jsonToken)
        CkJsonObject::ckDispose(json)
        ProcedureReturn
    EndIf

    Debug CkJsonObject::ckEmit(json)

    ; Sample output:
    ; (See parsing code below..)

    ; {
    ;   "value": [
    ;     {
    ;       "createdBy": {
    ;         "application": {
    ;           "id": "95e27074-6c4a-447a-aa24-9d718a0b86fa"
    ;         },
    ;         "user": {
    ;           "id": "ebf3b108-5234-4e22-b93d-656d7dae5874"
    ;         }
    ;       },
    ;       "createdDateTime": "2015-03-30T18:36:49.2407981Z",
    ;       "owner": "ebf3b108-5234-4e22-b93d-656d7dae5874",
    ;       "title": "title-value",
    ;       "id": "xqQg5FS2LkCp935s-FIFm2QAFkHM"
    ;     }
    ;   ]
    ; }

    ; Use this online tool to generate parsing code from sample JSON: 
    ; Generate Parsing Code from JSON

    i.i
    count_i.i
    createdByApplicationId.s
    createdByUserId.s
    createdDateTime.s
    owner.s
    title.s
    id.s

    i = 0
    count_i = CkJsonObject::ckSizeOfArray(json,"value")
    While i < count_i
        CkJsonObject::setCkI(json, i)
        createdByApplicationId = CkJsonObject::ckStringOf(json,"value[i].createdBy.application.id")
        createdByUserId = CkJsonObject::ckStringOf(json,"value[i].createdBy.user.id")
        createdDateTime = CkJsonObject::ckStringOf(json,"value[i].createdDateTime")
        owner = CkJsonObject::ckStringOf(json,"value[i].owner")
        title = CkJsonObject::ckStringOf(json,"value[i].title")
        id = CkJsonObject::ckStringOf(json,"value[i].id")
        i = i + 1
    Wend

    Debug "Success."


    CkHttp::ckDispose(http)
    CkJsonObject::ckDispose(jsonToken)
    CkJsonObject::ckDispose(json)


    ProcedureReturn
EndProcedure