Rev 891 | Go to most recent revision | Show entire file | Regard whitespace | Details | Blame | Last modification | View Log | RSS feed
| Rev 891 | Rev 893 | ||
|---|---|---|---|
| Line 40... | Line 40... | ||
| 40 | 40 | ||
| 41 | 41 | ||
| 42 | .ti 0 |
42 | .ti 0 |
| 43 | Abstract |
43 | Abstract |
| 44 | 44 | ||
| 45 | This document defines a method for retrieving information about Object Identifiers (OIDs) and their associated Registration Authorities (RAs) using a text-based protocol, in a way that is both human-readable and machine-readable. Besides the text protocol, OID-IP can also send information using JSON or XML. |
45 | This document defines a method for retrieving information about Object Identifiers (OIDs) and their associated Registration Authorities (RAs) through a text-based protocol, in a way that is both human-readable and machine-readable. Besides a text output format, OID-IP also supports sending information in JSON and XML. |
| 46 | 46 | ||
| 47 | 47 | ||
| 48 | 48 | ||
| 49 | 49 | ||
| 50 | 50 | ||
| Line 202... | Line 202... | ||
| 202 | The namespace identifier (i.e. "oid") MUST be written in lower-case. |
202 | The namespace identifier (i.e. "oid") MUST be written in lower-case. |
| 203 | 203 | ||
| 204 | .ti 0 |
204 | .ti 0 |
| 205 | 2.1 Arguments |
205 | 2.1 Arguments |
| 206 | 206 | ||
| 207 | The client can optionally send additional information to the server using "arguments". |
207 | The client can send additional information to the server using "arguments". Arguments are OPTIONAL. |
| 208 | 208 | ||
| 209 | Names MUST be treated as case-sensitive. |
209 | Names MUST be treated as case-sensitive. |
| 210 | 210 | ||
| 211 | A request can contain multiple arguments which are each prepended by a dollar sign ("$"). |
211 | A request can contain multiple arguments which are each prepended by a dollar sign ("$"). |
| 212 | 212 | ||
| Line 231... | Line 231... | ||
| 231 | 231 | ||
| 232 | The "format" argument defines the desired output format. |
232 | The "format" argument defines the desired output format. |
| 233 | 233 | ||
| 234 | This document defines 3 formats: |
234 | This document defines 3 formats: |
| 235 | 235 | ||
| 236 | (1) "text": A text representation as defined in section\03.1.1. (MANDATORY) |
236 | (1) "text": A text representation as defined in section\03.1.1 (MANDATORY). |
| 237 | 237 | ||
| 238 | (2) "json": The JavaScript Object Notation (JSON, [RFC8259]) representation as defined in section\03.1.2. (OPTIONAL) |
238 | (2) "json": The JavaScript Object Notation (JSON, [RFC8259]) representation as defined in section\03.1.2 (RECOMMENDED). |
| 239 | 239 | ||
| 240 | (3) "xml": Extensible Markup Language (XML, [XML]) representation as defined in section\03.1.3. (OPTIONAL) |
240 | (3) "xml": Extensible Markup Language (XML, [XML]) representation as defined in section\03.1.3 (RECOMMENDED). |
| 241 | 241 | ||
| 242 | The default format is "text", which is assumed if the "format" argument is omitted. |
242 | The default format is "text", which is assumed if the "format" argument is omitted. |
| 243 | 243 | ||
| 244 | Besides these 3 formats, the server can accept other formats not defined in this document. The name of the formats MUST be |
244 | Besides these 3 formats, the server can accept other formats not defined in this document. The name of the formats MUST be |
| 245 | alphanumeric, lower-case, and non-empty, and SHOULD be written in the English language (e.g. "text") or be common abbreviations (e.g. "json"). |
245 | alphanumeric, lower-case, and non-empty, and SHOULD be written in the English language (e.g. "text") or be common abbreviations (e.g. "json"). |