https://github.com/mdb/archaeologist
A thin Node.js client for working with the ESRI ArcGIS Server REST API.
https://github.com/mdb/archaeologist
Last synced: about 1 year ago
JSON representation
A thin Node.js client for working with the ESRI ArcGIS Server REST API.
- Host: GitHub
- URL: https://github.com/mdb/archaeologist
- Owner: mdb
- Created: 2013-02-14T02:35:41.000Z (over 13 years ago)
- Default Branch: master
- Last Pushed: 2014-08-28T11:39:40.000Z (almost 12 years ago)
- Last Synced: 2025-04-09T18:16:15.885Z (about 1 year ago)
- Language: JavaScript
- Size: 179 KB
- Stars: 11
- Watchers: 2
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
[](https://travis-ci.org/mdb/archaeologist)
# Archaeologist
A thin Node.js client for working with the [ESRI ArcGIS Server REST API](http://gis.phila.gov/ArcGIS/SDK/REST/index.html?catalog.html).
The ESRI ArgGIS Server Rest API is somewhat confusing. Archaeologist seeks to help.
## Example Usage
Basic usage:
```javascript
var Arc = require('archaeologist');
var arc = new Arc({
apiHost: 'http://host.com',
apiPathBase: '/path/to/service'
});
arc.get({where: "SOMEFIELD='SomeValue'"}, function (error, data) {
/*
performs a get request to:
http://host.com/path/to/service?where=SOMEFIELD='SomeValue'&returnCountOnly=false&returnIdsOnly=false&returnGeometry=false&outSR=4326&outFields=*&f=json
*/
if (error) return error;
console.log(data);
});
```
Overriding default response options:
```javascript
var Arc = require('archaeologist');
var arc = new Arc({
apiHost: 'http://host.com',
apiPathBase: '/path/to/service'
});
arc.get({
where: "SOMEFIELD='SomeValue'",
returnCountOnly: true,
outFields: ['somefield']
}, function (error, data) {
/*
performs a get request to:
http://host.com/path/to/service?returnCountOnly=true&returnIdsOnly=false&returnGeometry=true&maxAllowableOffset=&outputSpatialReference=&outFields=somefield&where=SOMEFIELD='SomeValue'&f=json
*/
if (error) return error;
console.log(data);
});
```
## Configuration
View settings:
```javascript
arc.settings
```
Specifying new settings on instantiation:
```javascript
var arc = new Arc({
apiHost: 'http://host.com',
apiPathBase: '/path/to/service',
defaultResultOptions: {
outFields: ['field', 'anotherField'],
}
});
```
View original, default settings:
```javascript
arc.defaultSettings
/*
{
apiHost: undefined,
apiPathBase: undefined,
defaultResultOptions: {
returnCountOnly: false,
returnIdsOnly: false,
returnGeometry: false,
maxAllowableOffset: '',
outSR: '4326',
outFields: '*',
f: 'json'
}
}
*/
```