Correspondences

GET

Get correspondence via ID

/rest/correspondences/correspondence/5

Get for correspondence ID 5

Example result

<?xml version="1.0" encoding="UTF-8"?>
<xml>
    <id>5_7</id>
    <project_id>91</project_id>
    <correspondence_id>5</correspondence_id>
    <address_id>92</address_id>
    <correspondence_type_id>88</correspondence_type_id>
    <subject>Hallo</subject>
    <file>hallo_5.xlsx</file>
    <security>3</security>
    ...
</xml>

POST/PUT

Add a new correspondence

/rest/correspondences/correspondence

Add new

Example request body

project=91&type=91&address=92&subject=Hallo&file=/Library/WebServer/Documents/upload1.png

Example result

<?xml version="1.0" encoding="UTF-8"?>
<xml>
    <url>.../rest/correspondences/correspondence/6</url>
</xml>

Possible values

Field	Description	Valid Values	German Name
project	Project ID	required,integer	Projekt
address	Address ID	required,integer	Adresse
type	Correspondence type ID	required,integer	Art
subject	Subject	required	Betrifft
file	File path - Will be copied into the correct place according to project and type ¹⁾	required	Datei
work_area	Optional Work Area ID	integer	Bereich
date	Optional Date	us_date	Datum
staff_id	Optional Staff ID to save for	integer	Mitarbeiter
is_valid	Optional Valid	boolean (true, false)	Gültig
search_text	Optional Search text of document. Will otherwise be read from the document, if possible.		Text für die Volltextsuche

¹⁾

You can use empty.txt for testing only. This creates an empty file only. From X.1 10196