NoRFC REST API


The NoRFC web service allows you to search and view the noRFC documents holded in the noRFC documents database

The documents that marks "Private" status are available only after authorization. The documents with "Top Secret" status are not available for downloading. The rest of the documents are available for downloading without any restrictions

GET /info

Returns information about database status and shows total number documents

curl -v --insecure https://127.0.0.1:8732/info

> GET /info HTTP/1.1
> Host: 127.0.0.1:8732
> User-Agent: curl/7.68.0
> Accept: */*
>

< HTTP/1.1 200 OK
< Server: NoRFC/1.04
< Content-Length: 251
< Content-Type: application/json;charset=UTF-8
< Date: Fri, 12 Mar 2021 09:10:43 GMT
<

{
    "message":"OK",
    "name":"info",
    "status":1,
    "total":10
}

POST /search

Performs searching noRFC documents by noRFC number

curl -v --insecure -d '{"norfc":"Draft-R21047017"}' https://127.0.0.1:8732/search

> POST /search HTTP/1.1
> Host: 127.0.0.1:8732
> User-Agent: curl/7.68.0
> Accept: */*
> Content-Length: 27
> Content-Type: application/x-www-form-urlencoded
>

< HTTP/1.1 200 OK
< Date: Fri, 12 Mar 2021 09:17:49 GMT
< Content-Length: 207
< Server: NoRFC/1.04
< Content-Type: application/json;charset=UTF-8
<

{
    "data":[
        {
            "category":"Etcetera",
            "id":8,
            "n":1,
            "norfc":"Draft-R21047017",
            "published":1613499141,
            "title":"Test document"
        }
    ],
    "in":{
        "category":"",
        "norfc":"Draft-R21047017"
        "title":"",
    },
    "message":"",
    "name":"search",
    "status":1
}

GET /<NoRFCNUM>

For example: GET /Draft-R21047017.txt or GET /Draft-R21047017.txt

This method performs getting the noRFC document by noRFC number

curl -v --insecure https://127.0.0.1:8732/Draft-R21047017

> GET /Draft-R21047017 HTTP/1.1
> Host: 127.0.0.1:8732
> User-Agent: curl/7.68.0
> Accept: */*
>

< HTTP/1.1 200 OK
< Date: Fri, 12 Mar 2021 09:21:51 GMT
< Content-Type: text/plain; charset=utf-8
< Content-Length: 117
< Server: NoRFC/1.04
<

Document: Draft-R21047017
...

Format of the JSON response: