Web API - Zpracování požadavků v mezipaměti (/serverstate)

Nejprve v mezipaměti vytvoříme novou fakturu vydanou.

Požadavek:

POST http://localhost:81/demodata/serverstate

Tělo požadavku:

{
        	 "cacheid": "xb1",
        	 "type": "create",
        	 "data": {
        		"object_data": {
        			"class": "issuedinvoices",
				    "firm_id": "F011000000",
        			"docqueue_id": "5600000101",
        			"storedocqueue_id": "P600000101",
        			"rows": [
        				 {
        					 "@temporaryid": "ID1",
        					 "rowtype": 0,
        					 "text": "testovaci radek",
        					 "division_id": "2100000101"
        				 },
        				 {
        					 "@temporaryid": "ID2",
        					 "rowtype": 3,
        					 "store_id": "2100000101",
        					 "storecard_id": "2100000101",
        					 "unitquantity": 10,
        					 "unitprice": 20.5,
        					 "division_id": "2100000101"
        				 }
        			]
        		}
        	 }
        }

V dalším kroku aktualizujeme popis na faktuře, upravíme existující řádek, další řádek smažeme a doplníme nový řádek.

Hodnoty objid, které začínají na NEW_, je, jak bylo řečeno výše, třeba získat z dat po předchozím kroku a doplnit tyto konkrétní hodnoty.

Požadavek:

POST http://localhost:81/demodata/serverstate

Tělo požadavku:

{
            "cacheid": "xb1",
            "type": "update",
            "data": {
                "class": "issuedinvoices",
		        "object_id": "NEW_FV_OID",
                "object_data": {
                    "description": "testovaci faktura",
                    "rows": [
                        {
                            "id": "NEW_ROW_OID_1",
                            "text": "zmena textu"
                        },
                        {
                            "@temporaryid": "ID4",
                            "rowtype": 0,
                            "text": "textovy radek c 2",
                            "division_id": "2100000101"
                        }
                    ]
                    "rows@delete": {
                        "IncludeIDs": [NEW_ROW_OID_3]
                    }
                }
            }
        }

V posledním kroku aktualizujeme položku unitquantity na řádku identifikovaném NEW_ROW_OID_2 a fakturu uložíme do databáze.

Požadavek:

POST http://localhost:81/demodata/serverstate

Tělo požadavku:

{
            "cacheid": "xb1",
            "type": "save",
            "data": {
                "class": "issuedinvoices",
		  "object_id": "NEW_FV_OID",
                "object_data": {
                    "rows": [
                        {
                            "id": "NEW_ROW_OID_2",
                            "unitquantity": 12
                        }
                    ]
                }
                    "query": {
                    "select": [
                        "id"
                    ]
                }
            }
        }

V tomto příkladu provedeme import objednávky přijaté do dokladu Dodací list.

Mějme čerpatelnou objednávku přijatou s ID 15C0000101.

Požadavek:

POST http://localhost:81/demodata/serverstate

Tělo požadavku:

{
    "cacheid": "xb1",
    "type": "import",
    "data": {
            "class": "billsofdelivery",
	        "import_data": {
            "input_document_clsid": "01CPMINJW3DL342X01C0CX3FCC",
            "output_document_clsid": "050I5SAOS3DL3ACU03KIU0CLP4",
            "input_documents": "15C0000101",
            "params": {
                "docqueue_id": "P600000101"
            }
        },
        "object_data": {},
        "query": {
            "select": [
                "ID"
            ]
        }
    }
}

Status: 200 OK

Výsledek zpracování dotazu:

{
    "data": {
        "ID": "49F0000101",
        "@meta": {
            "version": 1
        }
    }
}

V tomto příkladu vytvoříme v mezipaměti fakturu vydanou a následně vyfiltrujeme ID a kódy středisek z číselníku z druhého řádku této faktury pomocí typu fieldlookup.

Skript v jazyce Python:

import base64
import json
import sys

import requests
from http_constants.headers import HttpHeaders

session = requests.Session()
headers = {}
headers[HttpHeaders.CONTENT_TYPE] = HttpHeaders.CONTENT_TYPE_VALUES.json
headers[HttpHeaders.AUTHORIZATION] = "Basic " + (
	base64.urlsafe_b64encode(("Supervisor" + ":" + "").encode("utf-8"))
).decode("utf-8")

# uvolníme objekty z mezipaměti, aby bylo možné pouštět opakovaně
print("\ndiscard objects from cache:")
body = {"cacheid": "testFieldLookUp", "type": "discard"}
response = session.post(
	url="http://localhost:81/demodata/serverstate",
	headers=headers,
	json=body,
)
print(f"status code: {response.status_code}")
if response.status_code != 204:
	sys.exit(0)


# založíme novou fakturu vydanou se 2 řádky
print("\ncreate fv:")
body = {
	 "cacheid": "testFieldLookUp",
	 "type": "create",
	 "data": {
		"object_data": {
			"firm_id": "F011000000",
			"docqueue_id": "5600000101",
			"storedocqueue_id": "P600000101",
			"rows": [
				 {
					 "@temporaryid": "ID1",
					 "rowtype": 0,
					 "text": "testovaci radek",
					 "division_id": "2100000101"
				 },
				 {
					 "@temporaryid": "ID2",
					 "rowtype": 3,
					 "store_id": "2100000101",
					 "storecard_id": "2100000101",
					 "unitquantity": 10,
					 "unitprice": 20.5,
					 "division_id": "2100000101"
				 }
			]
		}
	 }
}

