Pavers API

Module: Misc

A set of endpoints used for testing interactions from the caller
Since:
  • 20/07/2018
Author:
  • Fabio

Members

<route> downloads

Route:
MethodPath
GET /api/v1/download
returns files
Query Parameters:
Name Type Description
fileName string the name of the file to download
Since:
  • 25/05/2018
Author:
  • Dave
See:
  • HeelRealm.Splash
Example
/api/v1/download?fileName=FileName

<static> generateEmail

Email Functions
Since:
  • 01/11/2017
Author:
  • Dave
See:
  • sendEmails.js

<route> getBasicProduct

Route:
MethodPath
GET /api/v1/misc/product
returns an object of basic product details
Query Parameters:
Name Type Description
posCode string The item to search
Since:
  • 18/10/2017
Author:
  • Dave
See:
  • FlatsRealm.API.getBasicProduct
Example
/api/v1/misc/product?posCode=01333490

<static> getBranchLongLat

returns a branch long and lat
Query Parameters:
Name Type Description
branchName string the name of the branch to Lookup
Since:
  • 25/05/2018
Author:
  • Dave
See:
  • PaversAPI.DarkSky.getWeatherFromDarkSky

<route> heartBeat

Route:
MethodPath
GET /api/v1/heartbeat
returns a 204 if the server can be contacted
Since:
  • 01/11/2017
Author:
  • Dave
See:
  • HeelRealm.Helper.checkWifi
Example
/api/v1/heartbeat

<static> receipt

Generates a receipt for attaching to email
Since:
  • 08/11/2017
Author:
  • Dave
See:
  • EReceipts\sendEmails.js

Module: Misc

A module that manages all other controllers
Since:
  • 01/11/2017
Author:
  • Dave

Members

<route> downloads

Route:
MethodPath
GET /api/v1/download
returns files
Query Parameters:
Name Type Description
fileName string the name of the file to download
Since:
  • 25/05/2018
Author:
  • Dave
See:
  • HeelRealm.Splash
Example
/api/v1/download?fileName=FileName

<static> generateEmail

Email Functions
Since:
  • 01/11/2017
Author:
  • Dave
See:
  • sendEmails.js

<route> getBasicProduct

Route:
MethodPath
GET /api/v1/misc/product
returns an object of basic product details
Query Parameters:
Name Type Description
posCode string The item to search
Since:
  • 18/10/2017
Author:
  • Dave
See:
  • FlatsRealm.API.getBasicProduct
Example
/api/v1/misc/product?posCode=01333490

<static> getBranchLongLat

returns a branch long and lat
Query Parameters:
Name Type Description
branchName string the name of the branch to Lookup
Since:
  • 25/05/2018
Author:
  • Dave
See:
  • PaversAPI.DarkSky.getWeatherFromDarkSky

<route> heartBeat

Route:
MethodPath
GET /api/v1/heartbeat
returns a 204 if the server can be contacted
Since:
  • 01/11/2017
Author:
  • Dave
See:
  • HeelRealm.Helper.checkWifi
Example
/api/v1/heartbeat

<static> receipt

Generates a receipt for attaching to email
Since:
  • 08/11/2017
Author:
  • Dave
See:
  • EReceipts\sendEmails.js