STARTER TUTORIAL #5 : ADD an action to create a consumption log entry

[mdrobisch]

See #78 for the previous step

• Adds an action to create a consumption log
  • You can test the new action by sending the following http-request (json) to 127.0.0.1:5000/api/v1

  • 
    "actions" : [
    {
      "workspace" : "invoices",
      "action" : "createConsumptionLog",
      "guestEmail" : "konglomerat@konglomerat.org",
      "guestIsMember" : true,
      "serviceArea" : "Laser",
      "serviceName" : "Cameo",
      "serviceQuantity" : 42.0,
      "serviceUnit" : "min"
    }
    ]
    }

  • You may use http basic auth to authenticate
  • see devEnv.py for default user-name and passwords
  • you need to enable http basic auth by allow_basic_authentication= True in config.ini
  • It will add a entry to the database
  • In return you will get

  • 
    {
    "head": {
    "version": "0.2.2"
    },
    "actions": [
     {
       "action": "notify",
       "target": "webclient",
       "version": "1.0.0",
       "source": "server",
       "delay": 0.0,
       "message": "Consumption log created",
       "messagetype": "success"
     }
    ],
    "response": {
     "custom": "customResponse"
    }
    }

  • Please note the response property as a easy way to add non-action response (metadata) to the action-reply
  • It can be added as (optional) 3th return parameter from a action-handle
  • In reference to: return "success", replyActions, {"custom": "customResponse"}

HINT: Please do not merge this. This Pull Request is ment to be a starting point for new developers.

See #80 for the next step