https://github.com/fwoelffel/orthanc-client

An Orthanc client for node.js
https://github.com/fwoelffel/orthanc-client

dicom nodejs orthanc

Last synced: 5 months ago
JSON representation

An Orthanc client for node.js

• Host: GitHub
• URL: https://github.com/fwoelffel/orthanc-client
• Owner: fwoelffel
• License: mit
• Archived: true
• Created: 2015-05-24T12:18:35.000Z (about 10 years ago)
• Default Branch: master
• Last Pushed: 2018-01-07T12:49:43.000Z (over 7 years ago)
• Last Synced: 2025-01-18T21:48:24.876Z (5 months ago)
• Topics: dicom, nodejs, orthanc
• Language: JavaScript
• Homepage:
• Size: 84 KB
• Stars: 27
• Watchers: 3
• Forks: 6
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
# orthanc-client [![Build Status](https://travis-ci.org/FWoelffel/orthanc-client.svg?branch=master)](https://travis-ci.org/FWoelffel/orthanc-client)

An [Orthanc](http://www.orthanc-server.com) REST API client designed for NodeJS.

# Installation

```

$ npm install orthanc-client

```

# Usage

```javascript

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](https://github.com/FWoelffel/orthanc-client/blob/master/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](https://docs.google.com/spreadsheets/d/1muKHMIb9Br-59wfaQbDeLzAfKYsoWfDSXSmyt6P4EM8/pub?single=true&gid=22&output=html)

# License

Copyright 2015 - Frédéric Woelffel

Published under the MIT open source license.

See full license in LICENSE.txt