ISDS.H(3)

✨ isds.h(3) — API definition for libisds ✨

manual for Libisds · part 1 of 3 · bestie we are SO doing this 💅

---

🌸 NAME 🌸

isds.h — API definition for libisds.

---

✨ SYNOPSIS ✨

#include <isds.h>

---

💅 DESCRIPTION 💅

This header file declares the inteface for the libisds library.

---

🎀 CONSTANTS 🎀

💖 Service locators 💖

Addresses of known ISDS servers.

🌈 Base URLs of production ISDS instance 🌈

• isds_locator

extern const char isds_locator[];

Without client certificate authentication.

• isds_cert_locator

extern const char isds_cert_locator[];

With client certificate authentication.

• isds_otp_locator

extern const char isds_otp_locator[];

Without OTP authentication.

🌈 Base URLs of testing ISDS instance 🌈

• isds_testing_locator

extern const char isds_testing_locator[];

Without client certificate authentication.

• isds_cert_testing_locator

extern const char isds_cert_testing_locator[];

With client certificate authentication.

• isds_otp_testing_locator

extern const char isds_otp_testing_locator[];

Without OTP authentication.

---

🦋 DATA TYPES 🦋

🫶 struct isds_ctx 🫶

struct isds_ctx;

Context for specific ISDS box.

🫶 isds_error 🫶

typedef enum isds_error;

Error code. Known values:

• IE_SUCCESS — No error. Numeric value 0.
• IE_ERROR — Unspecified error.
• IE_NOTSUP — Operation is not supported.
• IE_INVAL — Invalid value.
• IE_INVALID_CONTEXT — The context is not valid.
• IE_NOT_LOGGED_IN — The context has not been logged in.
• IE_CONNECTION_CLOSED — Network connection has been closed.
• IE_TIMED_OUT — Time limit for network operation exceeded.
• IE_NOEXIST — Requested entity does exist.
• IE_NOMEM — Not enough memory.
• IE_NETWORK — Network error.
• IE_HTTP — Error on HTTP level.
• IE_SOAP — Error on SOAP level.
• IE_XML — Error on XML level.
• IE_ISDS — Problem with ISDS server.
• IE_ENUM — Invalid enum value.
• IE_DATE — Invalid date value.
• IE_2BIG — Value is too big.
• IE_2SMALL — Value is too small.
• IE_NOTUNIQ — Value is not uniq.
• IE_NOTEQUAL — Compared values are not equal.
• IE_PARTIAL_SUCCESS — Operation on a vector succeeded for some values, but failed for others.
• IE_ABORTED — Operation was aborted by application request.
• IE_SECURITY — Security requirements were not satisfied.

🫶 isds_log_level 🫶

typedef enum isds_log_level;

Log level. Known values:

• ILL_NONE — 0
• ILL_CRIT — 10
• ILL_ERR — 20
• ILL_WARNING — 30
• ILL_INFO — 40
• ILL_DEBUG — 50
• ILL_ALL — 100

🫶 isds_log_facility 🫶

typedef enum isds_log_facility;

Log facility. Known values:

• ILF_NONE — 0x0
• ILF_HTTP — 0x1
• ILF_SOAP — 0x2
• ILF_ISDS — 0x4
• ILF_FILE — 0x8
• ILF_SEC — 0x10
• ILF_XML — 0x20
• ILF_ALL — 0xFF

🫶 isds_option 🫶

typedef enum isds_option;

libisds option identifiers. Known values:

• IOPT_TLS_VERIFY_SERVER — Option type is _Bool. Whether to verify server identity. Default value is true.
• IOPT_TLS_CA_FILE — Option type is char *. Option value is a file name with certificate authority certificates. Default value depends on used cryptographic library.
• IOPT_TLS_CA_DIRECTORY — Option type is char *, Option value is a directory with certificate authority certificates. Default value depends on used cryptographic library.
• IOPT_TLS_CRL_FILE — Option type is char *. Option value is a file name with certificate revocation list in PEM format. Default value depends on used cryptographic library.
• IOPT_NORMALIZE_MIME_TYPE — Option type is _Bool. Whether to normalize MIME type values. Default value is false.

🫶 isds_tls_option 🫶

typedef enum isds_tls_option;

