Skip to content

Latest commit

 

History

History
33 lines (32 loc) · 1.16 KB

README.md

File metadata and controls

33 lines (32 loc) · 1.16 KB

orthanc-client Build Status

An Orthanc REST API client designed for NodeJS.

Installation

$ npm install orthanc-client

Usage

var oc = require('orthanc-client');
var client = new oc({
    url: 'http://localhost:8042',
    auth: {
      username: 'foo',
      password: 'bar'
    }
});

client.instances.getAll()
    .then(function(res) {
        console.log(res);
    })
    .catch(function(err) {
        console.log(err);
    });

Documentation

I've written a short documentation for each implemented functions. You can read it in the DOCUMENTATION.md file. Feel free to improve it and send a pull request.

REST API

You'll find the quick reference for Orthanc's REST API here

License

Copyright 2015 - Frédéric Woelffel Published under the MIT open source license. See full license in LICENSE.txt