xsd.api_v8.xsd Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of digipost-api-client-java Show documentation
Show all versions of digipost-api-client-java Show documentation
Java library for interacting with the Digipost REST API
Authentication-levels you may require the receiver to be authenticated with to read documents.
Note that IDPORTEN_3 and IDPORTEN_4 needs an explicit permission to use, and are intended for
government agencies. Using those levels while not being permitted to, will result in an error
response.
Default. Password is required to read the message.
Two factor authentication will be required to read it.
ID-porten level 3. Can only be used by government agencies.
ID-porten level 4. Can only be used by government agencies.
Default. Non sensitive message. Metadata about the message, like the sender and subject,
will be revealed in user notifications (eg. email and SMS), and can also be seen when logged in at a
security level below the one specified for the message.
Sensitive message. Metadata about the message, like the sender and subject, will be hidden
until logged in at the appropriate security level specified for the message.
Country name in Norwegian or English.
Country code according to the ISO 3166-1 alpha-2 standard.
The message resource is not complete. Consult the provided links to see what options are availiable.
The message resource is complete, and can be sent. Note that you can also tweak the message before sending it.
Consult the provided links to see what options are availiable.
The message is delivered. Consult the provided links to see what options are availiable.
The message is delivered to print. Consult the provided links to see what options are availiable.
Used as identifier for matching recipients that does not have a Digipost account
Fødselsnummer.
Organisasjonsnummer.
Bankkontonummer.
Fødselsnummer.
Organisasjonsnummer.
Bankkontonummer.
The sender of the message, i.e. what the receiver of the message sees as
the sender of the message. If the originating message has specified no sender-id nor
sender-organization, it will be set to the broker-id which was specified in the
X-Digipost-UserId header of the initiating request.
Indicates if the document has already been opened
Optional SMS notification to Recipient.
Additional charges apply.
Optional email notification to recipient.
Sender will encrypt the letter with the receivers public key before sending it.
The actual sender of the message. This is used in scenarios where one party, the broker, is creating a message
on behalf of another, the sender. It is only possible if the sender has granted the broker the right to send
on its behalf.
The delivery time of the message as it appears in the receiver's mail box.
The use of this field is limited to those with explicit permission. If set in the
future, the message will not appear until the set time. Historical delivery-time is not allowed.
The actual sender of the message. This is used in scenarios where one party, the broker, is creating a message
on behalf of another, the sender. It is only possible if the sender has granted the broker the right to send
on its behalf. The use of this type is limited to those with explicit permission. Consists of a Norwegian
organization identifier and an optional part-id identifying a unit within your organization.
Mobile number for notifying the receiver by SMS text message.
The text to be used in the notification.
If the message is unread, a notification will be sent at these times.
SMS is only sent between 9-20. Any notification falling outside this interval, will be sent around 9 the next morning.
If the message is unread, a notification will be sent after the given amount of hours after delivery.
SMS is only sent between 9-20. Any notification falling outside this interval, will be sent around 9 the next morning.
Email address for notifying the receiver.
The subject to be used for the notification.
The text to be used for the notification.
If the message is unread, a notification will be sent at these times.
No information about the requested sender could be retrieved. This may either be
because the sender does not exist, or the broker is not authorized to send on behalf
of the sender.
The sender exists in Digipost, and the broker is authorized to act on behalf of the sender
(typically send messages).
A non-exhaustive list of features. The possible reported features may be expanded at any time,
and clients must as such be built to discard values which are unknown. The elements should
be regarded as means to query "is [some feature] available?".
Please consult the documentation]]>
for possible values and their semantics.
The actual sender of the message. This is used in scenarios where one party, the broker, is creating a message
on behalf of another, the sender, which is only possible if the sender has granted the broker the right to send
on its behalf.
Only relevant for the web-channel, i.e. . When an opening receipt is requested by the sender, this value indicates(Y/N) whether the receiver has
read the letter or not. This attribute is empty if no opening receipt has been requested.
A UUID (Universally unique identifier). This ID must be globally unique for the sender.
With Java, a UUID can be created using UUID.randomUUID(), whereas
System.Guid.NewGuid() can be used in .NET C#.
Norwegian national identity number (fødselsnummer)
The actual sender of the message. This is used in scenarios where one party, the broker, is creating a message
on behalf of another, the sender. It is only possible if the sender has granted the broker the right to send
on its behalf.
The actual sender of the message. This is used in scenarios where one party, the broker, is creating a message
on behalf of another, the sender. It is only possible if the sender has granted the broker the right to send
on its behalf.
The batch is created and is ready to receive documents.
The batch has received documents and can receive more documents.
The batch has been committed and documents are being processed. The batch can not receive any more documents.
The batch has finished processing. Final statistics can now be fetched.
A tag which indicates that the corresponding account
for the provided personal-identification-number should
receive public mail through Digipost
Fødselsnummer.
The account receives public mail through Digipost.