Innkalling

Appointment

En digital post forsendelse kan berikes med innkalling datatypen som resulterer i en tilpasset innkallingsvisning i Digipost-kassen til mottaker. For eksempel vil mottaker kunne laste ned innkallingen i sin kalender og/eller se på kart hvor mottaker skal møte opp. En innkalling krever fortsatt selve dokumentet/filen og dokumentet/filen vil fortsatt vises i mottakers Digipost-kasse.

Enriching a digital mail message with the appointment data type will result in a special appointment presentation in the recipients Digipost mailbox. For example, the recipient will be able to add the appointment to her calendar and/or see where the appointment will take place in a map. The message still requires the actual file and the actual file will still be available for the recipient.

Endepunkt

Endpoint

https://api.digipost.no/messages

Verb

http post

Request

Headere og faktisk dokument innhold er ikke inkludert nedenfor. Bare XML metadata er inkludert. Se send endepunkt for eksempler på headere og multi-part forespørsler.

Headers and actual document content are not included below. Only XML metadata is included. See the send endpoint for examples of headers and multi-part requests.


<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<message xmlns="http://api.digipost.no/schema/v8">
    <recipient>
        <personal-identification-number>01043100358</personal-identification-number>
    </recipient>
    <primary-document>
        <uuid>316a26cd-4888-43a6-8875-3a2286b435fc</uuid>
        <subject>appointment-pdf-document</subject>
        <file-type>pdf</file-type>
        <data-type>
            <appointment xmlns="http://api.digipost.no/schema/datatypes">
                <start-time>2017-10-27T10:00:00+02:00</start-time>
                <end-time>2017-10-27T11:00:00+02:00</end-time>
                <arrival-time>Oppmøte senest 15 minutter før timen</arrival-time>
                <place>Oslo City Røntgen</place>
                <address>
                    <street-address>Storgata 23</street-address>
                    <postal-code>0011</postal-code>
                    <city>Oslo</city>
                </address>
                <sub-title>Undersøke smerter i ryggen</sub-title>
                <info>
                    <title>Informasjon om Oslo City Røntgen</title>
                    <text>Oslo City Røntgen er et spesialistsenter for avansert bildediagnostikk.</text>
                </info>
            </appointment>
        </data-type>
    </primary-document>
</message>

Response


<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<message-delivery xmlns="http://api.digipost.no/schema/v8">
    <delivery-method>DIGIPOST</delivery-method>
    <sender-id>497013</sender-id>
    <status>DELIVERED</status>
    <delivery-time>2016-12-07T08:45:32.675+01:00</delivery-time>
    <primary-document>
        <uuid>316a26cd-4888-43a6-8875-3a2286b435fc</uuid>
        <subject>appointment-pdf-document</subject>
        <file-type>pdf</file-type>
        <authentication-level>PASSWORD</authentication-level>
        <sensitivity-level>NORMAL</sensitivity-level>
        <pre-encrypt>false</pre-encrypt>
        <content-hash hash-algorithm="SHA256">5o0RMsXcgSZpGsL7FAmhSQnvGkqgOcvl5JDtMhXBSlc=</content-hash>
    </primary-document>
</message-delivery>