Add forgotten server example files
[libisds.git] / doc / box
blobc3d7377dee0266e0dc33054dc27d8e94fb3a872a
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
21 OVM_EXEKUT  12      Executor
22 OVM_REQ     13      Subsidiary office with OVM status assigned on request
23                     (section 6 and 7 of act)
24 PO          20      Standard commercial organization (in trade registry)
25 PO_ZAK      21      Other organization based on law
26 PO_REQ      22      Organization with box assigned on request
27 PFO         30      Person in bussiness
28 PFO_ADVOK   31      Lawyer
29 PFO_DANPOR  32      Tax consultant
30 PFO_INSSPR  33      Administrator of insolvency
31 FO          40      Standard person
34 Box states
35 ==========
37 Value       Description 
38 -------------------------------------------------------
39 0 or empty  Error occurred while retrieving box state
40 1           Box is accessible.
41 2           Temporarily inaccessible (on owner's request)
42 3           Not yet active
43 4           Permanently inaccessible
44 5           Box has been removed
45 6           Temporarily inaccessible (by law)
47 Although state 6 exists, ISDS returns state 2 instead.
49 Only state 1 means box is capable of receiving messages.
50 User can log in even into inaccessible box. However some operations, like
51 message sending, are not allowed then.
54 Country values
55 ==============
57 The counries are denoted by two-letter abbreviation. Sometimes it can be full
58 or somewhat abbreviated name. Exact list of codes is in Appendix A of Webové
59 služby ISDS pro vyhledávání datových schránek.
61 Non-normative: It's a subset of ISO 3166-1 alpha-2 list with some non-standard
62 extensions (borrowed from International Post Union).
64 Missing codes: 
66 Value   Description
67 --------------------------------------------------
68 AQ      Antarctica
69 AS      Samoa (American)
70 AX      Åland Islands
71 BV      Bouvet Island
72 CC      Cocos (Keeling) Islands
73 CX      Christmas Island
74 EH      Western Sahara
75 GS      South Georgia & the South Sandwich Islands
76 GU      Guam
77 HM      Heard Island & McDonald Islands
78 MP      Northern Mariana Islands
79 NF      Norfolk Island
80 SJ      Svalbard & Jan Mayen
81 UM      US minor outlying islands
82 YT      Mayotte
84 Additional codes:
86 Value   Description
87 ------------------------
88 TA      Tristan da Cunha
89 XZ      Kosovo