Dokumentaci pro REST API rozhraní, které poskytuje funkce pro přidávání dokumentů k objednávkám, nabídkám a reklamacím. Na straně klienta se používá Add-in doplněk do Office365, kterým se zavolá webová služba. ### Základní informace **API Endpoint**: `/dokumenty` **Metoda**: POST ==== 1. Přidání dokumentu k objednávce ==== - **URL**: `/dokumenty/add_docu_order` - **Metoda**: POST - **Přijímá**: JSON - **Vrací**: text/plain - **Parametry**: - **`OrderNumber`**: Číslo objednávky (povinný) - **`FileName`**: Název souboru (povinný) - **`Base64Content`**: Obsah souboru v Base64 (povinný) - **Popis**: Tato metoda přijímá JSON objekt s číslem objednávky, názvem souboru a obsahem souboru v Base64 a přidává dokument k objednávce. ==== 2. Přidání dokumentu k nabídce ==== - **URL**: `/dokumenty/add_docu_offer` - **Metoda**: POST - **Přijímá**: JSON - **Vrací**: text/plain - **Parametry**: - **`OfferNumber`**: Číslo nabídky (povinný) - **`FileName`**: Název souboru (povinný) - **`Base64Content`**: Obsah souboru v Base64 (povinný) - **Popis**: Tato metoda přijímá JSON objekt s číslem nabídky, názvem souboru a obsahem souboru v Base64 a přidává dokument k nabídce. ==== 3. Přidání dokumentu k reklamaci ==== - **URL**: `/dokumenty/add_docu_complaint` - **Metoda**: POST - **Přijímá**: JSON - **Vrací**: text/plain - **Parametry**: - **`ComplaintNumber`**: Číslo reklamace (povinný) - **`FileName`**: Název souboru (povinný) - **`Base64Content`**: Obsah souboru v Base64 (povinný) - **Popis**: Tato metoda přijímá JSON objekt s číslem reklamace, názvem souboru a obsahem souboru v Base64 a přidává dokument k reklamaci. ### Příklady použití (JSON formát): { "OrderNumber": "123456", "FileName": "dokument.pdf", "Base64Content": "JVBERi0xLjQKJeLjz9MKMyAwIG9iago8PC9UeXBl..." } ==== Chybové stavy ==== - **Popis**: V případě selhání operace se vrací odpověď s chybovým hlášením. - **Příklad**: `KO Exception message here` **Poznámka**: Můžete chtít doplnit informace o autentizaci a specifikovat HTTP kódy odpovědí pro úspěšné a neúspěšné operace.