response = session.post(
	url="http://localhost:81/demodata/issuedinvoices/serverstate",
	headers=headers,
	json=body,
)
print(f"status code: {response.status_code}")
print("response body:")
print(json.dumps(response.json(), indent=2))

if response.status_code != 200:
	sys.exit(0)

resp = json.loads(response.content.decode("utf-8"))

# Získáme id vytvořené faktury vydané
oid = resp["data"]["id"]

rows = resp["data"].get("rows", [])

# Získáme id druhého řádku
row2_id = next((row["id"] for row in rows if row["@temporaryid"] == "ID2"), None)

# Nyní použijeme fieldlookup pro vyfiltrování id a kódů středisek z druhého řádku faktury
print("\nlook up division's IDs on the 2nd row:")
body = {
		  "cacheid": "testfieldLookUp",
		  "type": "fieldlookup",
		  "data": {
					"class": "issuedinvoices",
					"object_id": f"{oid}",
					"field": f"rows/id:{row2_id}/store_id",
					"query": {
							  "select": [
								"ID",
								"Code",
								"Name"
							  ]
					}
		  }
}
response = session.post(
	url="http://localhost:81/demodata/serverstate",
	headers=headers,
	json=body,
)
print(f"status code: {response.status_code}")
print("response body:")
print(json.dumps(response.json(), indent=2))

if response.status_code != 200:
	sys.exit(0)

Výsledek zpracování dotazu:

Status: 200 OK

[
	{
		"ID": "2100000101",
		"Code": "000",
		"Name": "Centrála"
	},
	{
		"ID": "1200000101",
		"Code": "100",
		"Name": "Prodej, služby"
	},
	{
		"ID": "2200000101",
		"Code": "200",
		"Name": "Restaurace Na vršku"
	},
	{
		"ID": "1300000101",
		"Code": "300",
		"Name": "Vývoj, výzkum"
	},
	{
		"ID": "1400000101",
		"Code": "400",
		"Name": "Výroba"
	},
	{
		"ID": "2400000101",
		"Code": "401",
		"Name": "Logistika a zásobování"
	},
	{
		"ID": "3400000101",
		"Code": "402",
		"Name": "Výroba  - dílna"
	}
]

V dalším příkladu si ukážeme volání funkce fieldlookup, která vrátí objednávky přijaté z dodacích listů, které je možné nastavit do parametru selectedheader.

Nejprve vytvoříme importního manažeru DL->FV

				{
    "cacheid": "cache",
    "type": "create",
    "data": {
        "class": "ZUMBGNJTXF44H4YIMBETLJJRQ0",
        "object_data": {
            "inputdocuments": [
                "59W1000101", "29Y1000101"
            ]
        },
        "query": {
            "select": [
                "id",
                "selectedheader"
            ]
        },
        "meta": {
            "validation": {
                "errors": true,
                "warnings": true
            },
            "objectdiff": {
                "includesource": true,
                "addjsonpath": true
            },
            "objectinfo": {
                "types": [
                    "canupdate",
                    "usableenums"
                ],
                "includebefore": true,
                "includeafter": true,
                "includepatch": true
            }
        }
    }
}

Volání funkce fieldlookup vrátí objednávky přijaté z dodacích listů které je možné nastavit do parametru selectedheader.

				{
    "cacheid": "cache",
    "type": "fieldlookup",
    "data": {
        "object_id": "CWZHRXCCDOY4VGKSAZCCMNCQ20",
        "field": "selectedheader",
        "class": "ZUMBGNJTXF44H4YIMBETLJJRQ0",
        "query": {
            "select": [
                "id",
                "displayname"
            ]
        }
    }
}

Příklad ukazuje vytvoření nové řady pro fakturu vydanou pomocí přidané sekce forreference, proto předáme jako vazební pole issuedinvoice, docqueue_id konkrétní faktury.

Do mezipaměti nahrajeme fakturu vydanou a poté si necháme vytvořit novou řadu, tak, aby přesně vyhovovala požadavkům na použití ve faktuře vydané. V sekci select jsme si zvolil, že z nové řady chceme jen tyto položky id, documenttype, code

Nejprve nahrajeme do keše serverstate fakturu vydanou

{
    "cacheid": "",
    "type": "load",
    "data": {
        "class": "issuedinvoices",
        "object_id": "3L50000101",
        "query": {
            "select": [
                "id"
            ]
        }
    }
}

Výsledek zpracování dotazu:

{
    "data": {
        "id": "3L50000101",
        "@meta": {
            "version": 1
        }
    }
}

Poté necháme vytvořit novou řadu, tak, aby přesně vyhovovala požadavkům na použití ve faktuře vydané. V sekci select jsme zvolili, že z nové řady chceme jen položky id, documenttype, code

{
    "cacheid": "",
    "type": "create",
    "data": {
        "class": "docqueues",
        "object_data": {},
        "forreference": {
            "class": "issuedinvoices",
            "object_id": "3L50000101",
            "field": "docqueue_id"
        },
        "query": {
            "select": [
                "id",
                "documenttype",
                "code"
            ]
        }
    }
}

Výsledek zpracování dotazu:

{
    "data": {
        "id": "2O70000101",
        "documenttype": "03",
        "code": "FV",
        "@meta": {
            "version": 1
        }
    }
}