Service locators

Addresses of known ISDS servers.

Base URLs of production ISDS instance

extern const char isds_locator[];

extern const char isds_cert_locator[];

extern const char isds_vodz_locator[];

extern const char isds_vodz_cert_locator[];

extern const char isds_otp_locator[];

extern const char isds_mep_locator[];

Base URLs of testing ISDS instance

extern const char isds_testing_locator[];

extern const char isds_cert_testing_locator[];

extern const char isds_vodz_testing_locator[];

extern const char isds_vodz_cert_testing_locator[];

extern const char isds_otp_testing_locator[];

extern const char isds_mep_testing_locator[];

struct isds_ctx

struct isds_ctx;

Context for specific ISDS box.

isds_error

typedef enum isds_error;

Error code. Known values:

IE_SUCCESS

IE_ERROR

IE_NOTSUP

IE_INVAL

IE_INVALID_CONTEXT

IE_NOT_LOGGED_IN

IE_CONNECTION_CLOSED

IE_TIMED_OUT

IE_NONEXIST

IE_NOMEM

IE_NETWORK

IE_HTTP

IE_SOAP

IE_XML

IE_ISDS

IE_ENUM

IE_DATE

IE_TOO_BIG

IE_TOO_SMALL

IE_NOTUNIQ

IE_NOTEQUAL

IE_PARTIAL_SUCCESS

IE_ABORTED

IE_SECURITY

isds_log_level

typedef enum isds_log_level;

Log level. Know values:

ILL_NONE

ILL_CRIT

ILL_ERR

ILL_WARNING

ILL_INFO

ILL_DEBUG

ILL_ALL

isds_log_facility

typedef enum isds_log_facility;

Log facility. Know values:

ILF_NONE

ILF_HTTP

ILF_SOAP

ILF_ISDS

ILF_FILE

ILF_SEC

ILF_XML

ILF_ALL

isds_option

typedef enum isds_option;

libdatovka option identifiers. Known values:

IOPT_TLS_VERIFY_SERVER

IOPT_TLS_CA_FILE

IOPT_TLS_CA_DIRECTORY

IOPT_TLS_CRL_FILE

IOPT_NORMALIZE_MIME_TYPE

isds_tls_option

typedef enum isds_tls_option;

TLS libdatovka option identifiers. Known values:

ITLS_VERIFY_SERVER

ITLS_CA_FILE

ITLS_CA_DIRECTORY

ITLS_CRL_FILE

isds_pki_format

typedef enum isds_pki_format;

Cryptographic material encoding. Known values:

PKI_FORMAT_PEM

PKI_FORMAT_DER

PKI_FORMAT_ENG

struct isds_pki_credentials

struct isds_pki_credentials;

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

char *engine;

isds_pki_format certificate_format;

char *certificate;

isds_pki_format key_format;

char *key;

char *passphrase;

isds_otp_method

typedef enum isds_otp_method;

One-time password authentication method. Known values:

OTP_HMAC

OTP_TIME

isds_otp_resolution

typedef enum isds_otp_resolution;

One-time password authentication resolution. Known values:

OTP_RESOLUTION_SUCCESS

OTP_RESOLUTION_UNKNOWN

OTP_RESOLUTION_BAD_AUTHENTICATION

OTP_RESOLUTION_ACCESS_BLOCKED

OTP_RESOLUTION_PASSWORD_EXPIRED

OTP_RESOLUTION_TOO_FAST

OTP_RESOLUTION_UNAUTHORIZED

OTP_RESOLUTION_TOTP_SENT

OTP_RESOLUTION_TOTP_NOT_SENT

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;

char *otp_code;

Output members are:

isds_otp_resolution resolution;

isds_DbType

typedef enum isds_DbType;

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

DBTYPE_OVM_MAIN

DBTYPE_SYSTEM

DBTYPE_OVM

DBTYPE_OVM_NOTAR

DBTYPE_OVM_EXEKUT

DBTYPE_OVM_REQ

DBTYPE_OVM_FO

DBTYPE_OVM_PFO

DBTYPE_OVM_PO

DBTYPE_PO

DBTYPE_PO_ZAK

DBTYPE_PO_REQ

DBTYPE_PFO

DBTYPE_PFO_ADVOK

DBTYPE_PFO_DANPOR

DBTYPE_PFO_INSSPR

DBTYPE_PFO_AUDITOR

DBTYPE_PFO_ZNALEC

