Rev 6 | Rev 33 | Go to most recent revision | Details | Compare with Previous | Last modification | View Log | RSS feed
| Rev | Author | Line No. | Line |
|---|---|---|---|
| 2 | daniel-mar | 1 | <!DOCTYPE html> |
| 2 | <html lang="en"> |
||
| 3 | <head> |
||
| 4 | <title>OID repository - Getting an OID description in XML for JSON</title> |
||
| 5 | <meta charset="UTF-8"><!-- <meta content="text/html; charset=iso-8859-1" http-equiv="content-type"> --> |
||
| 6 | <meta name="google-translate-customization" content="ae799a386ca63905-075d0f84d2caa8b0-g8dbf29cdfe9cdbeb-c"> |
||
| 7 | <link rel="Stylesheet" type="text/css" href="style.css"> |
||
| 8 | <meta name="viewport" content="width=device-width, initial-scale=1"> |
||
| 9 | <meta name="DESCRIPTION" content="This OID repository gathers information about Object Identifiers (OIDs), and provides tools to display and search for this information."> |
||
| 10 | <meta name="keywords" content="object identifier oid OID repository registration authority ISO ITU"> |
||
| 11 | <link rel="SHORTCUT ICON" href="/images/favicon.ico"> |
||
| 12 | <script src="scripts.js"></script> |
||
| 13 | </head> |
||
| 14 | <body id="body" onload="_onload()"> |
||
| 15 | <div id="global_container"> |
||
| 16 | <div id="header"> |
||
| 17 | <a href="index.htm"> |
||
| 18 | <img src="images/treewall.jpg" width="130" height="110"> |
||
| 19 | </a> |
||
| 6 | daniel-mar | 20 | <h1 id="header_h1">OID Repository</h1><br><br><br><br> |
| 2 | daniel-mar | 21 | <div id="header_url_and_menu"> |
| 6 | daniel-mar | 22 | <div id="header_url">www.oid-info.com</div> |
| 2 | daniel-mar | 23 | <div id="header_url_right"> |
| 24 | <ul id="header_menu"> |
||
| 25 | <li><a href="index.htm">Home</a></li> |
||
| 26 | <li><a href="/cgi-bin/display?tree=">Tree display</a></li> |
||
| 27 | <li><a href="basic-search.htm">Search</a></li> |
||
| 28 | <li><a href="faq.htm">FAQ</a></li> |
||
| 29 | <li><a href="/helper">Helper</a></li> |
||
| 30 | </ul> |
||
| 31 | </div> |
||
| 32 | </div> |
||
| 33 | <div style="top: 11px; left: 694px; margin-left:-120px;" id="search"> |
||
| 34 | <span style="color: rgb(226, 137, 34); font-family: Arial, Helvetica, sans-serif; font-size: 14px; font-weight: bold;">Display OID:</span> <br> |
||
| 35 | <form name="form_go" method="get" action="/cgi-bin/display" enctype="multipart/form-data"> |
||
| 36 | <input type="hidden" name="action" value="display"> |
||
| 37 | <input name="oid" size="20" value="" onfocus="empty();" placeholder="-- OID --" type="text"> <input value="Go" type="submit"> |
||
| 38 | </form> |
||
| 39 | </div> |
||
| 40 | <div id="google_translate"> |
||
| 41 | <script> |
||
| 42 | function googleTranslateElementInit() { |
||
| 43 | new google.translate.TranslateElement({ pageLanguage: 'en', layout: google.translate.TranslateElement.InlineLayout.SIMPLE, gaTrack: true, gaId: 'UA-33779649-1' }, 'google_translate_element'); |
||
| 44 | } |
||
| 45 | </script> |
||
| 46 | <!--<script src="//translate.google.com/translate_a/element.js?cb=googleTranslateElementInit"> |
||
| 47 | </script>--> |
||
| 48 | </div> |
||
| 49 | </div> |
||
| 50 | </div> |
||
| 51 | <div id="mobile_version"> |
||
| 52 | <aside class="sidebar"> |
||
| 53 | <nav id="navigation" role="navigation"> |
||
| 54 | <form name="form_go" method="get" action="/cgi-bin/display" enctype="multipart/form-data"> |
||
| 55 | <a><input name="oid" id="searchbox_mobile" size="35" value="" onfocus="empty();" placeholder="-- Display OID --" type="search"></a> |
||
| 56 | </form> |
||
| 57 | <a href="index.htm">Home</a> |
||
| 58 | <a href="/cgi-bin/display?tree=">Tree display</a> |
||
| 59 | <a href="basic-search.htm">Search</a> |
||
| 60 | <a href="faq.htm">FAQ</a> |
||
| 61 | <a href="/helper">Chatbot helper</a> |
||
| 62 | </nav> |
||
| 63 | </aside> |
||
| 64 | </div> |
||
| 65 | <div class="wrapper"> |
||
| 66 | <table width="100%" id="header_mobile"> |
||
| 67 | <tr> |
||
| 68 | <td width="20%"> |
||
| 69 | <a href="#body" class="nav-button-open" aria-label="open navigation"></a> |
||
| 70 | <a href="#" class="nav-button-close" aria-label="close navigation"></a> |
||
| 71 | </td> |
||
| 72 | <td width="60%" valign="middle"> |
||
| 6 | daniel-mar | 73 | <h1 id="header_h1">OID Repository</h1> |
| 74 | <div id="header_url">www.oid-info.com</div> |
||
| 2 | daniel-mar | 75 | </td> |
| 76 | <td width="20%"><a href="index.htm"><img src="images/treewall.jpg" style="height:10vh;width:auto"></a></td> |
||
| 77 | </tr> |
||
| 78 | </table> |
||
| 79 | |||
| 80 | <div id="global_content"> |
||
| 81 | |||
| 82 | <table cellspacing="0" cellpadding="0" border="0" width="100%"> |
||
| 83 | |||
| 84 | <tr> |
||
| 85 | |||
| 86 | <td height="20" colspan="3" valign="top" width="100%"> </td> |
||
| 87 | |||
| 88 | </tr> |
||
| 89 | |||
| 90 | <tr> |
||
| 91 | <td height="40" valign="top" width="440"> |
||
| 92 | <p> |
||
| 93 | <span class="page_title">Getting an OID description in XML or JSON format</span> |
||
| 94 | </p> |
||
| 95 | </td> |
||
| 96 | <td height="40" valign="top" width="20"> </td> |
||
| 97 | <td width="150" height="40" valign="middle"> |
||
| 98 | <img src="images/bullet.gif" width="10" height="8" border="0"><a href="/cgi-bin/manage?a=ca">Request a registrant account</a> |
||
| 99 | </td> |
||
| 100 | </tr> |
||
| 101 | |||
| 102 | </table> |
||
| 103 | <table cellspacing="0" cellpadding="0" border="0" width="100%"> |
||
| 104 | <tr> |
||
| 105 | <td width="10"></td> |
||
| 106 | <td> |
||
| 107 | |||
| 108 | <p> |
||
| 109 | To get the description of an OID in XML or JSON format, use the following |
||
| 110 | URL (as a <code>GET</code> or <code>POST</code> <a href="http://www.w3schools.com/TAGs/ref_httpmethods.asp">HTTP |
||
| 111 | request method</a>): |
||
| 112 | </p> |
||
| 113 | <div align="center"> |
||
| 114 | <table width="75%" border="1"> |
||
| 115 | <tr> |
||
| 116 | <td align="center"> |
||
| 117 | <div align="center"><font class="color_orange">XML</font> </div> |
||
| 118 | </td> |
||
| 119 | </tr> |
||
| 120 | <tr> |
||
| 121 | <td> |
||
| 122 | <div align="center"> |
||
| 17 | daniel-mar | 123 | <code><strong>https://oid-rep.orange-labs.fr/cgi-bin/display?a=<font class="color_orange">get-xml</font><br>&l=</strong><em>your_email_address</em><strong>&p=</strong><em>your_password</em><br><strong>&oid=</strong><em>OID_in_whichever_notation</em></code> |
| 2 | daniel-mar | 124 | </div> |
| 125 | </td> |
||
| 126 | </tr> |
||
| 127 | <tr> |
||
| 128 | <td align="center"> |
||
| 129 | <div align="center"><font class="color_orange">JSON</font> </div> |
||
| 130 | </td> |
||
| 131 | </tr> |
||
| 132 | <tr> |
||
| 133 | <td> |
||
| 134 | <div align="center"> |
||
| 17 | daniel-mar | 135 | <code><strong>https://oid-rep.orange-labs.fr/cgi-bin/display?a=<font class="color_orange">get-json</font><br>&l=</strong><em>your_email_address</em><strong>&p=</strong><em>your_password</em><br><strong>&oid=</strong><em>OID_in_whichever_notation</em></code> |
| 2 | daniel-mar | 136 | </div> |
| 137 | </td> |
||
| 138 | </tr> |
||
| 139 | </table><br></div> |
||
| 140 | <p> |
||
| 141 | <b>Important note</b>: This feature is only available if a <a href="registrant-account-charter.htm">registrant |
||
| 142 | account</a> has been assigned to you by the webmaster. |
||
| 143 | </p> |
||
| 144 | <p> |
||
| 145 | When using this feature, you agree to conform to the <a href="disclaimer.htm">terms |
||
| 146 | of use</a> of this web site. In particular, you understand that downloading, |
||
| 147 | printing or copying from this web site must be for noncommercial use |
||
| 148 | only, and must be limited to a small part of the data. Moreover, you |
||
| 149 | endeavour to inform users of your application that data are coming from |
||
| 17 | daniel-mar | 150 | <a href="http://oid-info.com">OID-info.com</a> by adding a hyperlink to <a href="http://oid-info.com">http://oid-info.com</a> |
| 151 | or <a href="https://oid-rep.orange-labs.fr">https://oid-rep.orange-labs.fr</a>. |
||
| 2 | daniel-mar | 152 | </p> |
| 153 | </td> |
||
| 154 | </tr> |
||
| 155 | </table> |
||
| 156 | <table cellspacing="0" cellpadding="0" border="0" width="100%"> |
||
| 157 | <tr> |
||
| 158 | <td width="10"></td> |
||
| 159 | <td> |
||
| 160 | <p> |
||
| 161 | If there is no error, the returned result is a piece of XML (resp. |
||
| 162 | JSON) which looks like the following examples. |
||
| 163 | </p> |
||
| 164 | <p> |
||
| 165 | The generated XML mostly conforms to the <a href="http://oid-info.com/oid.xsd">XML |
||
| 166 | Schema for the OID repository</a>. One difference is that the <code><strong><value></strong></code> |
||
| 167 | tag is separated in three tags: <code><strong><asn1-notation></strong></code>, |
||
| 168 | <code><strong><dot-notation></strong></code> and <code><strong><iri-notation></strong></code>. |
||
| 169 | Another main difference is that the <code><strong><oid></strong></code> |
||
| 170 | tag can have two optional attributes: |
||
| 171 | </p> |
||
| 172 | <ul> |
||
| 173 | <li> |
||
| 174 | <code><strong>category</strong></code> which, when present, takes |
||
| 175 | one or multiple ("<code>;</code>"-separated) values among "<a href="faq.htm#26"><code>Leaf |
||
| 176 | OID</code></a>", "<a href="faq.htm#26"><code>Frozen OID</code></a>", |
||
| 177 | "<code>Not allocating identifiers</code>" and "<code>Not |
||
| 178 | allocating Unicode labels</code>"; |
||
| 179 | </li> |
||
| 180 | <li> |
||
| 181 | <code><strong>standardized</strong></code> which, when present, |
||
| 182 | takes value "<code>true</code>" and indicates that the last <a href="name-forms.htm">identifier</a> |
||
| 183 | in the <strong><code><value></code></strong> can be used alone |
||
| 184 | without its associated number; |
||
| 185 | </li> |
||
| 186 | <li> |
||
| 187 | <code>last-modification</code> is the date (YYYY-MM-DD) when the |
||
| 188 | OID description was last modified in the OID repository. |
||
| 189 | </li> |
||
| 190 | </ul> |
||
| 191 | <p> |
||
| 192 | In JSON, keys <code>"category"</code>, <code>"identifier"</code>, |
||
| 193 | <code>"unicode-label"</code>, <code>"long-arc"</code> |
||
| 194 | are tables (hence between square brackets). |
||
| 195 | </p> |
||
| 196 | <table width="100%" border="1"> |
||
| 197 | <tr> |
||
| 198 | <td align="center"> |
||
| 199 | <font class="color_orange">XML</font> |
||
| 200 | </td> |
||
| 201 | </tr> |
||
| 202 | <tr> |
||
| 203 | <td> |
||
| 204 | <p> |
||
| 205 | <code><strong><oid category="</strong>Leaf OID"<strong>><br> <asn1_notation></strong>{joint-iso-itu-t(2) |
||
| 206 | example(999) xml-submission(777)}<strong></asn1_notation><br> <dot-notation></strong>2.999.777<strong></dot-notation><br> <iri-notation></strong>/Joint-ISO-ITU-T/Example/XML_submission<strong></iri-notation><br> <identifier></strong>xml-submission<strong></identifier><br> </strong><strong><identifier></strong>xml-document<strong></identifier><br> <unicode-label></strong>XML_submission<strong></unicode-label><br> <description></strong>Example of a description |
||
| 207 | conforming to the <a href="http://oid-info.com/oid.xsd">XML |
||
| 208 | Schema of the OID repository</a>.<strong></description><br> <information></strong>More information can be |
||
| 209 | found at <a href="http://oid-info.com/submit.htm">Submit |
||
| 210 | OID descriptions as XML files</a>.<strong></information><br> <current-registrant><br> </strong><strong><first-name></strong>John<strong></first-name><br> <last-name></strong>Doe<strong></last-name><br> <email></strong>john.doe@dummy.com<strong></email><br> <modification-date></strong>2002-05-25<strong></modification-date><br> </current-registrant><br> <first-registrant privacy="</strong>true<strong>"><br> <first-name></strong>Paul<strong></first-name><br> <last-name></strong>Connor<strong></last-name><br> <email></strong>paul.connor@myhost.com<strong></email><br> <creation-date></strong>1999-12-31<strong></creation-date><br> </first-registrant><br> <last-modification></strong>2017-05-23<strong></last-modification><br></oid></strong></code> |
||
| 211 | </p> |
||
| 212 | </td> |
||
| 213 | </tr> |
||
| 214 | <tr> |
||
| 215 | <td align="center"> |
||
| 216 | <font class="color_orange">JSON</font> |
||
| 217 | </td> |
||
| 218 | </tr> |
||
| 219 | <tr> |
||
| 220 | <tr> |
||
| 221 | <td> |
||
| 222 | <p> |
||
| 223 | <code><strong>{ "oid": {<br> "category": [</strong>"Leaf |
||
| 224 | OID"<strong>]</strong>,<br><strong> "asn1-notation"</strong>: |
||
| 225 | "{joint-iso-itu-t(2) example(999) xml-submission(777)}<strong>",<br> "dot-notation"</strong>: "2.999.777<strong>",<br> "iri-notation"</strong>: "/Joint-ISO-ITU-T/Example/XML_submission<strong>",<br></strong><strong> "identifier": |
||
| 226 | [</strong>"xml-submission", "xml-document"<strong>]</strong>,<br><strong> "unicode-label": [</strong>"XML_submission"<strong>]</strong>,<br><strong> </strong></code><strong><code><strong> </strong>"description":</code></strong><code>"Example of a description conforming to the <a href=\"http://oid-info.com/oid.xsd\">XML |
||
| 227 | Schema of the OID repository</a>.<strong>",<br> "information":</strong> "More |
||
| 228 | information can be found at <a href=\"http://oid-info.com/submit.htm\">Submit |
||
| 229 | OID descriptions as XML files</a>."<strong>,<br> "current-registrant": {<br> </strong></code><strong><code>"first-name":</code></strong><code>"John<strong>",<br> "last-name":</strong> |
||
| 230 | "Doe"<strong>,<br> "email":</strong> "john.doe@dummy.com"<strong>,<br> "modification-date":</strong> |
||
| 231 | "2002-05-25"<br><strong> }, <br> "first-registrant": {<br> "privacy":</strong> "true"<strong>,<br> "first-name":</strong> |
||
| 232 | "Paul"<strong>,<br> "last-name":</strong> |
||
| 233 | "Connor<strong>",<br> "email": "</strong>paul.connor@myhost.com<strong>",<br> "creation-date": "</strong>1999-12-31"<strong><br> },<br> "last-modification":</strong> "2017-05-23"<br> }<br>}</code> |
||
| 234 | </p> |
||
| 235 | </td> |
||
| 236 | </tr> |
||
| 237 | </table> |
||
| 238 | </td> |
||
| 239 | </tr> |
||
| 240 | </table> |
||
| 241 | |||
| 242 | <table cellspacing="0" cellpadding="0" border="0" width="100%"> |
||
| 243 | <tr> |
||
| 244 | <td width="10"></td> |
||
| 245 | <td> |
||
| 246 | Errors are rendered as follows:<br><br><table width="100%" border="1"> |
||
| 247 | <tr> |
||
| 248 | <td align="center"> <font class="color_orange">XML</font> </td> |
||
| 249 | </tr> |
||
| 250 | <tr> |
||
| 251 | <td> |
||
| 252 | <code><strong><error code="</strong><em>error_code</em><strong>"></strong><br> Error message in English<br><strong></error></strong></code> |
||
| 253 | </td> |
||
| 254 | </tr> |
||
| 255 | <tr> |
||
| 256 | <td align="center"> <font class="color_orange">JSON</font> </td> |
||
| 257 | </tr> |
||
| 258 | <tr> |
||
| 259 | <td> |
||
| 260 | <code><strong>{ "error": {<br> "code":</strong> "<em>error_code</em><strong>",<br> "message":</strong> "Error message |
||
| 261 | in English"<br> <strong>}<br>}</strong></code> |
||
| 262 | </td> |
||
| 263 | </tr> |
||
| 264 | </table> |
||
| 265 | <br>where <code><em>error_code</em></code> is one of: |
||
| 266 | <ul> |
||
| 267 | <li> |
||
| 268 | "<code>illegal_oid</code>" when the OID given in parameter |
||
| 269 | <strong><code>oid</code></strong> cannot exist because, e.g., it is |
||
| 270 | known to be forbidden or one of its ascendant OIDs is a leaf (the |
||
| 271 | "<code>Error message in English</code>" explains what the |
||
| 272 | problem is); |
||
| 273 | </li> |
||
| 274 | <li> |
||
| 275 | "<code>maintenance</code>" when the OID repository is |
||
| 276 | not available because it is under maintenance; |
||
| 277 | </li> |
||
| 278 | <li> |
||
| 279 | "<code>oid_not_validated</code>" when the OID given in |
||
| 280 | parameter <strong><code>oid</code></strong> is described in the OID |
||
| 281 | repository but has not yet been validated by the OID administrator, |
||
| 282 | so its description is not yet publicly available; |
||
| 283 | </li> |
||
| 284 | <li> |
||
| 285 | "<code>runtime_error</code>" when there is an internal |
||
| 286 | problem (in which case the OID repository admin is automatically notified |
||
| 287 | by email); |
||
| 288 | </li> |
||
| 289 | <li> |
||
| 290 | "<code>syntax_error</code>" when the OID given in parameter |
||
| 291 | <strong><code>oid</code></strong> is not syntactiacally correct (the |
||
| 292 | "<code>Error message in English</code>" explains what the |
||
| 293 | problem is); |
||
| 294 | </li> |
||
| 295 | <li> |
||
| 296 | "<code>unknown_oid</code>" when the OID given in parameter |
||
| 297 | <strong><code>oid</code></strong> is not described in the OID repository |
||
| 298 | (or this parameter is missing); |
||
| 299 | </li> |
||
| 300 | <li> |
||
| 301 | "<code>wrong_login</code>" when parameters <strong><code>login</code></strong> |
||
| 302 | or <strong><code>password</code></strong> are not correct (the "<code>Error |
||
| 303 | message in English</code>" explains what the problem is). |
||
| 304 | </li> |
||
| 305 | </ul> |
||
| 306 | Note that the <code><em>error_code</em></code> won't change whereas the |
||
| 307 | "<code>Error message in English</code>" may evolve, so it is |
||
| 308 | recommended that, if needed, your application checks the <code><em>error_code</em></code>. |
||
| 309 | </td> |
||
| 310 | </tr> |
||
| 311 | </table> |
||
| 312 | |||
| 313 | </div> |
||
| 314 | |||
| 315 | |||
| 316 | <center id="footer"> |
||
| 317 | <img style="border: 0px solid ; width: 760px; height: 2px;" alt="separation line" src="images/separation800.png" width="760" height="2"><br><br> |
||
| 318 | <table width="710" cellspacing="0" cellpadding="0" border="0"> |
||
| 319 | <tr valign="baseline"> |
||
| 320 | <td width="34"> |
||
| 321 | <a href="/helper"> |
||
| 322 | <img src="images/enveloppe.png" width="30" height="13" name="mail" border="0" alt="OID helper"> |
||
| 323 | </a> |
||
| 324 | </td> |
||
| 325 | <td width="58" align="center"><font size="-2">Webmaster</font></td> |
||
| 326 | <td width="10" align="center"><img src="images/pointorange_small.gif" width="14" height="10"></td> |
||
| 327 | <td width="78" align="center"> |
||
| 328 | <font size="-2"> |
||
| 329 | <!--<script language="JavaScript"> |
||
| 330 | d=new Date(document.lastModified) |
||
| 331 | month=new Array("Jan","Feb","Mar","Apr","May","Jun","Jul","Aug","Sep","Oct","Nov","Dec") |
||
| 332 | if (Date.parse(document.lastModified) != 0) |
||
| 333 | document.write(d.getDate()+" "+month[d.getMonth()]+" "+d.getFullYear()); |
||
| 334 | </script>--> |
||
| 17 | daniel-mar | 335 | 27 Nov 2022 |
| 2 | daniel-mar | 336 | </font> |
| 337 | </td> |
||
| 338 | <td width="24" align="center"><img src="images/pointorange_small.gif" width="14" height="10"></td> |
||
| 339 | <td align="center" width="409"> |
||
| 340 | <font size=-1> |
||
| 341 | |||
| 342 | </font> |
||
| 343 | </td> |
||
| 344 | <td height="20" width="162" valign="middle" align="right"><a href="#top"><img src="images/page_top.png" width="150" height="17" border="0"></a></td> |
||
| 345 | </tr> |
||
| 346 | </table><br> |
||
| 347 | </center> |
||
| 348 | </div> |
||
| 349 | </body> |
||
| 350 | </html> |