Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Selle API abil saate projekti silte vaadata, lisada, redigeerida ja kustutada.

Lugemine.

Võimaldab vaadata projektis loodud silte.

Code Block
GET https://api.smartsender.com/v1/tags

Peamised parameetrid:

Nimi

Kirjeldus

Kinnitamine

page

Taotletud leht

Minimaalne väärtus 1

limitation

Ühel lehel kuvatavate andmete hulk

Minimaalne väärtus 1, maksimaalne 20

term

Otsi stringi

 

Eduka vastuse korral saate järgmise teabe:

Code Block
{
    "cursor": Cursor,
    "collection": Tag[]
}

Vastuse kirjeldus:

Nimi

Kirjeldus

cursor

Kursor objekt

collection

Objektide hulk Tag

Loomine.

Võimaldab luua projektis sildi.

Code Block
POST https://api.smartsender.com/v1/tags

Peamised parameetrid:

Nimi

Kirjeldus

Kinnitamine

name

Nimi

Projekti sees ainulaadne

color

Värv

6 tähemärki tähistamiseks HEX

Kui vastus on edukas, hankige loodud Tag objekt.

Värskenda.

Võimaldab värskendada olemasolevat silti.

Code Block
PUT https://api.smartsender.com/v1/tags/{tagId}

Peamised parameetrid:

Nimi

Kirjeldus

Kinnitamine

name

Nimi

Projekti sees ainulaadne

color

Värv

6 tähemärki tähistamiseks HEX

Eduka vastuse korral saate järgmise teabe:

Code Block
{
    "state": true
}

Eemaldus.

Võimaldab olemasoleva sildi kustutada.

Code Block
DELETE https://api.smartsender.com/v1/tags/{tagId}

Eduka vastuse korral saate järgmise teabe:

Code Block
{
    "state": true
}