DBTYPE_PFO_TLUMOCNIK

DBTYPE_PFO_ARCH

DBTYPE_PFO_AIAT

DBTYPE_PFO_AZI

DBTYPE_PFO_REQ

DBTYPE_FO

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

DBSTATE_TEMP_INACCESSIBLE

DBSTATE_NOT_YET_ACCESSIBLE

DBSTATE_PERM_INACCESSIBLE

DBSTATE_REMOVED

DBSTATE_TEMP_INACCESSIBLE_LAW

isds_privileges

typedef enum isds_privileges;

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

PRIVIL_READ_ALL

PRIVIL_CREATE_DM

PRIVIL_VIEW_INFO

PRIVIL_SEARCH_DB

PRIVIL_OWNER_ADM

PRIVIL_READ_VAULT

PRIVIL_ERASE_VAULT

enum isds_message_status

typedef enum isds_message_status isds_message_status;

Message status. Known values are:

MESSAGESTATE_SENT

MESSAGESTATE_STAMPED

MESSAGESTATE_INFECTED

MESSAGESTATE_DELIVERED

MESSAGESTATE_SUBSTITUTED

MESSAGESTATE_RECEIVED

MESSAGESTATE_READ

MESSAGESTATE_UNDELIVERABLE

MESSAGESTATE_REMOVED

MESSAGESTATE_IN_VAULT

The values can be combined into a bit mask for some functions. A special MESSAGESTATE_ANY macro denotes any of the states.

isds_hash_algorithm

typedef enum isds_hash_algorithm;

Hash algorithm types. Known values are:

HASH_ALGORITHM_MD5

HASH_ALGORITHM_SHA_1

HASH_ALGORITHM_SHA_224

HASH_ALGORITHM_SHA_256

HASH_ALGORITHM_SHA_384

HASH_ALGORITHM_SHA_512

isds_buffer_strategy

typedef enum isds_buffer_strategy;

Buffer storage strategy. This type defines how a function should embed application provided buffer into raw element of output structure. Known values are:

BUFFER_DONT_STORE

BUFFER_COPY

BUFFER_MOVE

struct isds_hash

struct isds_hash;

This is a hash value storage. Members are:

isds_hash_algorithm algorithm;

size_t length;

void *value;

struct isds_PersonName

struct isds_PersonName;

Name of a person. Members are:

char *pnFirstName;

char *pnMiddleName;

char *pnLastName;

char *pnLastNameAtBirth;

struct isds_BirthInfo

struct isds_BirthInfo;

Date and place of a birth. Members are:

struct tm *biDate;

char *biCity;

char *biCounty;

char *biState;

struct isds_Address

struct isds_Address;

Postal address. Members are:

char *adCity;

char *adStreet;

char *adNumberInStreet;

char *adNumberInMunicipality;

char *adZipCode;

char *adState;

struct isds_DbOwnerInfo

struct isds_DbOwnerInfo;

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

char *dbID;

isds_DbType *dbType;

char *ic;

isds_PersonName *personName;

char *firmName;

isds_BirthInfo *birthInfo;

isds_Address *address;

char *nationality;

char *email;

char *telNumber;

char *identifier;

char *registryCode;

long int *dbState;

_Bool *dbEffectiveOVM;

_Bool *dbOpenAddressing;

isds_UserType

typedef enum isds_UserType;

User type. Known values are:

USERTYPE_PRIMARY

USERTYPE_ENTRUSTED

USERTYPE_ADMINISTRATOR

USERTYPE_OFFICIAL

USERTYPE_OFFICIAL_CERT

USERTYPE_LIQUIDATOR

USERTYPE_RECEIVER

USERTYPE_GUARDIAN

struct isds_DbUserInfo

struct isds_DbUserInfo;

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

char *userID;

isds_UserType *userType;

long int *userPrivils;

isds_PersonName *personName;

isds_Address *address;

struct tm *biDate;

char *ic;

char *firmName;

char *caStreet;

char *caCity;

char *caZipCode;

char *caState;

isds_event_type

typedef enum isds_event_type;

Message event type. Known values are:

EVENT_UNKNOWN

EVENT_ACCEPTED_BY_RECIPIENT

EVENT_ACCEPTED_BY_FICTION

EVENT_ACCEPTED_BY_FICTION_NO_USER

EVENT_UNDELIVERABLE

EVENT_COMMERCIAL_ACCEPTED

EVENT_ENTERED_SYSTEM

