Pavers API

Module: ShopNets

A module that manages ShopNet Routes
Since:
  • 14/09/2017
Author:
  • Dave

Members

<route> getShopNetDetailLists

Route:
MethodPath
GET /api/v1/shopNet/detailList
returns a list of shopnet detailLists
Since:
  • 15/09/2017
Author:
  • Dave
See:
  • HeelsRealm.SplashActivity.shopNetListDetails
Example
/api/v1/shopNet/detailList

<route> getShopNetGroups

Route:
MethodPath
GET /api/v1/shopNet/groups
returns a list of shopnet groups
Since:
  • 15/09/2017
Author:
  • Dave
See:
  • HeelsRealm.SplashActivity.getShopNetGroups
Example
/api/v1/shopNet/groups

<route> getShopNetHeaders

Route:
MethodPath
GET /api/v1/shopNet/messageHeaders
returns a list of shopnet headers for a branch
Query Parameters:
Name Type Description
userID int The user to retrieve messages for
messageCount int The amount of messages to retrieve
messageCount boolean Get Only sent messages
Since:
  • 15/09/2017
Author:
  • Dave
See:
  • HeelsRealm.SplashActivity.getShopNetGroups
  • HeelsRealm.CheckMessageFragment.refreshMessages
Example
/api/v1/shopNet/messageHeaders?userID=271&messageCount=10&sentMessages=0

<route> getShopNetMasterList

Route:
MethodPath
GET /api/v1/shopNet/masterList
returns a list of shopnet masterLists
Since:
  • 15/09/2017
Author:
  • Dave
See:
  • HeelsRealm.SplashActivity.getShopnetMasterList
Example
/api/v1/shopNet/masterList

<route> getShopNetMessage

Route:
MethodPath
GET /api/v1/shopNet/message
returns a single message by id
Query Parameters:
Name Type Description
messageID int the id of the message to load
Since:
  • 15/09/2017
Author:
  • Dave
See:
  • HeelsRealm.CheckMessageFragment.loadSingleMessageFromAPI
Example
/api/v1/shopNet/message?messageID=456465

<route> getShopNetUsers

Route:
MethodPath
GET /api/v1/shopNet/users
returns a list of shopnet users
Since:
  • 15/09/2017
Author:
  • Dave
See:
  • HeelsRealm.SplashActivity.getShopNetUsers
Example
/api/v1/shopNet/users

<route> postMessageUpdate

Route:
MethodPath
POST /api/v1/shopNet/message/status
posts a status update to a message
Since:
  • 21/09/2017
Author:
  • Dave
See:
  • HeelsRealm.CheckMessageFragment.messageAction
Example
/api/v1/shopNet/message/status {body}

<route> sendShopnet

Route:
MethodPath
POST /api/v1/shopNet/message
saves and sends a new shopnet message
Query Parameters:
Name Type Description
req.body.subject string The subject of the shopnet
req.body.messageFrom int The branchID of who is sending the message
req.body.messageTo int The group id of where the message is going
req.body.isRestricted int Restricted to Branch Manager
req.body.headOfRetail int CC Gary Gordon
req.body.requiresAcknowledgement int Requires Acknowledgement
req.body.message string The message itself
req.body.sendList string A string list of IDS to sendTo
Since:
  • 20/11/2017
Author:
  • Dave
See:
  • HeelsRealm.SendMessageFragment.???
Example
/api/v1/shopNet/message {POST}