Read imprint

Resource type: impressum

Reads the imprint in enterprise (Extras >> Settings >> Basic settings). If the user is a member of an office group, the imprint of the office group is retrieved (Extras >> Settings >> Groups >> Tab basic data).

Parameter:

  • data
    ARRAY. Data. The fields you want to query. If data is not set, all fields will be returned. The following fields can be queried: title, firstname, lastname, firma, postcode, city, street, housenumber, state, country, phone, mobil, fax, email, homepage, vertretungsberechtigter, berufsaufsichtsbehoerde, handelsregister, handelsregisterNr, ustId, bank, iban, bic, chamber.
  • language
    STRING. Default = user language. Language in format ISO-3166-1, e.g. DEU, ENG. If language is set, the fields “title” (Anrede) and “country” are returned in the specified language.
  • formatoutput
    BOOLEAN. Default = false. If set on true, the field “country” will return the country name. If set on false, the field “country” will return the 3 letter ISO-3166-1 country code.

Example:

...
{
    "actionid": "urn:onoffice-de-ns:smart:2.5:smartml:action:read",
    "resourceid": "",
    "identifier": "",
    "resourcetype": "impressum",
    "parameters": {
        "data": [
            "title",
            "firstname",
            "lastname",
            "firma",
            "country"
        ],
        "language": "ENG",
        "formatoutput": true
    }
}
...

Response:

...
{
    "status": {
        "code": 200,
        "errorcode": 0,
        "message": "OK"
    },
    "response": {
        "results": [
            {
                "actionid": "urn:onoffice-de-ns:smart:2.5:smartml:action:read",
                "resourceid": "",
                "resourcetype": "impressum",
                "cacheable": true,
                "identifier": "",
                "data": {
                    "meta": {
                        "cntabsolute": null
                    },
                    "records": [
                        {
                            "id": "impressum",
                            "type": null,
                            "elements": {
                                "title": "Mr.",
                                "firstname": "Max",
                                "lastname": "Mustermann",
                                "firma": "onOffice GmbH",
                                "country": "Germany"
                            }
                        }
                    ]
                },
                "status": {
                    "errorcode": 0,
                    "message": "OK"
                }
            }
        ]
    }
}
...