apc-domain/README.md

APC Domain Information Package

# apc-domain
A list of deopts, and also other useful bits and pieces.

Depot List
Pod Codes
Services
Scan Types

## Usage : 

* Install the APC-Depot List using npm : 
`npm install APCOvernight/apc-domain#1.01`
* Within your project, require the Depot list : 
`let Depots = require('apc-domain')`
* The list of depots can now be refined using map / reduce to fill drop down lists, etc.

The Depot list contains lots of data about depots - an example depot is provided here : 
```
 { number: 86,
    name: 'XPRESS DESPATCH LIMITED',
    address1: 'UNIT 1 AIRLINK INDUSTRIAL EST',
    address2: 'INCHINNAN ROAD',
    address3: 'PAISLEY',
    address4: 'RENFEWSHIRE',
    PostCode: 'PA3 2RS',
    contact: 'KEVIN LAURA DAVID',
    itcontact: '',
    telephone: '08450 611612',
    fax: '08450 612613',
    oohtel: '',
    oohname1: 'GORDON',
    oohtel1: '',
    oohmobile1: '07725 760500',
    oohname2: 'KEVIN',
    oohtel2: '',
    oohmobile2: '07812 026055',
    priname: 'THOMAS WELCH',
    priname2: '',
    pritel: '',
    primobile: '',
    sageacctno: 'XPR86',
    VATNumber: '947 3194 95',
    deproutein: 422,
    deprouteou: 422,
    comments: '',
    postcodes1: '',
    postcodes2: '',
    postcodes3: '',
    postcodes4: '',
    inputdep: true,
    delivdep: true,
    sharehold: false,
    boardmem: false,
    delivzone: '',
    prealert09: false,
    prealerts: false,
    email: '',
    website: '',
    scottish: true,
    HubBay: 'BELT H+C/ BAY 02',
    Region: '5',
    town: 'PAISLEY',
    trunkposi: '',
    trunkposo: '',
    trunkarri: '',
    trunkdepi: '',
    trunkarro: '',
    trunkdepo: '',
    speeddial: '',
    ooainvrate: '',
    ooaselrate: '',
    auditor: 'CL',
    trunkop: '',
    depotloc: 86,
    location: '',
    primarykey: '' }
```

## Future improvements
Currently this library only includes depot information - but perhaps it could be extended to include available services