Aller au contenu

Obtenir une liste

GET/v1/collections/{id}

Renvoie une liste par identifiant : nom, description, propriétaire, thème et compteurs.

Requête

Shell
curl -g "https://api.nogitsu.com/v1/collections/{id}"

Paramètres

  • id

    cheminobligatoire

    Identifiant de l’élément, un UUID.

    texte

Réponse

Une requête réussie répond 200 avec ce JSON :

  • idtexte (uuid)
  • nametexte
  • slugtexte
  • pathtexte
  • descriptiontextepeut être null
  • visibilitytexte
    Valeurs autoriséespublicunlistedprivate
  • isOrderedtrue ou false
  • languagetexte
    Valeurs autoriséesentrdefresptitruidjakozh
  • itemCountnombre entier

    De 0 à 9007199254740991

  • subscriberCountnombre entier

    De 0 à 9007199254740991

  • ownerobjet
    • usernametexte
    • displayNametexte
    • avatarUrltexte (uri)peut être null
  • coversliste de objet
    • urltexte (uri)
    • variantWidthsliste de nombre entier

      De -9007199254740991 à 9007199254740991

  • isRemovedtrue ou false
  • isIndexabletrue ou false
  • createdAttexte (date-time)
  • updatedAttexte (date-time)
  • themeobjetpeut être null
    • backgroundtexte
    • accenttexte
    • fonttexte
      Valeurs autoriséesdefaultserifmono
    • densitytexte
      Valeurs autoriséescomfortablecompact
    • layouttexte
      Valeurs autoriséesrowsposters
    • showsCurrentlyConsumingtrue ou false
  • copiedFromobjetpeut être null
    • nametexte
    • pathtexte
    • ownerDisplayNametexte

Erreurs

Comme toutes les opérations, celle-ci peut répondre 400 en cas de paramètres invalides, 404 lorsque rien n’est trouvé et 429 lorsque vous envoyez trop de requêtes. Toutes les erreurs partagent la même forme.

En savoir plus sur les erreurs