Getting an OID description in XML or JSON format

  Request a registrant account

To get the description of an OID in XML or JSON format, use the following URL (as a GET or POST HTTP request method):

XML
https://oid-rep.orange-labs.fr/cgi-bin/display?a=get-xml
&l=
your_email_address&p=your_password
&oid=OID_in_whichever_notation
JSON
https://oid-rep.orange-labs.fr/cgi-bin/display?a=get-json
&l=
your_email_address&p=your_password
&oid=OID_in_whichever_notation

Important note: This feature is only available if a registrant account has been assigned to you by the webmaster.

When using this feature, you agree to conform to the terms of use of this web site. In particular, you understand that downloading, printing or copying from this web site must be for noncommercial use only, and must be limited to a small part of the data. Moreover, you endeavour to inform users of your application that data are coming from OID-info.com by adding a hyperlink to http://oid-info.com or https://oid-rep.orange-labs.fr.

If there is no error, the returned result is a piece of XML (resp. JSON) which looks like the following examples.

The generated XML mostly conforms to the XML Schema for the OID repository. One difference is that the <value> tag is separated in three tags: <asn1-notation>, <dot-notation> and <iri-notation>. Another main difference is that the <oid> tag can have two optional attributes:

  • category which, when present, takes one or multiple (";"-separated) values among "Leaf OID", "Frozen OID", "Not allocating identifiers" and "Not allocating Unicode labels";
  • standardized which, when present, takes value "true" and indicates that the last identifier in the <value> can be used alone without its associated number;
  • last-modification is the date (YYYY-MM-DD) when the OID description was last modified in the OID repository.

In JSON, keys "category", "identifier", "unicode-label", "long-arc" are tables (hence between square brackets).

XML

<oid category="Leaf OID">
  <asn1_notation>
{joint-iso-itu-t(2) example(999) xml-submission(777)}</asn1_notation>
  <dot-notation>
2.999.777</dot-notation>
  <iri-notation>
/Joint-ISO-ITU-T/Example/XML_submission</iri-notation>
  <identifier>
xml-submission</identifier>
  
<identifier>xml-document</identifier>
  <unicode-label>
XML_submission</unicode-label>
  <description>
Example of a description conforming to the <a href="http://oid-info.com/oid.xsd">XML Schema of the OID repository</a>.</description>
  <information>
More information can be found at <a href="http://oid-info.com/submit.htm">Submit OID descriptions as XML files</a>.</information>
  <current-registrant>
    
<first-name>John</first-name>
    <last-name>
Doe</last-name>
    <email>
john.doe@dummy.com</email>
    <modification-date>
2002-05-25</modification-date>
  </current-registrant>
  <first-registrant privacy="
true">
    <first-name>
Paul</first-name>
    <last-name>
Connor</last-name>
    <email>
paul.connor@myhost.com</email>
    <creation-date>
1999-12-31</creation-date>
  </first-registrant>
  <last-modification>
2017-05-23</last-modification>
</oid>

JSON

{ "oid": {
    "category": [
"Leaf OID"],
    "asn1-notation": "{joint-iso-itu-t(2) example(999) xml-submission(777)}",
    "dot-notation"
: "2.999.777",
    "iri-notation"
: "/Joint-ISO-ITU-T/Example/XML_submission",
    "identifier": ["xml-submission", "xml-document"],
    "unicode-label": ["XML_submission"],
  
  "description":"Example of a description conforming to the <a href=\"http://oid-info.com/oid.xsd\">XML Schema of the OID repository</a>.",
    "information":
"More information can be found at <a href=\"http://oid-info.com/submit.htm\">Submit OID descriptions as XML files</a>.",
    "current-registrant": {
      
"first-name":"John",
      "last-name":
"Doe",
      "email":
"john.doe@dummy.com",
      "modification-date":
"2002-05-25"
    },
    "first-registrant": {
      "privacy":
"true",
      "first-name":
"Paul",
      "last-name":
"Connor",
      "email": "
paul.connor@myhost.com",
      "creation-date": "
1999-12-31"
    },
    "last-modification":
"2017-05-23"
  }
}

Errors are rendered as follows:

XML
<error code="error_code">
  Error message in English
</error>
JSON
{ "error": {
    "code":
"error_code",
    "message":
"Error message in English"
  }
}

where error_code is one of:
  • "illegal_oid" when the OID given in parameter oid cannot exist because, e.g., it is known to be forbidden or one of its ascendant OIDs is a leaf (the "Error message in English" explains what the problem is);
  • "maintenance" when the OID repository is not available because it is under maintenance;
  • "oid_not_validated" when the OID given in parameter oid is described in the OID repository but has not yet been validated by the OID administrator, so its description is not yet publicly available;
  • "runtime_error" when there is an internal problem (in which case the OID repository admin is automatically notified by email);
  • "syntax_error" when the OID given in parameter oid is not syntactiacally correct (the "Error message in English" explains what the problem is);
  • "unknown_oid" when the OID given in parameter oid is not described in the OID repository (or this parameter is missing);
  • "wrong_login" when parameters login or password are not correct (the "Error message in English" explains what the problem is).
Note that the error_code won't change whereas the "Error message in English" may evolve, so it is recommended that, if needed, your application checks the error_code.