Added OVM_FO, OVM_PFO and OVM_PO box types.
[libisds.git] / doc / box
blobd80b4f967d9560d04237ddfacf237216ef284937
1 Box specification
2 =================
4 Source: Provozní řád Informačního systému datových schránek, (2010-11-28)
5 Source: Webové služby ISDS pro vyhledávání datových schránek, version 2.16
6     (2011-01-25)
7 Source: Webové služby ISDS pro manipulaci s datovými schránkami, version 2.6
8     (2010-01-18) [DataMessage_ws.pdf], Page 6
9 Source Webové služby rozhraní ISDS pro správu datových schránek, version 2.35
10     (2013-04-10), Page 23
12 Box types
13 =========
15 Symbol      Number  Description
16 --------------------------------------------------------------------------
17             0       ISDS system
18 OVM         10      Standard government (state or municipality or similar)
19                     office
20 OVM_NOTAR   11      Notary (stopped being used, replaced with OVM_PFO)
21 OVM_EXEKUT  12      Executor (stopped being used, replaced with OVM_PFO)
22 OVM_REQ     13      Subsidiary office with OVM status assigned on request
23                     (section 6 and 7 of act)
24 OVM_FO      14      Natural person with OVM status
25                     (without identification number)
26 OVM_PFO     15      Natural person in business with OVM status
27                     (e.g. notary or executor)
28 OVM_PO      16      Juridical person with OVM status
29                     (arisen from previously existing PO or PO_REQ)
30 PO          20      Standard commercial organization (in trade registry)
31 PO_ZAK      21      Other organization based on law
32                     (stopped being used, replaced with PO)
33 PO_REQ      22      Organization with box assigned on request
34 PFO         30      Person in business
35 PFO_ADVOK   31      Lawyer
36 PFO_DANPOR  32      Tax consultant
37 PFO_INSSPR  33      Administrator of insolvency
38 PFO_AUDITOR 34      Statutory auditor
39 FO          40      Standard person
42 Box states
43 ==========
45 Value       Description 
46 -------------------------------------------------------
47 0 or empty  Error occurred while retrieving box state
48 1           Box is accessible.
49 2           Temporarily inaccessible (on owner's request)
50 3           Not yet active
51 4           Permanently inaccessible
52 5           Box has been removed
53 6           Temporarily inaccessible (by law)
55 Although state 6 exists, ISDS returns state 2 instead.
57 Only state 1 means box is capable of receiving messages.
58 User can log in even into inaccessible box. However some operations, like
59 message sending, are not allowed then.
62 Country values
63 ==============
65 The counries are denoted by two-letter abbreviation. Sometimes it can be full
66 or somewhat abbreviated name. Exact list of codes is in Appendix A of Webové
67 služby ISDS pro vyhledávání datových schránek.
69 Non-normative: It's a subset of ISO 3166-1 alpha-2 list with some non-standard
70 extensions (borrowed from International Post Union).
72 Missing codes: 
74 Value   Description
75 --------------------------------------------------
76 AQ      Antarctica
77 AS      Samoa (American)
78 AX      Åland Islands
79 BV      Bouvet Island
80 CC      Cocos (Keeling) Islands
81 CX      Christmas Island
82 EH      Western Sahara
83 GS      South Georgia & the South Sandwich Islands
84 GU      Guam
85 HM      Heard Island & McDonald Islands
86 MP      Northern Mariana Islands
87 NF      Norfolk Island
88 SJ      Svalbard & Jan Mayen
89 UM      US minor outlying islands
90 YT      Mayotte
92 Additional codes:
94 Value   Description
95 ------------------------
96 TA      Tristan da Cunha
97 XZ      Kosovo