Uporabniška orodja

Orodja spletišča


nabisrestapi-document-v1-7a04stt

Primerjava izbranih različic

Prikazane so razlike med izbrano in trenutno različico strani.

Poveži s tem pogledom primerjave.

Both sides previous revision Prejšnja revizija
Naslednja revizija
Prejšnja revizija
nabisrestapi-document-v1-7a04stt [2017/10/05 10:09]
rok-navodila
nabisrestapi-document-v1-7a04stt [2017/10/05 14:53] (Trenutna)
Vrstica 5: Vrstica 5:
   * Application-Id:​ UUID vaše aplikacije   * Application-Id:​ UUID vaše aplikacije
  
-==== getDocumentHeaders ==== +==== getDocumentHeaders ​(GET) ==== 
-Izvoz glav naročil. Brez dodatnih parametrov se izvozi zadnjih 10 naročil.+Izvoz glav naročil. Brez dodatnih parametrov se izvozi zadnjih 10 novih naročil.
 === Parametri === === Parametri ===
   * page: celo število večje od 0, privzeto: 1   * page: celo število večje od 0, privzeto: 1
 +  * flags: ena ali več oznak naročil ločenih z vejico (privzeto: new):
 +    * read: naročilo je bilo prebrano z getDocument zahtevo
 +    * hidden: naročilo ste ročno označili kot skrito s setDocumentFlags
 +    * processed: naročilo ste ročno označili kot obdelano s setDocumentFlags
 +    * //new//: nova naročila (niso označena z nebeno od zgornjih oznak) (privzeto)
 +    * //any//: vsa naročila, ne glede na oznake
 === Primer === === Primer ===
   * URL/​getDocumentHeaders?​Client-Id=//<​UUID1>//&​Application-Id=//<​UUID2>//​   * URL/​getDocumentHeaders?​Client-Id=//<​UUID1>//&​Application-Id=//<​UUID2>//​
   * URL/​getDocumentHeaders?​Client-Id=//<​UUID1>//&​Application-Id=//<​UUID2>//&​page=2   * URL/​getDocumentHeaders?​Client-Id=//<​UUID1>//&​Application-Id=//<​UUID2>//&​page=2
 +  * URL/​getDocumentHeaders?​Client-Id=//<​UUID1>//&​Application-Id=//<​UUID2>//&​flags=read,​new
  
 Odgovor: Odgovor:
Vrstica 40: Vrstica 47:
   * orderValue(decimal):​ vrednost naročila, brez DDV   * orderValue(decimal):​ vrednost naročila, brez DDV
   * orderItemCount(int):​ število postavk na naročilu   * orderItemCount(int):​ število postavk na naročilu
 +  * flags(string[]):​ kombinacija sledečih oznak (lahko nobena):
 +    * read
 +    * hidden
 +    * processed
  
-==== getDocument ====+==== getDocument ​(GET) ====
 Izvoz posameznega naročila. Izvoz posameznega naročila.
 === Parametri === === Parametri ===
Vrstica 108: Vrstica 119:
     * netPrice(decimal|null):​ neto cena ali NULL     * netPrice(decimal|null):​ neto cena ali NULL
     * taxPercentage(decimal|null):​ DDV % ali NULL     * taxPercentage(decimal|null):​ DDV % ali NULL
 +
 +
 +==== setDocumentFlags (POST) ====
 +Nastavi ali doda oznake naročil.
 +=== Parametri ===
 +  * documentID: ID naročila (obveznen parameter)
 +  * flags: kombinacija sledečih oznak (lahko nobena) ločenih z vejico (obvezen parameter):
 +    * read
 +    * hidden
 +    * processed
 +  * mode: način spreminjanja (privzeto: add):
 +    * add: doda k že obstoječim oznakam
 +    * set: odstrani obstoječe oznake in nastavi na podane
 +=== Primer ===
 +  * URL/​setDocumentFlags?​Client-Id=//<​UUID1>//&​Application-Id=//<​UUID2>//&​documentID=10060&​flags=processed
 +    * Doda oznako "​obdelano"​
 +  * URL/​setDocumentFlags?​Client-Id=//<​UUID1>//&​Application-Id=//<​UUID2>//&​documentID=10060&​mode=set&​flags=
 +    * Odstrani vse obstoječe oznake
 +  * URL/​setDocumentFlags?​Client-Id=//<​UUID1>//&​Application-Id=//<​UUID2>//&​documentID=10060&​mode=set&​flags=read,​hidden
 +    * Odstrani vse obstoječe oznake in nastavi oznaki "​prebrano"​ in "​skrito"​
 +
 +Odgovor:
 +  {
 +    "​documentID":​ 10060,
 +    "​flags":​ ["​read",​ "​processed"​]
 +  }
 +
 +=== Polja ===
 +  * documentID: ID naročila
 +  * flags: novo stanje po spremembi
 +
 +==== Napake ====
 +  * Vsaka pravilna zahteva ima HTTP status 200
 +  * V primeru napačne metode (GET, POST) je status 405
 +  * V primeru napak v parametrih je status 400, ter dodan HTTP header REST-Errors s kratkim opisom napake
 +
nabisrestapi-document-v1-7a04stt.1507190948.txt.gz · Zadnja sprememba: 2017/10/05 10:09 (urejanje v zunanjem urejevalniku)