Wello

Wello

  • Docs
  • API
  • Publication
  • Livre Blanc

›League

Utilisateur

  • Authentification

Organisation

  • Organisation
  • Membre d'une organisation
  • Timeline d'une organisation
  • Activités par organisation
  • Demande de rappel / Devis
  • Formations - Video - Moocs
  • Groupe de discussion

League

  • City
  • Leagues
  • Articles

Carnet de liaison

  • Carnet de liaison / Pro
  • Carnet de liaison / Perso
  • Commentaire
  • Restriction

Concept

  • Tâche (task)
  • Récurrence d'un tâche (twig)

Articles

Seul l'admin d'une league peut créer/modifier/supprimer un article.

Lister les articles proposés par une league

basePath: /api/v0/league/league_id/articles

params

  • :league_id (integer, required): identifiant de league

curl

curl -X GET \
     -H "Authorization: Bearer 9e7de626-Aac7-a90d-c34A" \
     https://twigy-server.herokuapp.com/api/v0/leagues/*league_id*/articles

reponse

    "articles": [
        {
            "id": 30,
            "title": "1er article de League",
            "content": "contenu",
            "slug": "1er-article-de-league",
            "related_words": [
                "Courage",
                "Maladie"
            ],
            "created_at": "2020-11-25T15:09:46.494Z",
            "postable_type": "League",
            "postable_id": 6
        },
        {
            "id": 31,
            "title": "2eme article de League",
            "content": "contenu",
            "slug": "1er-article-de-league-",
            "related_words": [
                "Courage",
                "Maladie"
            ],
            "created_at": "2020-11-25T15:15:33.317Z",
            "postable_type": "League",
            "postable_id": 6
        }
    ]
}

Consulter un seul article

basePath: /api/v0/league/league_id/articles/article_id

params

  • :league_id (integer, required): identifiant de league
  • :article_id (integer, required): identifiant de l'article

curl

curl -X GET \
     https://twigy-server.herokuapp.com/api/v0/leagues/*league_id*/articles/*article_id*

reponse

    "article": {
        "id": 31,
        "title": "1er article",
        "content": "contenu",
        "slug": "1er-article-de-league-",
        "related_words": [
            "Courage",
            "Maladie"
        ],
        "created_at": "2020-11-25T15:15:33.317Z",
        "postable_type": "League",
        "postable_id": 6
    }
}

Ajouter un article

basePath: /api/v0/leagues/league_id/articles

url Params

  • :league_id (integer, required): identifiant de league

bodyParams

  • :article.title (t.string, required) : titre
  • :article.content (t.string) : content
  • :article.related_words (t.array) : hashtags
  • :article.cover
{
    "article":{
        "title":"3eme article de League",
        "content":"contenu, blabalbla",
        "related_words":["Courage", "Maladie"]
        }
}

curl

curl -X POST \  /api/v0/leagues/*league_id*/articles
    -H "Authorization: Bearer 9e7de626-Aac7-a90d-c34A" \

reponse

    "article": {
        "id": 31,
        "title": "1er article",
        "content": "contenu",
        "slug": "1er-article-de-league-",
        "related_words": [
            "Courage",
            "Maladie"
        ],
        "created_at": "2020-11-25T15:15:33.317Z",
        "postable_type": "League",
        "postable_id": 6,
        "cover_image_url":nil,
    }
}

Editer un Article proposé par une league

basePath: /api/v0/leagues/league_id/articles/article_id

url Params

  • :league_id (integer, required): identifiant de league
  • :article_id (integer, required): identifiant de l'article

bodyParams

  • :article.title (t.string, required) : titre
  • :article.content (t.string) : content
  • :article.related_words (t.array) : hastags
  • :article.cover

curl

curl -X UPDATE \ /api/v0/leagues/*league_id*/articles/*article_id*

response

{
    "article": {
        "id": 31,
        "title": "4eme article de League",
        "content": "contenu, blabalbla",
        "slug": "4eme-article-de-league",
        "related_words": [
            "Courage",
            "Maladie"
        ],
        "created_at": "2020-11-25T15:15:33.317Z",
        "postable_type": "League",
        "postable_id": 6,
        "cover_image_url":nil
    }
}

Supprimer un Article proposé par une league

basePath: /api/v0/leagues/league_id/articles/article_id

url Params

  • :league_id (integer, required): identifiant de league
  • :article_id (integer, required): identifiant du Article

curl

curl -X DELETE \ :/api/v0/leagues/*league_id*/articles/*article_id*

response Liste des articles existants dans la league (cf lister tous les articles)

← LeaguesCarnet de liaison / Pro →
  • Lister les articles proposés par une league
  • Consulter un seul article
  • Ajouter un article
  • Editer un Article proposé par une league
  • Supprimer un Article proposé par une league
Wello
Docs
Getting Started (or other categories)Guides (or other categories)API Reference (or other categories)
Community
User ShowcaseStack OverflowProject ChatTwitter
More
HelpBlogGitHubStar
Facebook Open Source
Copyright © 2020 Wello