Warning — This type is deprecated.

TLS libisds option identifiers. Known values:

• ITLS_VERIFY_SERVER — Option type is _Bool. Whether to verify server identity.
• ITLS_CA_FILE — Option type is char *. Option value is a file name with certificate authority certificates.
• ITLS_CA_DIRECTORY — Option type is char *. Option value is a directory name with certificate authority certificates.
• ITLS_CRL_FILE — Option type is char *. Option value is a file name with certificate revocation list in PEM format.

🫶 isds_pki_format 🫶

typedef enum isds_pki_format;

Cryptographic material encoding. Known values:

• PKI_FORMAT_PEM — PEM format.
• PKI_FORMAT_DER — DER format.
• PKI_FORMAT_ENG — The material is stored in a cryptographic engine.

🫶 struct isds_pki_credentials 🫶

struct isds_pki_credentials;

This structure holds public key infrastructure cryptographic material to authenticate a client. Members are:

• char *engine; — String identifier of cryptographic engine to use (where key is stored). Use NULL for no engine.
• isds_pki_format certificate_format; — Certificate format.
• char *certificate; — A path to client certificate, or a certificate nickname in case of NSS as curl back-end, or key slot identifier inside cryptographic engine. Some cryptographic engines can pair certificate with key automatically (NULL value).
• isds_pki_format key_format; — Private key format.
• char *key; — A path to client private key, or key identifier in case an engine is used.
• char *passphrase; — Zero terminated string with password for decrypting private key, or engine PIN. Use NULL for no pass-phrase or to let the engine to ask for it.

🫶 isds_otp_method 🫶

typedef enum isds_otp_method;

One-time password authentication method. Known values:

• OTP_HMAC — HMAC-based OTP method.
• OTP_TIME — Time-based OTP method.

🫶 isds_otp_resolution 🫶

typedef enum isds_otp_resolution;

One-time password authentication resolution. Known values:

• OTP_RESOLUTION_SUCCESS — Authentication succeeded.
• OTP_RESOLUTION_UNKNOWN — Status is unknown.
• OTP_RESOLUTION_BAD_AUTHENTICATION — Bad log-in. You can retry to log in.
• OTP_RESOLUTION_ACCESS_BLOCKED — Access blocked for 60 minutes. (Because a brute force attack was detected.)
• OTP_RESOLUTION_PASSWORD_EXPIRED — Password has expired.

Note — It's not clear which password expired: OTP or regular password?

• OTP_RESOLUTION_TO_FAST — OTP cannot be sent repeatedly at this rate. (Minimal delay depends on TOTP window setting.)
• OTP_RESOLUTION_UNAUTHORIZED — User name is not allowed to access requested URI.
• OTP_RESOLUTION_TOTP_SENT — OTP has been generated and sent by the ISDS to the user.
• OTP_RESOLUTION_TOTP_NOT_SENT — OTP could not been sent by the ISDS. Retry later.

🫶 struct isds_otp 🫶

struct isds_otp;

This structure holds one-time password when authenticating a client and resolution of the authentication.

Input members are:

• isds_otp_method method; — Select OTP method to use.
• char *otp_code; — One-time password to use. Pass NULL, if you do not know it yet (e.g. in case of first phase of time-based OTP authentication to request new code from ISDS.)

Output members are:

• isds_otp_resolution resolution; — Fine-grade resolution of this OTP authentication attempt.

🫶 isds_DbType 🫶

typedef enum isds_DbType;

Box type. It classifies box owner by his legal status. Known values:

