Dotaz na vrácení (GET) kolekce faktur vydaných (pozor, není aplikováno omezení, v závislosti na počtu faktur může brzdit server).

GET http://localhost/data/issuedinvoices HTTP/1.1
Host: localhost
Authorization: Basic VGVzdDoxMjM=
Content-Length: 0

Dotaz na vrácení (GET) jedné faktury vydané s ID=1400000101

GET http://localhost/data/issuedinvoices/1400000101 HTTP/1.1
Host: localhost
Authorization: Basic VGVzdDoxMjM=
Content-Length: 0

Získání kolekce řádků faktur vydaných (subkolekce řádků FV má název "rows"):

GET http://localhost/data/issuedinvoices/1400000101/rows HTTP/1.1
Host: localhost
Authorization: Basic VGVzdDoxMjM=
Content-Length: 0

Dotaz na vrácení (GET) kolekce středisek, která jsou skrytá.

GET http://localhost/data/divisions/views/hidden HTTP/1.1
Host: localhost
Authorization: Basic VGVzdDoxMjM=
Content-Length: 0

Dotaz:

POST http://localhost/data/issuedinvoices HTTP/1.1
Host: localhost
Authorization: Basic VGVzdDoxMjM=
Content-Length: 404
{
	"docqueue_id" : "5600000101",
	"description": "Test vytvoření faktury",
	"rows": [
		{
			"rowtype": 1,
			"text" : "Test řádek č. 1",
			"division_id" : "2100000101",
			"vatrate_id" : "02100X0000",
			"totalprice": 100
		},
		{
			"rowtype": 1,
			"text" : "Test řádek č. 2",
			"division_id" : "2100000101",
			"vatrate_id" : "01500X0000",
			"totalprice": 101.5
		}
	 ]
}

Odpověď:

HTTP/1.1 201 Created
Access-Control-Allow-Origin: *
Connection: Keep-Alive
Access-Control-Allow-Methods: GET,PUT,POST,DELETE
Location: /data/issuedinvoices/1130000101
Content-Type: application/json
Access-Control-Allow-Credentials: true
Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept
Content-Length: 6679

V hlavičce Location je uveden URI nově vytvořeného objektu.

Dotaz:

POST http://localhost/data/issuedinvoices/import/billsofdelivery/1I30000101 HTTP/1.1
Host: localhost
Authorization: Basic VGVzdDoxMjM=
Content-Length: 53
{
	"params": {
	"DocQueue_ID": "5600000101"
	}
}

Odpověď:

HTTP/1.1 201 Created
Content-Type: application/json
Access-Control-Allow-Origin: *
Connection: Keep-Alive
Access-Control-Allow-Credentials: true
Access-Control-Allow-Methods: GET,PUT,POST,DELETE
Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept
Content-Length: 5030

Dotaz:

PUT http://localhost/data/issuedinvoices/4230000101/rows/1030000101 HTTP/1.1
Host: localhost
Authorization: Basic VGVzdDoxMjM=
Content-Length: 27
{
	"unitprice" : 3000.0
}

Odpověď:

HTTP/1.1 200 OK
Content-Type: application/json
Access-Control-Allow-Origin: *
Connection: Keep-Alive
Access-Control-Allow-Credentials: true
Access-Control-Allow-Methods: GET,PUT,POST,DELETE
Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept
Content-Length: 1747

PUT http://localhost/data/issuedinvoices/8M00000101 HTTP/1.1
Host: localhost
Content-Type: application/json
Authorization: Basic QVBJOmFwaQ==
Cache-Control: no-cache
Postman-Token: d5910570-9efd-43a6-9b5c-4ee2121d21a1
{
	"description": "telefony",
	"rows": [
		{
			"id": "VM00000101",
			"quantity": 4
		}
	]
}

Dotaz:

PUT http://localhost/data/firms/3200000101 HTTP/1.1
User-Agent: Fiddler
Host: localhost
Authorization: Basic VGVzdDoxMjM=
Content-Length: 53
{
	"residenceaddress_id": { "City" : "Praha X" }
}

Odpověď:

HTTP/1.1 200 OK
Link: <http://localhost/data/api-docs/swagger.json#>; rel="describedBy"
Connection: Keep-Alive
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: GET,PUT,POST,DELETE
Content-Type: application/json
Access-Control-Allow-Credentials: true
Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept
Content-Length: 16211

Chceme vytvořit fakturu vydanou z objednávky přijaté. V prostředí aplikaceIS FLORES bychom funkcí Vytvořit vyvolali odpovídajícího průvodce, vyplnili parametry importu a následně by se otevřela agenda Faktury vydané s připraveným dokladem, ve kterém bychom vyplnili několik zbývajících položek a fakturu uložili.

Když provádíme stejnou operaci prostřednictvím Web API, vlastnost output_document_update je ekvivalentem fáze "ve kterém bychom vyplnili několik zbývajících položek". (V rámci provádění požadavku se vytvoří objekt, na kterém můžeme ještě před uložením změnit některé vlastnosti.)

