1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
|
.. _schema_lab:
lab
---
The ``name`` of the lab mut be a unique value among all the registered labs. Use
a short but descriptive name to identify the lab, since this value will be used
to perform POST request :ref:`on the boot resource <collection_boot_post>`.
As a rule of thumbs for creating a lab ``name``:
* Start the lab name with ``lab-``.
* Use some of the contact information as the next element (the ``name``, or ``affiliation``).
* Add a progressive number at the end (``-00``, ``-01``, etc...).
.. _schema_lab_get:
GET
***
::
{
"title": "lab",
"description": "A lab object",
"type": "object",
"properties": {
"version": {
"type": "string",
"description": "The version of this JSON schema: depends on the POST request"
},
"name": {
"type": "string",
"description": "The name associated with the object"
},
"_id": {
"type": "string",
"description": "The ID associated with the object as provided by mongodb"
},
"created_on": {
"type": "object",
"description": "Creation date of the object",
"properties": {
"$date": {
"type": "number",
"description": "Milliseconds from epoch time",
"format": "utc-millisec"
}
}
},
"updated_on": {
"type": "object",
"description": "Update date of the object",
"properties": {
"$date": {
"type": "number",
"description": "Milliseconds from epoch time",
"format": "utc-millisec"
}
}
},
"contact": {
"type": "object",
"description": "The contact details of the object",
"properties": {
"name": {
"type": "string",
"description": "The name of the contact"
},
"surname": {
"type": "string",
"description": "The surname of the contact"
},
"email": {
"type": "string",
"description": "The email of the contact"
},
"telephone": {
"type": "string",
"description": "The land-line phone number"
},
"mobile": {
"type": "string",
"description": "The mobile phone number"
},
"affiliation": {
"type": "string",
"description": "The name of the company, or association this contact is part of"
}
}
},
"address": {
"type": "object",
"description": "The address where the lab is located",
"properties": {
"street_1": {
"type": "string",
"description": "First line for the address"
},
"street_2": {
"type": "string",
"description": "Second line for the address"
},
"city": {
"type": "string",
"description": "The city name"
},
"country": {
"type": "string",
"description": "The country name"
},
"zipcode": {
"type": "string",
"description": "The zip code"
},
"longitude": {
"type": "number",
"description": "Latitude of the lab location"
},
"longitude": {
"type": "number",
"description": "Longitude of the lab location"
}
}
},
"private": {
"type": "boolean",
"description": "If the lab is private or not",
"default": "false"
},
"token": {
"type": "string",
"description": "The ID of the token associated with this lab"
}
}
}
.. _schema_lab_post:
POST
****
::
{
"title": "lab",
"description": "A lab object",
"type": "object",
"properties": {
"version": {
"type": "string",
"description": "The version number of this JSON schema",
"enum": ["1.0"]
},
"name": {
"type": "string",
"description": "The name associated with the object"
},
"contact": {
"type": "object",
"description": "The contact details of the object",
"properties": {
"name": {
"type": "string",
"description": "The name of the contact"
},
"surname": {
"type": "string",
"description": "The surname of the contact"
},
"email": {
"type": "string",
"description": "The email of the contact"
},
"telephone": {
"type": "string",
"description": "The land-line phone number"
},
"mobile": {
"type": "string",
"description": "The mobile phone number"
},
"affiliation": {
"type": "string",
"description": "The name of the company, or association this contact is part of"
},
"required": ["name", "surname", "email"]
}
},
"address": {
"type": "object",
"description": "The address where the lab is located",
"properties": {
"street_1": {
"type": "string",
"description": "First line for the address"
},
"street_2": {
"type": "string",
"description": "Second line for the address"
},
"city": {
"type": "string",
"description": "The city name"
},
"country": {
"type": "string",
"description": "The country name"
},
"zipcode": {
"type": "string",
"description": "The zip code"
},
"longitude": {
"type": "number",
"description": "Latitude of the lab location"
},
"longitude": {
"type": "number",
"description": "Longitude of the lab location"
}
}
},
"private": {
"type": "boolean",
"description": "If the lab is private or not",
"default": "false"
},
"token": {
"type": "string",
"description": "The token to associated with this lab"
}
},
"required": ["version", "name", "contact"]
}
More Info
*********
* :ref:`Lab resource <collection_lab>`
* :ref:`Defconfig schema <schema_defconfig>`
* :ref:`API results <intro_schema_results>`
* :ref:`Schema time and date <intro_schema_time_date>`
|