EVENT_DELIVERED

EVENT_PRIMARY_LOGIN

EVENT_ENTRUSTED_LOGIN

EVENT_SYSCERT_LOGIN

struct isds_event

struct isds_event;

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

struct isds_timeval *time;

isds_event_type *type;

char *description;

enum isds_IdLevel_value

enum isds_IdLevel_value;

Specifies which information the sender of a data message wants to publish about his person.

PUBLISH_USERTYPE

PUBLISH_PERSONNAME

PUBLISH_BIDATE

PUBLISH_BICITY

PUBLISH_BICOUNTY

PUBLISH_ADCODE

PUBLISH_FULLADDRESS

PUBLISH_ROBIDENT

struct isds_envelope

struct isds_envelope;

Message envelope. These are the metadata about a message. It does contain the message documents.

Be ware 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.

Following members apply to incoming messages only:

char *dmID;

char *dbIDSender;

char *dmSender;

char *dmSenderAddress;

long int *dmSenderType;

char *dmRecipient;

char *dmRecipientAddress;

_Bool *dmAmbiguousRecipient;

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

unsigned long int *dmOrdinal;

enum isds_message_status *dmMessageStatus;

long int *dmAttachmentSize;

struct isds_timeval *dmDeliveryTime;

struct isds_timeval *dmAcceptanceTime;

struct isds_hash *hash;

void *timestamp;

size_t timestamp_length;

struct isds_list *events;

Following members apply to both outgoing and incoming messages:

char *dmSenderOrgUnit;

long int *dmSenderOrgUnitNum;

char *dbIDRecipient;

char *dmRecipientOrgUnit;

long int *dmRecipientOrgUnitNum;

char *dmToHands;

char *dmAnnotation;

char *dmRecipientRefNumber;

char *dmSenderRefNumber;

char *dmRecipientIdent;

char *dmSenderIdent;

Following 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. The members apply to both incoming and outgoing messages:

long int *dmLegalTitleLaw;

long int *dmLegalTitleYear;

char *dmLegalTitleSect;

char *dmLegalTitlePar;

char *dmLegalTitlePoint;

Other incoming/outgoing message members:

_Bool *dmPersonalDelivery;

_Bool *dmAllowSubstDelivery;

char *dmType;

_Bool *dmVODZ;

long int *attsNum;

Following members apply to outgoing messages only:

_Bool *dmOVM;

_Bool *dmPublishOwnID;

int *idLevel;

isds_FileMetaType

typedef enum isds_FileMetaType;

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

FILEMETATYPE_MAIN

FILEMETATYPE_ENCLOSURE

FILEMETATYPE_SIGNATURE

FILEMETATYPE_META

struct isds_document

struct isds_document;

A message document. Members are:

_Bool is_xml;

xmlNodePtr xml_node_list;

void *data;

size_t data_length;

char *dmMimeType;

isds_FileMetaType dmFileMetaType;

char *dmFileGuid;

char *dmUpFileGuid;

char *dmFileDescr;

char *dmFormat;

struct isds_box_state_period

struct isds_box_state_period;

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

struct isds_timeval *from;

struct isds_timeval *to;

long int dbState;

struct isds_dmMessageAuthor

struct isds_dmMessageAuthor;

Response for GetMessageAuthor2. Members are:

isds_sender_type *userType;

struct isds_PersonName2 *personName;

struct tm *biDate;

char *biCity;

char *biCounty;

char *adCode;

char *fullAddress;

_Bool *robIdent;

enum isds_message_type

typedef enum isds_message_type isds_message_type;

Specifies the direction of the message - whether the message is received or sent:

MESSAGE_TYPE_RECEIVED

MESSAGE_TYPE_SENT

enum isds_data_format

typedef enum isds_data_format isds_data_format;

Specifies data format:

FORMAT_XML

FORMAT_CSV

enum isds_asyncReqType

typedef enum isds_asyncReqType isds_asyncReqType;

Specifies synchronous request type:

ASYNC_REQ_TYPE_LIST_ERASED

struct isds_erased_message

struct isds_erased_message;

Describes entries in the lists of erased messages. Members are:

char *dmID;

char *dbIDSender;

char *dmSender;

char *dbIDRecipient;

char *dmRecipient;

char *dmAnnotation;

enum isds_message_status *dmMessageStatus;

struct isds_timeval *dmDeliveryTime;

struct isds_timeval *dmAcceptanceTime;

char *dmType;