Saltar al contenido

Obtener una lista por su dirección

GET/v1/collections/by-path/{username}/{slug}

Devuelve una lista por el nombre de usuario de su propietario y su slug, las dos partes de la dirección de la lista.

Solicitud

Shell
curl -g "https://api.nogitsu.com/v1/collections/by-path/{username}/{slug}"

Parámetros

  • username

    rutaobligatorio

    El nombre de usuario del miembro.

    texto

  • slug

    rutaobligatorio

    El slug de la dirección de la página en nogitsu.com.

    texto

Respuesta

Una solicitud correcta responde 200 con este JSON:

  • idtexto (uuid)
  • nametexto
  • slugtexto
  • pathtexto
  • descriptiontextopuede ser null
  • visibilitytexto
    Valores permitidospublicunlistedprivate
  • isOrderedtrue o false
  • languagetexto
    Valores permitidosentrdefresptitruidjakozh
  • itemCountnúmero entero

    De 0 a 9007199254740991

  • subscriberCountnúmero entero

    De 0 a 9007199254740991

  • ownerobjeto
    • usernametexto
    • displayNametexto
    • avatarUrltexto (uri)puede ser null
  • coverslista de objeto
    • urltexto (uri)
    • variantWidthslista de número entero

      De -9007199254740991 a 9007199254740991

  • isRemovedtrue o false
  • isIndexabletrue o false
  • createdAttexto (date-time)
  • updatedAttexto (date-time)
  • themeobjetopuede ser null
    • backgroundtexto
    • accenttexto
    • fonttexto
      Valores permitidosdefaultserifmono
    • densitytexto
      Valores permitidoscomfortablecompact
    • layouttexto
      Valores permitidosrowsposters
    • showsCurrentlyConsumingtrue o false
  • copiedFromobjetopuede ser null
    • nametexto
    • pathtexto
    • ownerDisplayNametexto

Errores

Como todas las operaciones, esta puede responder 400 si los parámetros no son válidos, 404 si no se encuentra nada y 429 si envías demasiadas solicitudes. Todos los errores comparten una misma forma.

Lee sobre los errores