• DBTYPE_OVM_MAIN — This is a special value for isds_find_box_by_fulltext. It's not accepted by any other services.
• DBTYPE_SYSTEM — This is a special value for sender of messages sent by the ISDS. You can find it only in incomming messages. It's not accepted by any other services.
• DBTYPE_OVM — Standard government (state or municipality or similar) office.
• DBTYPE_OVM_NOTAR — Notary (stopped being used, replaced with OVM_PFO).
• DBTYPE_OVM_EXEKUT — Executor (stopped being used, replaced with OVM_PFO).
• DBTYPE_OVM_REQ — Subsidiary office with OVM (governing) status assigned on request (section 6 and 7 of the act).
• DBTYPE_OVM_FO — Natural person with OVM status (without identification number).
• DBTYPE_OVM_PFO — Natural person in business with OVM status (e.g. notary or executor).
• DBTYPE_OVM_PO — Juridical person with OVM status (arisen from previously existing PO or PO_REQ).
• DBTYPE_PO — Standard commercial organization (listed in trade registry).
• DBTYPE_PO_ZAK — Other organization founded by an act (stopped being used, replaced with PO).
• DBTYPE_PO_REQ — An organization with a box assigned on its request.
• DBTYPE_PFO — Person in business.
• DBTYPE_PFO_ADVOK — Lawyer.
• DBTYPE_PFO_DANPOR — Tax consultant.
• DBTYPE_PFO_INSSPR — Administrator of insolvency.
• DBTYPE_PFO_AUDITOR — Statutory auditor.
• DBTYPE_FO — Standard person.

Some interfaces refer to gross box type. These are the shortest names of the identifiers. For example, DBTYPE_OVM is a gross type for DB_OVM_NOTAR or DBTYPE_OVM. But not for DBTYPE_PO.

🫶 isds_DbState 🫶

typedef enum isds_DbState;

Box status from point of view of accessibility. Known values:

• DBSTATE_ACCESSIBLE — The box is accessible.
• DBSTATE_TEMP_UNACCESSIBLE — The box is temporarily inaccessible (at the request of the user).
• DBSTATE_NOT_YET_ACCESSIBLE — The box has not yet been activated.
• DBSTATE_PERM_UNACCESSIBLE — The box is permanently inaccessible.
• DBSTATE_REMOVED — The box has been removed.
• DBSTATE_TEMP_UNACCESSIBLE_LAW — The box is temporarily inaccessible (because of the reasons enumerated in the law).

🫶 isds_priviledges 🫶

typedef enum isds_priviledges;

Distinct user permissions from point of view of ISDS. Instances can be bitmaps of any of these distinct values. Distinct known values are:

• PRIVIL_READ_NON_PERSONAL — The user can download and read messages with dmPersonalDelivery equaled to false.
• PRIVIL_READ_ALL — The user can download and read messages with dmPersonalDelivery equaled to true.
• PRIVIL_CREATE_DM — The user can create and send messages, the user can download outgoing (sent) messages.
• PRIVIL_VIEW_INFO — The user can list messages and read data about a message post and delivery.
• PRIVIL_SEARCH_DB — the user can search for boxes 🔍 like, they get to go looking through the box directory.
• PRIVIL_OWNER_ADM — the user can administer their own box: adding and removing permitted users, and tweaking those users' permissions. Main character admin energy 👑.
• PRIVIL_READ_VAULT — the user can read messages stored in the long term storage (the vault, the archives, the ✨vault✨).

Note: this permission has not been used since 2012-05. Not me calling it retro 💀 it's just literally unused.

• PRIVIL_ERASE_VAULT — the user can delete messages from the long term storage. Poof, gone, into the void 🫠.

---

🌸 isds_message_status 🌸

typedef enum isds_message_status;

Message status, bestie. The states a message can be in. Here's the whole roster, no skips:

