Cyfeirnod · Ffeiliau

Rhestru ffeiliau

GET /v1/files

Yn rhestru ffeiliau'r sefydliadau lle gall y defnyddiwr weld ffeiliau, o'r mwyaf newydd i'r hynaf.

Ymateb wedi'i dudalennu: daw'r eitemau yn data a gwybodaeth y dudalen yn meta. Tudaleniad a hidlwyr

Paramedrau

Enw	Math	Disgrifiad
`organization`	`string`	uid sefydliad, i ddychwelyd ei eitemau ef yn unig (gweler `/organizations`).
`q`	`string`	Rhan o'r enw, hyd at 100 nod.
`type`	`string`	Math o ffeil, fel `image` neu `video`.
`archived`	`integer`	`1` ar gyfer ffeiliau wedi'u harchifo yn unig neu `0` ar gyfer ffeiliau heb eu harchifo yn unig. Heb y paramedr, daw pob ffeil.
`page`	`integer`	Tudalen, gan ddechrau ar 1. Rhagosodiad: 1.
`per_page`	`integer`	Eitemau fesul tudalen, o 1 i 100. Rhagosodiad: 50.

Meysydd pob eitem

uid string: Dynodydd y ffeil.
name string: Enw'r ffeil yn y Panel Rheoli.
type string: Math o ffeil, fel image neu video.
duration integer: Hyd, mewn eiliadau.
archived boolean: true os yw'r ffeil wedi'i harchifo.
organization object: Sefydliad y ffeil: uid a name.

Gwallau posibl

400 invalid_parameter Mae gan baramedr werth annilys, fel per_page uwchlaw'r uchafswm.
404 organization_not_found Nid yw'r organization a roddwyd yn sefydliad lle gall y defnyddiwr weld y math hwn o eitem.
Mae gwallau allwedd a therfyn ceisiadau yn berthnasol i bob pwynt terfyn. Gweld pob gwall

CaiscURLPHPJavaScript

curl "https://api.on-cloud.live/v1/files?per_page=2" \
  -H "X-API-Key: $API_KEY"

<?php
$ch = curl_init('https://api.on-cloud.live/v1/files?per_page=2');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => ['X-API-Key: ' . getenv('API_KEY')],
]);
$response = json_decode(curl_exec($ch), true);

const res = await fetch('https://api.on-cloud.live/v1/files?per_page=2', {
  headers: { 'X-API-Key': process.env.API_KEY }
});
const { data, meta } = await res.json();

Ymateb200

{
  "data": [
    {
      "uid": "c20ad4d76fe97759aa27a0c99bff6710",
      "name": "Horário de funcionamento",
      "type": "image",
      "duration": 8,
      "archived": false,
      "organization": {
        "uid": "1679091c5a880faf6fb5e6087eb1b2dc",
        "name": "Loja Shopping Norte"
      }
    },
    {
      "uid": "6512bd43d9caa6e02c990b0a82652dca",
      "name": "Cardápio do dia",
      "type": "image",
      "duration": 10,
      "archived": false,
      "organization": {
        "uid": "8f14e45fceea167a5a36dedd4bea2543",
        "name": "Loja Centro"
      }
    }
  ],
  "meta": {
    "page": 1,
    "per_page": 2,
    "total": 3,
    "total_pages": 2
  }
}