V našem konkrétním příkladě by se nám bez použití output_document_update nepodařilo fakturu vydanou uložit - pokud to zkusíme

POST http://localhost/demo15/issuedinvoices/import/receivedorders HTTP/1.1
Host: localhost
Content-Type: application/json
Authorization: Basic QVBJOmFwaQ==
Cache-Control: no-cache
Postman-Token: ec6e4774-7468-46cf-ac0d-26d859ce962e
{
	"input_document_clsid": "ReceivedOrder",
	"output_document_clsid": "IssuedInvoice",
	"input_documents": "2500000101",
	"params": {
		"ImportDocuments": true,
		"UndeliveredQuantity": true,
		"DeliveryDate": "2018-06-27T15:57:00.000Z",
		"DocQueue_ID": "5600000101"
	}
}

500 Internal Server Error
{
	"title": "Chyba při importu dokladu",
	"error_code": 1520,
	"description": "Chyba při validaci objektu \"Faktura vydaná: Bez čísla\":\r\nChyba v zadání položky Řada skladových dokladů"
}

Dotaz proto rozšíříme o vlastnost output_document_update, prostřednictvím které nastavíme požadovanou Řadu skladových dokladů na P600000101 Dodací listy. Takto upravený dotaz již proběhne v pořádku a požadovaný objekt (faktura vydaná) se vytvoří.

POST http://localhost/demo15/issuedinvoices/import/receivedorders HTTP/1.1
Host: localhost
Content-Type: application/json
Authorization: Basic QVBJOmFwaQ==
Cache-Control: no-cache
Postman-Token: ec6e4774-7468-46cf-ac0d-26d859ce962e
{
	"input_document_clsid": "ReceivedOrder",
	"output_document_clsid": "IssuedInvoice",
	"input_documents": "2500000101",
	"params": {
		"ImportDocuments": true,
		"UndeliveredQuantity": true,
		"DeliveryDate": "2018-06-27T15:57:00.000Z",
		"DocQueue_ID": "5600000101"
	},
	"output_document_update": {
		"StoreDocQueue_ID": "P600000101"
	}
}

Odpověď:

HTTP/1.1 201 Created
...

Následující příklad vytvoří daňový zálohový list přijatý z řádku bankovního výpisu.

POST http://localhost/data/import HTTP/1.1
Host: localhost
Content-Type: application/json
Authorization: Basic QVBJOmFwaQ==
Cache-Control: no-cache
Postman-Token: 81fc77e4-fb51-41e1-9f70-04f05b788e3f
{
	"input_document_clsid": "OBSCO4S1BRD13FY1010DELDFKK",
	"output_document_clsid": "ZJYWUH5I34J4VAAIHOB0ZA1FIO",
	"input_documents": "1700000101",
	"params": {
		"DocQueue_ID": "B700000101"
	}
}

1700000101 = ID řádku bankovního výpisu

B700000101 = ID řady daňových zálohových listů přijatých (DZP)

OBSCO4S1BRD13FY1010DELDFKK = packed GUID objektu řádek bankovního výpisu (BankStatementRow)

ZJYWUH5I34J4VAAIHOB0ZA1FIO = packed GUID objektu daňový zálohový list přijatý (VATReceivedDepositInvoice)

Nechť jsme si nadefinovali definovatelný číselník. Viz např. Vzorový postup přidání uživatelského číselníku. Nechť tento číselník má v položce Název kolekce ve WebAPI v DefRollEditoru hodnotu transportationcars. Dotaz na vrácení (GET) kolekce záznamů z tohoto číselníku:

GET http://localhost/data/transportationcars HTTP/1.1
Host: localhost
Authorization: Basic VGVzdDoxMjM=
Content-Length: 0

Dotaz na hodnotu ID uživatele:

POST http://localhost/data/qrexpr HTTP/1.1
Host: localhost
Authorization: Basic VGVzdDoxMjM=
Content-Length: 0

Vlastní výraz zapsaný v JSON formátu:

{
  "expr": "NxGetUserID"
}

Příklad výsledku: Status 200 OK

{
 "result": "SUPER00000"
}

Dotaz na název skladové karty se zadaným ID:

URL shodně jako v Příkladu 1.

Vlastní výraz zapsaný v JSON formátu:

{
  "expr": "NxGetValueFromRoll('StoreCards','Name','2100000101')"
}

Příklad výsledku: Status 200 OK

{
 "result": "Panasonic 65\" Class 4K Ultra HD TV"
}

Dotaz, zda určitý datum spadá na svátek:

URL shodně jako v Příkladu 1.

Vlastní výraz zapsaný v JSON formátu:

{
  "expr": "NxDayIsHoliday(NxStrToDate('1.1.2016'))"
}

Příklad výsledku: Status 200 OK

{
 "result": true
}

Použití NxSQL Select:

URL shodně jako v Příkladu 1.

Vlastní výraz zapsaný v JSON formátu:

{
  "expr": "NxSQLSelect('SELECT ID FROM FIRMS', '', ',', '\"')"
}

Příklad výsledku: Status 200 OK

{
 "result": "\"3200000101\",\"1100000101\",\"2000000101\",…"
}