Exemplo n.º 1
0
    def get_planner_note(self, planner_note, **kwargs):
        """
        Retrieve a planner note for the current user

        :calls: `GET /api/v1/planner_notes/:id \
        <https://canvas.instructure.com/doc/api/planner.html#method.planner_notes.show>`_

        :param planner_note: The ID of the planner note to retrieve.
        :type planner_note: int or :class:`canvasapi.planner.PlannerNote`

        :rtype: :class:`canvasapi.planner.PlannerNote`
        """
        from canvasapi.planner import PlannerNote

        if isinstance(planner_note, int) or isinstance(planner_note,
                                                       PlannerNote):
            planner_note_id = obj_or_id(planner_note, "planner_note",
                                        (PlannerNote, ))
        else:
            raise RequiredFieldMissing(
                "planner_note is required as an object or as an int.")

        response = self.__requester.request(
            'GET',
            'planner_notes/{}'.format(planner_note_id),
            _kwargs=combine_kwargs(**kwargs))

        return PlannerNote(self.__requester, response.json())
Exemplo n.º 2
0
    def create_planner_note(self, **kwargs):
        """
        Create a planner note for the current user

        :calls: `POST /api/v1/planner_notes \
        <https://canvas.instructure.com/doc/api/planner.html#method.planner_notes.create>`_

        :rtype: :class:`canvasapi.planner.PlannerNote`
        """
        from canvasapi.planner import PlannerNote

        response = self.__requester.request('POST',
                                            'planner_notes',
                                            _kwargs=combine_kwargs(**kwargs))
        return PlannerNote(self.__requester, response.json())