• MESSAGESTATE_SENT — the message has been put into ISDS. It's out there now 🦋.
• MESSAGESTATE_STAMPED — the message was stamped by a time stamp authority. Official. Certified. Slay ⭐.
• MESSAGESTATE_INFECTED — the message included viruses 😭 and the infected documents have been removed from the message.
• MESSAGESTATE_DELIVERED — the message was delivered. (dmDeliveryTime is populated.)
• MESSAGESTATE_SUBSTITUTED — the message was delivered through fiction, and dmAcceptanceTime is populated. (Yes, "through fiction" — it's a legal-delivery thing, iykyk.)
• MESSAGESTATE_RECEIVED — the message was accepted, either by the user's log-in or by the user's explicit request. dmAcceptanceTime is populated.
• MESSAGESTATE_READ — the message has been read by a user 👀.
• MESSAGESTATE_UNDELIVERABLE — the message could not be delivered. (E.g. the recipient's box has been made inaccessible in the meantime.) L for the sender fr 😔.
• MESSAGESTATE_REMOVED — the message's content was deleted.
• MESSAGESTATE_IN_SAFE — the message is stored in the long term storage. Safe and sound 🧚.

The values can be combined into a bit mask for some functions. And a special MESSAGESTATE_ANY macro denotes any of the states — a little "any of the above" energy ✨.

---

🔥 isds_hash_algorithm 🔥

typedef enum isds_hash_algorithm;

Hash algorithm types, the whole fam:

• HASH_ALGORITHM_MD5 — MD5.
• HASH_ALGORITHM_SHA_1 — SHA-1.
• HASH_ALGORITHM_SHA_224 — SHA-224.
• HASH_ALGORITHM_SHA_256 — SHA-256.
• HASH_ALGORITHM_SHA_384 — SHA-384.
• HASH_ALGORITHM_SHA_512 — SHA-256. (Yeah. That's what the page says. I am simply the messenger 💀)

---

🎀 isds_buffer_strategy 🎀

typedef enum isds_buffer_strategy;

Buffer storage strategy. This type is basically the rules of the road for how a function should embed an application-provided buffer into the raw element of an output structure. Known values:

• BUFFER_DONT_STORE — don't fill the raw member. Just vibes, no data.
• BUFFER_COPY — copy the buffer content into a newly allocated raw member. Fresh copy, freshly allocated 🫶.
• BUFFER_MOVE — copy the pointer. Deallocation is left to the structure destructor (isds_*_free()). So like, hand it over, it's theirs now, they clean up.

---

💜 struct isds_hash 💜

struct isds_hash;

This is a hash value storage. Members:

• isds_hash_algorithm algorithm; — the hash algorithm.
• size_t length; — hash value length in bytes.
• void *value; — hash value as a byte stream.

---

🌸 struct isds_PersonName 🌸

struct isds_PersonName;

Name of a person. Members:

• char *pnFirstName; — first name.
• char *pnMiddleName; — middle name.
• char *pnLastName; — current last name.
• char *pnLastNameAtBirth; — last name at birth.

---

🌈 struct isds_BirthInfo 🌈

struct isds_BirthInfo;

Date and place of a birth. Members:

• struct tm *biDate; — date of birth in local time at the birth place. Only the tm_year, tm_mon and tm_mday members of the struct tm carry a sane value. The others are undefined — do not trust them, do not look at them 🙈.
• char *biCity; — city where a person was born.
• char *biCounty; — region where a person was born. This is the kind of region that is called Bezirk in German and okres in Czech.
• char *biState; — state where a person was born.

---

🦋 struct isds_Address 🦋

struct isds_Address;

Postal address. Members:

• char *adCity; — city.
• char *adStreet; — street.
• char *adNumberInStreet; — identification of an entrance on the street. Číslo orientační in Czech.
• char *adNumberInMunicipality; — identification of a building in the municipality. Číslo popisné in Czech.
• char *adZipCode; — postal code for mail routing 📬.
• char *adState; — state.

---

⭐ struct isds_DbOwnerInfo ⭐

struct isds_DbOwnerInfo;

Data about a box and its owner. NULL pointer values mean undefined values. Members:

• char *dbID; — box identifier. The specification limits the length to 7 characters.
• isds_DbType *dbType; — box type.
• char *ic; — identifier of the owner.
• isds_PersonName *personName; — name of a person owning the box.
• char *firmName; — name of a firm owning the box.
• isds_BirthInfo *birthInfo; — birth details of the person.
• isds_Address *address; — postal address of the owner.
• char *nationality; — nationality of the owner.
• char *email; — e-mail address of the owner.
• char *telNumber; — telephone number of the owner.
• char *identifier; — external box identifier for data provider (OVM, PO, maybe PFO box types). The specification limits the length to 20 characters.
• char *registryCode; — PFO external registry code. The specification limits the length to 5 characters.
• long int *dbState; — box state. 1 means the box is active ✅.

Note: the type is long int because the specification declares it as xsd:integer.

Note: TODO: enum?

• _Bool *dbEffectiveOVM; — the box has OVM role (section 5a of the act).
• _Bool *dbOpenAddressing; — this non-OVM box is free to receive messages from anybody. Open inbox, no gatekeeping 💌.

---

👑 isds_UserType 👑

typedef enum isds_UserType;

User type. Known values:

• USERTYPE_PRIMARY — owner of the box.
• USERTYPE_ENTRUSTED — user with limited access to the box.
• USERTYPE_ADMINISTRATOR — user who can manage USERTYPE_ENTRUSTED users.
• USERTYPE_OFFICIAL — ???
• USERTYPE_OFFICIAL_CERT — ???
• USERTYPE_LIQUIDATOR — company liquidator.
• USERTYPE_RECEIVER — company receiver.
• USERTYPE_GUARDIAN — legal guardian.

---

💅 struct isds_DbUserInfo 💅

struct isds_DbUserInfo;

Data about a user. NULL pointer values mean undefined values. Members:

• char *userID; — user identifier. The specification limits the length from 6 to 12 characters.
• isds_UserType *userType; — user type.
• long int *userPrivils; — set of user permissions.
• isds_PersonName *personName; — name of the user.
• isds_Address *address; — postal address of the user.
• struct tm *biDate; — date of birth in local time. Only the tm_year, tm_mon and tm_mday members of the struct tm carry a sane value. The others are undefined 🙈.
• char *ic; — identifier of a supervising firm. The specification limits the length to 8 characters.
• char *firmName; — name of a supervising firm. The specification limits the length to 100 characters.
• char *caStreet; — contact address. Street and number.
• char *caCity; — Czech city of the contact address.
• char *caZipCode; — postal code of the contact address.
• char *caState; — abbreviated country of the contact address. This value is optional and the implicit meaning is CZ.

---

🍓 isds_event_type 🍓

typedef enum isds_event_type;

Message event type. Known values:

• EVENT_UKNOWN — event unknown to this library. (That's the spelling, bestie, it's UKNOWN in the code and it stays that way.)
• EVENT_ACCEPTED_BY_RECIPIENT — the message has been delivered and accepted by a recipient action.
• EVENT_ACCEPTED_BY_FICTION — the message has been delivered, the acceptance period timed out, and the message is considered as accepted.
• EVENT_UNDELIVERABLE — the recipient box was made inaccessible, so the message is undeliverable 😭.
• EVENT_COMMERCIAL_ACCEPTED — the recipient confirmed acceptance of this commercial message.
• EVENT_ENTERED_SYSTEM — the message entered the ISDS system, i.e. it has just been sent by a sender. Fresh out the gate 🦋.
• EVENT_DELIVERED — the message has been delivered into the recipient's box.
• EVENT_PRIMARY_LOGIN — primary user logged into the recipient's box.
• EVENT_ENTRUSTED_LOGIN — an entrusted user with the capability to read logged into the recipient's box.
• EVENT_SYSCERT_LOGIN — an application authenticated by a system certificate logged into the recipient's box.

---

✨ struct isds_event ✨

struct isds_event;

An event that happened in a message's life. All members are optional. Members:

• struct timeval *time; — when the event occurred.
• isds_event_type *type; — type of the event.
• charr *description; — human-readable event description generated by the ISDS system. (Very probably in Czech language.) Yeah, it says charr up there. We keep it. No cap 💀.

---

🧚 struct isds_envelope 🧚

struct isds_envelope;

Message envelope. This is the metadata about a message. It does not contain the message documents.

Warning: be aware that the string length constraints are forced only on output members transmitted to the ISDS. The other direction (downloading from the ISDS) can break these rules. It should not happen, but nobody knows how much incompatible new version of the ISDS protocol will be. This is the gold Internet rule: be strict on what you send, be tolerant on what you receive. 🫶

The following members apply to incoming messages only:

• char *dmID; — message identifier. Maximal length is 20 characters.
• char *dbIDSender; — box identifier of the sender. The special value aaaaaaa means the message was sent by the ISDS system. Not by another user. Maximal length is 7 characters.
• char *dmSender; — sender's name. Maximal length is 100 characters.
• char *dmSenderAddress; — postal address of the sender. Maximal length is 100 characters.
• long int *dmSenderType; — gross box type of the sender. You can use isds_DbType to enumerate some known box types. This is a generic integer because the protocol keeps the value unconstrained and the library must support any syntactically correct value.
• char *dmRecipient; — recipient's name. Maximal length is 100 characters.
• char *dmRecipientAddress; — postal address of the recipient. Maximal length is 100 characters.
• _Bool *dmAmbiguousRecipient; — the recipient has OVM role.

The following members are assigned by the ISDS in different phases of the message life cycle:

• unsigned long int *dmOrdinal; — ordinal number in the list of incoming/outgoing messages.
• isds_message_status *dmMessageStatus; — message state.
• long int *dmAttachmentSize; — size of message documents in kilobytes. The value is rounded.
• struct timeval *dmDeliveryTime; — the time of delivering the message into the recipient's box. It will be NULL if the message has not been delivered yet.
• struct timeval *dmAcceptanceTime; — the moment the recipient accepted the message. It's NULL if the message hasn't been accepted yet, bestie. No cap.
• struct isds_hash *hash; — the message digest. It's a hash of a substring representing the isds:dmDM XML subtree. You can use isds_compute_message_hash to compute a hash of the message and then compare it against this struct member using isds_hash_cmp. Iconic hash behavior.
• void *timestamp; — a binary image of a qualified time stamp of the hash value. The time stamp is provided by the ISDS system. Messages that haven't been stamped yet will have this value NULL. Not me waiting for my timestamp.
• size_t timestamp_length; — length of the timestamp value in bytes.
• struct isds_list *events; — events the message passed through. It's a list of isds_event structures. Track the journey, periodt.

These next ones apply to both outgoing and incoming messages, fr fr:

• char *dmSenderOrgUnit; — sender's organisation unit as a string. This is optional.
• long int *dmSenderOrgUnitNum; — sender's organisation unit as a number. This is optional.
• char *dbIDRecipient; — recipient's box identifier. This is mandatory. Maximal length is 7 characters. You can't skip this one, bestie.
• char *dmRecipientOrgUnit; — recipient's organisation unit as a string. This is optional.
• long int *dmRecipientOrgUnitNum; — recipient's organisation unit as a number. This is optional.
• char *dmToHands; — a person in recipient's organisation. This is optional.
• char *dmAnnotation; — a subject (title) of the message. Maximal length is 255 characters.
• char *dmRecipientRefNumber; — Czech: číslo jednací příjemce. This is optional. Maximal length is 50 characters.
• char *dmSenderRefNumber; — Czech: číslo jednací odesílatele. This is optional. Maximal length is 50 chars.
• char *dmRecipientIdent; — Czech: spisová značka příjemce. This is optional. Maximal length is 50 characters.
• char *dmSenderIdent; — Czech: spisová značka odesílatele. This is optional. Maximal length is 50 chars.

The next five members constitute a reference to an item from the Czech Act Collection. The human-readable reference looks like Point (Paragraph) § Section Law/Year Coll. These members apply to both incoming and outgoing messages:

• long int *dmLegalTitleLaw; — a number of an act mandating the authority.
• long int *dmLegalTitleYear; — a year of issuing the act mandating the authority.
• char *dmLegalTitleSect; — a section of the act mandating the authority. Czech: paragraf.
• char *dmLegalTitlePar; — a paragraph of the act mandating the authority. Czech: odstavec.
• char *dmLegalTitlePoint; — a point of the act mandating the authority. Czech: písmeno.

Other incoming/outgoing message members, because there's always more:

• _Bool *dmPersonalDelivery; — if true, only a person with higher privileges can read this message. VIP only, iykyk.
• _Bool *dmAllowSubstDelivery; — allow delivery through fiction. I.e. even if the recipient did not read this message, the message is considered as delivered after (currently) 10 days. This is called delivery through fiction. Only OVM dbType senders can set it. 10 days? The audacity.
• char *dmType; — message type (commercial subtypes or government message).
  • Input values (when sending the message):
    • "I" — a commercial message offering paying the response (initiatory message). It's necessary to define dmSenderRefNumber member.
    • "K" — a commercial message paid by the sender.
    • "O" — a commercial response paid by the sender of a initiatory message. It's necessary to copy a value from the dmSenderRefNumber of the initiatory message to the dmRecipientRefNumber of this message.
    • "V" — a noncommercial government message. This is the default meaning if the value is undefined while sending a message.
  • Output values (when retrieving the message):
    • "A" — this is a subsidized initiatory commercial message which can pay a response.
    • "B" — this is a subsidized initiatory commercial message which has already paid the response.
    • "C" — this is a subsidized initiatory commercial message where the response offer has expired.
    • "D" — this is an externally subsidized commercial message.
    • "E" — this is a commercial message prepaid by a stamp.
    • "G" — this is a commercial message paid by a sponsor.
    • "I" — see the input values.
    • "K" — see the input values.
    • "O" — see the input values.
    • "V" — see the input values.
    • "X" — this is an initiatory commercial message where the response offer has expired.
    • "Y" — this is an initiatory commercial message which has already paid the response.
    • "Z" — this is limitedly subsidized commercial message.
  • Length of the value is exactly 1 UTF-8 character if defined. That means it's still a zero-terminated character string. One character, but make it iconic.

These members apply to outgoing messages only, bestie:

• _Bool *dmOVM; — OVM sending mode. Non-OVM dbType boxes that have dbEffectiveOVM equal to true MUST select between true (OVM mode) and false (non-OVM mode). Otherwise the value is optional and the default value is true. MUST, no cap.
• _Bool *dmPublishOwnID; — to allow revealing sender's login name. The name will be available to the recipient through isds_get_message_sender function. The sender's box type and identifier will be always available. This feature exists because more users can have access to one box and the recipient could not tell who was the sender. This value is optional. Default value is false. Optional, default false, stay mysterious if you want.

🦋 isds_FileMetaType 🦋

typedef enum isds_FileMetaType;

Document type from the point of view of the hierarchy of documents in a message. Known values are:

• FILEMETATYPE_MAIN — main document. There should be exactly one document of this type in a message. Exactly one, periodt.
• FILEMETATYPE_ENCLOSURE — an appendix. If a message has more documents, generic-purpose documents other than the main one should have this type.
• FILEMETATYPE_SIGNATURE — digital signature. This document is a signature of another document in the message.
• FILEMETATYPE_META — XML document for electronic document information system, elektronická spisová služba (ESS) in Czech, purpose.

🌸 struct isds_document 🌸

struct isds_document;

A message document. Members are:

• _Bool is_xml; — true if the document is an ISDS XML document. False if the document is an ISDS binary document.
• xmlNodePtr xml_node_list; — XML node-set presenting the XML document content. This is a pointer to the first XML node of the XML representation of the message as stored in the xml member of isds_message structure. Use children and next members to walk through the document. See libxml2 library documentation for more details. The xml_node_list will be NULL if the document is empty. It's valid only if is_xml is true.
• void *data; — a binary document content. The encoding and format depends on dmMimeType member value. This is valid only if is_xml is false.
• size_t data_length; — length of the data buffer in bytes. It's valid only if is_xml is false.
• char *dmMimeType; — MIME type of document. This member is mandatory.
• isds_FileMetaType dmFileMetaType; — document type to create document hierarchy inside a message.
• char *dmFileGuid; — message-local document identifier. It can be used as a key to refer to this document by dmUpFileGuid member from a different document. This is optional.
• char *dmUpFileGuid; — a reference to upper document identifier stored in dmFileGuid member of a different document. You can use isds_find_document_by_id function to locate the upper document. This value is optional.
• char *dmFileDescr; — document name (title). E.g. a file name. This value is mandatory.
• char *dmFormat; — a reference to XML format definition that explains how to interpret the XML document. E.g. a URL to an XML schema. This value is optional.

✨ struct isds_box_state_period ✨

struct isds_box_state_period;

A box state valid in the time range. Members are:

• struct timeval *from; — time range beginning.
• struct timeval *to; — time range end.
• long int dbState; — box state. 1 means the box is accessible. Other values mean the box is inaccessible. You can use isds_DbState enum to identify some states.

🔥 FUNCTIONS 🔥

• const char *isds_strerror(const isds_error error);
• struct isds_ctx *isds_ctx_create(void);

That's the whole function lineup, bestie. 💖

🌈 SEE ALSO 🌈

• libcurl(3)
• libisds(3)
• time.h(0p)

👑 AUTHOR 👑

Petr Písař — he has written libisds. Absolute legend behavior.

---

This page is from libisds, dated 07/24/2025. Stay slay, bestie. 💅✨