rtm_docs: A list of documented API methods for the RTM REST API...

Description Usage Format Source

Description

A list of documented API methods for the RTM REST API previously scraped from the RTM website using functions in this package.

Usage

1

Format

A list of rtm_doc objects, each of which contains the following fields

method

the API method name

description

a description

authentication

whether the API method requires authentication

arguments

a list of its arguments

arguments_desc

a list of argument descriptions

example

an example response

error_codes

a list of possible error codes

error_codes_desc

a list of descriptions of the error codes

timeline

whether the API call requires a timeline (not all have this)

revertible

whether the API call is revertible

Source

http://www.diamondse.info/


jowalski/rtmapidoc documentation built on May 19, 2019, 9:42 p.m.