Switch to unified view

a/readme.md b/readme.md
...
...
57
    "success": true,
57
    "success": true,
58
    "data": [
58
    "data": [
59
        {
59
        {
60
            "rulesID": 11,
60
            "rulesID": 11,
61
            "description": "New Rule",
61
            "description": "New Rule",
62
            "parameters": "slumptest,corrigir",
63
            "parameter": "slumptest",
62
            "parameter": "slumptest",
64
            "conditionValue": ">",
63
            "conditionValue": ">",
65
            "controlValue": "5",
64
            "controlValue": "5",
66
            "notificationType": 5,
65
            "notificationType": 5,
67
            "token": "fgTJAyuX0M4tpn1P2WXAJmRbDH7hwbVhZsL26Ca1Ecm"
66
            "token": "fgTJAyuX0M4tpn1P2WXAJmRbDH7hwbVhZsL26Ca1Ecm"
...
...
76
`GET /api/vf-os-enabler/<api_version>/getRules/<app_id>`
75
`GET /api/vf-os-enabler/<api_version>/getRules/<app_id>`
77
76
78
#### URL Parameters
77
#### URL Parameters
79
78
80
Resource Parameter | Description
79
Resource Parameter | Description
81
 | ----
80
------------------ | -----------
82
api_version | Identifies the API version that will be used for the request
81
api_version        | Identifies the API version that will be used for the request.
83
app_id | Identifies the APP
82
app_id             | Identifies the APP.
84
83
85
84
86
#### Return Payload
85
#### Return Payload
87
86
88
The API response will contain a JSON document with the property `success`: **true**, **false** and the `data` with the rules of app (if found).
87
The API response will contain a JSON document with the property `success`: **true**, **false** and the `data` with the rules of app (if found).
...
...
95
    "success": true,
94
    "success": true,
96
    "data": [
95
    "data": [
97
        {
96
        {
98
            "rulesID": 11,
97
            "rulesID": 11,
99
            "description": "New Rule",
98
            "description": "New Rule",
100
            "parameters": "slumptest,corrigir",
101
            "parameter": "slumptest",
99
            "parameter": "slumptest",
102
            "conditionValue": ">",
100
            "conditionValue": ">",
103
            "controlValue": "5",
101
            "controlValue": "5",
104
            "notificationType": 5,
102
            "notificationType": 5,
105
            "token": "fgTJAyuX0M4tpn1P2WXAJmRbDH7hwbVhZsL26Ca1Ecm"
103
            "token": "fgTJAyuX0M4tpn1P2WXAJmRbDH7hwbVhZsL26Ca1Ecm"
...
...
108
}
106
}
109
```
107
```
110
108
111
#### Return Codes
109
#### Return Codes
112
Code | Description
110
Code | Description
113
 | ---
111
---- | -----------
114
200 | Data found.
112
200  | Data Found.
115
500 | Internal Server Error - There was an unexpected error at some point during the processing of the request.
113
500  | Internal Server Error - There was an unexpected error at some point during the processing of the request.
116
114
117
115
118
### Enabler 2 - Get Notifications
116
### Enabler 2 - Get Notifications
119
117
120
```http
118
```http
...
...
149
147
150
148
151
#### URL Parameters
149
#### URL Parameters
152
150
153
Resource Parameter | Description
151
Resource Parameter | Description
154
 | ----
152
------------------ | -----------
155
api_version | Identifies the API version that will be used for the request
153
api_version        | Identifies the API version that will be used for the request.
156
app_id | Identifies the APP to show the notifications
154
app_id             | Identifies the APP to show the notifications.
157
155
158
156
159
#### Return Payload
157
#### Return Payload
160
158
161
The API response will contain a JSON document with the property `success`: **true**, **false** and the `data` with the notifications of app (if found).
159
The API response will contain a JSON document with the property `success`: **true**, **false** and the `data` with the notifications of app (if found).
...
...
199
    ]
197
    ]
200
}
198
}
201
```
199
```
202
200
203
#### Return Codes
201
#### Return Codes
204
205
Code | Description
202
Code | Description
206
---- | ----
203
---- | -----------
207
200 | Data Found.
204
200  | Data Found.
208
500 | Internal Server Error - There was an unexpected error at some point during the processing of the request.
205
500  | Internal Server Error - There was an unexpected error at some point during the processing of the request.
209
206
210
207
211
### Enabler 2 - Get Apps
208
### Enabler 2 - Get Apps
212
209
213
```http
210
```http
...
...
227
{
224
{
228
    "success": true,
225
    "success": true,
229
    "data": [
226
    "data": [
230
        {
227
        {
231
            "token": "Es5zfsco57fieoQcDJZuIZxFZWv4HQbBYgUXRgqodQp",
228
            "token": "Es5zfsco57fieoQcDJZuIZxFZWv4HQbBYgUXRgqodQp",
232
            "appID": "MiguelID",
229
            "appID": "myawesomeappid",
233
            "developerID": "miguel.rodrigues@knowledgebiz.pt"
230
            "developerID": "david.aleixo@knowledgebiz.pt"
234
        }
231
        }
235
    ]
232
    ]
236
}
233
}
237
```
234
```
238
Use this API call whenever is needed to retrieve all apps of developerid.
235
Use this API call whenever is needed to retrieve all apps of developerid.
...
...
242
239
243
240
244
#### URL Parameters
241
#### URL Parameters
245
242
246
Resource Parameter | Description
243
Resource Parameter | Description
247
 | ----
244
------------------ | -----------
248
api_version | Identifies the API version that will be used for the request
245
api_version        | Identifies the API version that will be used for the request.
249
developer_id | Identifies the Developer
246
developer_id       | Identifies the Developer.
250
247
251
248
252
#### Return Payload
249
#### Return Payload
253
250
254
The API response will contain a JSON document with the property `success`: **true**, **false** and the `data` with the notifications of app (if found).
251
The API response will contain a JSON document with the property `success`: **true**, **false** and the `data` with the notifications of app (if found).
...
...
268
}
265
}
269
```
266
```
270
267
271
#### Return Codes
268
#### Return Codes
272
Code | Description
269
Code | Description
273
 | ---
270
---- | -----------
274
200 | Data Found.
271
200  | Data Found.
275
500 | Internal Server Error - There was an unexpected error at some point during the processing of the request.
272
500  | Internal Server Error - There was an unexpected error at some point during the processing of the request.
276
273
277
274
278
### Enabler 2 - Delete vApp
275
### Enabler 2 - Delete vApp
279
276
280
```http
277
```http
281
DELETE /api/vf-os-enabler/v0/delete/myawesomeappid
278
DELETE /api/vf-os-enabler/v0/app/myawesomeappid
282
Accept: */*
279
Accept: */*
283
```
280
```
284
281
285
282
286
```http
283
```http
...
...
296
}
293
}
297
```
294
```
298
Use this API call whenever is needed to delete vApp.
295
Use this API call whenever is needed to delete vApp.
299
296
300
#### Request
297
#### Request
301
`GET /api/vf-os-enabler/<api_version>/delete/<app_id>`
298
`GET /api/vf-os-enabler/<api_version>/app/<app_id>`
302
299
303
300
304
#### URL Parameters
301
#### URL Parameters
305
302
306
Resource Parameter | Description
303
Resource Parameter | Description
307
 | ----
304
------------------ | -----------
308
api_version | Identifies the API version that will be used for the request
305
api_version        | Identifies the API version that will be used for the request.
309
app_id | Identifies the APP
306
app_id             | Identifies the APP.
310
307
311
308
312
#### Return Payload
309
#### Return Payload
313
310
314
The API response will contain a JSON document with the property `success`: **true**, **false**.
311
The API response will contain a JSON document with the property `success`: **true**, **false**.
...
...
320
    "success": true
317
    "success": true
321
}
318
}
322
```
319
```
323
320
324
#### Return Codes
321
#### Return Codes
322
325
Code | Description
323
Code | Description
326
--- | ---
324
---- | ---
327
200 | vApp deleted successfully.
325
200  | vApp deleted successfully.
328
500 | Internal Server Error - There was an unexpected error at some point during the processing of the request.
326
500  | Internal Server Error - There was an unexpected error at some point during the processing of the request.
329
327
330
328
331
329
332
### Enabler 2 - Delete Rules
330
### Enabler 2 - Delete Rules
333
331
334
```http
332
```http
335
DELETE /api/vf-os-enabler/v0/deleteRule/1
333
DELETE /api/vf-os-enabler/v0/rule/1
336
Accept: */*
334
Accept: */*
337
```
335
```
338
336
339
337
340
```http
338
```http
...
...
350
}
348
}
351
```
349
```
352
Use this API call whenever is needed to delete rule of vApp.
350
Use this API call whenever is needed to delete rule of vApp.
353
351
354
#### Request
352
#### Request
355
`GET /api/vf-os-enabler/<api_version>/deleteRule/<rule_id>`
353
`GET /api/vf-os-enabler/<api_version>/rule/<rule_id>`
356
354
357
355
358
#### URL Parameters
356
#### URL Parameters
359
357
360
Resource Parameter | Description
358
Resource Parameter | Description
361
 | ----
359
------------------ | -----------
362
api_version | Identifies the API version that will be used for the request
360
api_version        | Identifies the API version that will be used for the request.
363
rule_id | Identifies the Rule
361
rule_id            | Identifies the Rule.
364
362
365
363
366
#### Return Payload
364
#### Return Payload
367
365
368
The API response will contain a JSON document with the property `success`: **true**, **false**.
366
The API response will contain a JSON document with the property `success`: **true**, **false**.
...
...
375
}
373
}
376
```
374
```
377
375
378
#### Return Codes
376
#### Return Codes
379
Code | Description
377
Code | Description
380
 | ---
378
---- | -----------
381
200 | Rule deleted successfully.
379
200  | Rule deleted successfully.
382
500 | Internal Server Error - There was an unexpected error at some point during the processing of the request.
380
500  | Internal Server Error - There was an unexpected error at some point during the processing of the request.
383
381
384
382
385
### Enabler 2 - Create Notifications
383
### Enabler 2 - Create Notifications
386
384
387
```http
385
```http
...
...
404
```
402
```
405
403
406
Use this API call whenever is needed to create a new notification.
404
Use this API call whenever is needed to create a new notification.
407
405
408
#### Request
406
#### Request
409
`POST /api/vf-os-enabler/<api_version>/enabler/notifications`
407
`POST /api/vf-os-enabler/<api_version>/notifications`
410
408
411
#### URL Parameters
409
#### URL Parameters
412
410
413
Resource Parameter | Description
411
Resource Parameter | Description
414
 | ----
412
------------------ | -----------
415
api_version | Identifies the API version that will be used for the request
413
api_version        | Identifies the API version that will be used for the request.
416
414
417
#### JSON Body Payload
415
#### JSON Body Payload
418
416
419
Name    | Required    | Type | Description
417
Name    | Required    | Type   | Description
420
------- | ----------- | ---- |
418
------- | ----------- | ------ | -----------
421
emailTo |    Yes      | JSON | JSON document where is the value of emailTo.  
419
emailTo |    Yes      | STRING | String where is the emails.  
422
token   |    Yes      | JSON | JSON document where is the value of token. 
420
token   |    Yes      | STRING | String where is the token. 
423
body    |    Yes      | JSON | JSON document where is the value of subject and subjectValue. 
421
body    |    Yes      | JSON   | JSON document where is the subject and subjectValue. 
424
422
425
Example of JSON body payload structure: 
423
Example of JSON body payload structure: 
426
`   {
424
`   {
427
        "emailTo": [
425
        "emailTo": [
428
            "string",
426
            "string",
...
...
456
```
454
```
457
455
458
#### Return Codes
456
#### Return Codes
459
Code | Description
457
Code | Description
460
---- | ----
458
---- | ----
461
200 | Notification created successfully.
459
200  | Notification created successfully.
462
500 | Internal Server Error - There was an unexpected error at some point during the processing of the request.
460
500  | Internal Server Error - There was an unexpected error at some point during the processing of the request.
463
461
464
462
465
### Enabler 2 - Register vApp
463
### Enabler 2 - Register vApp
466
464
467
```http
465
```http
468
POST http://localhost:8000/api/vf-os-enabler/v0/register
466
POST http://localhost:8000/api/vf-os-enabler/v0/register
469
Accept: */*
467
Accept: */*
470
Content-Type: application/json; charset=utf-8
468
Content-Type: application/json; charset=utf-8
471
469
472
{"body":[{"my_key":"my_value"},{"my_key":"my_value"}]}
470
{"appID":["my_appID1","my_appID2"],"developerID":["my_developerID","my_developerID"]}
473
```
471
```
474
472
475
```http
473
```http
476
HTTP/1.1 200 OK
474
HTTP/1.1 200 OK
477
Content-type: application/json
475
Content-type: application/json
...
...
487
```
485
```
488
486
489
Use this API call whenever is needed to create vApp.
487
Use this API call whenever is needed to create vApp.
490
488
491
#### Request
489
#### Request
492
`POST /api/vf-os-enabler/<api_version>/enabler/register`
490
`POST /api/vf-os-enabler/<api_version>/register`
493
491
494
#### URL Parameters
492
#### URL Parameters
495
493
496
Resource Parameter | Description
494
Resource Parameter | Description
497
 | ----
495
------------------ | -----------
498
api_version | Identifies the API version that will be used for the request
496
api_version        | Identifies the API version that will be used for the request.
499
497
500
#### JSON Body Payload
498
#### JSON Body Payload
501
499
502
Name | Required | Type | Description
500
Name          | Required    | Type   | Description
503
 | ---- | ---- | ---
501
------------- | ----------- | ------ | -----------
504
body | Yes | JSON | JSON document where the custom notification parameters are. Example: [{"appID" : "KBZ"},{"developerID" : "miguel.rodrigues@knowledgebiz.pt"}]
502
appID         |    Yes      | STRING | String where is the appID.  
503
developerID   |    Yes      | STRING | String where is the developerID.  
504
505
Example of JSON body payload structure: 
506
`   {
507
        "appID": [
508
            "string",
509
            "string"
510
         ],
511
        "developerID": [
512
            "string",
513
            "string"
514
         ],
515
    }`
505
516
506
#### Return Payload
517
#### Return Payload
507
518
508
The API response will contain a JSON document with the property `success`: **true**, **false** and the `data` if the `success` became **false**.
519
The API response will contain a JSON document with the property `success`: **true**, **false** and the `data` if the `success` became **false**.
509
520
...
...
519
```
530
```
520
531
521
#### Return Codes
532
#### Return Codes
522
Code | Description
533
Code | Description
523
---- | ----
534
---- | ----
524
200 | vApp created successfully.
535
200  | vApp created successfully.
525
500 | Internal Server Error - There was an unexpected error at some point during the processing of the request.
536
500  | Internal Server Error - There was an unexpected error at some point during the processing of the request.
526
537
527
### Enabler 2 - Create Rules
538
### Enabler 2 - Create Rules
528
539
529
```http
540
```http
530
POST http://localhost:8000/api/vf-os-enabler/v0/notification/rules
541
POST http://localhost:8000/api/vf-os-enabler/v0/notification/rules
531
Accept: */*
542
Accept: */*
532
Content-Type: application/json; charset=utf-8
543
Content-Type: application/json; charset=utf-8
533
544
534
{"body":[{"my_key":"my_value"},{"my_key":"my_value"},{"my_key":"my_value"},{"my_key":"my_value"},{"my_key":"my_value"},{"my_key":"my_value"},{"my_key":"my_value"]}
545
{"appID":"my_appID","description":"my_description","parameter":"my_parameter","conditionValue":"my_conditionValue","controlValue":"my_controlValue","notificationType":"my_notificationType"}
535
```
546
```
536
547
537
```http
548
```http
538
HTTP/1.1 200 OK
549
HTTP/1.1 200 OK
539
Content-type: application/json
550
Content-type: application/json
...
...
548
```
559
```
549
560
550
Use this API call whenever is needed to create a rule of vApp.
561
Use this API call whenever is needed to create a rule of vApp.
551
562
552
#### Request
563
#### Request
553
`POST /api/vf-os-enabler/<api_version>/enabler/rules`
564
`POST /api/vf-os-enabler/<api_version>/notification/rules/`
554
565
555
#### URL Parameters
566
#### URL Parameters
556
567
557
Resource Parameter | Description
568
Resource Parameter | Description
569
------------------ | -----------
570
api_version        | Identifies the API version that will be used for the request.
571
572
#### JSON Body Payload
573
574
Name             | Required | Type   | Description
575
---------------- | -------- | ------ | -----------
576
appID            | Yes      | STRING | String where is the vAppID. 
577
description      | Yes      | STRING | String where is the description.
578
parameter        | Yes      | STRING | String where is the parameter for the rule.
579
conditionValue   | Yes      | STRING | String where is the conditionValue (>, <, >=, <=, ==).
580
controlValue     | Yes      | STRING | String where is the controlValue (Threshold).
581
notificationType | Yes      | STRING | String where is the Notification Type (1 - Notify End of Month, 2 - Notify End of Two Weeks, 3 - Notify End of Week, 4 - Notify End of Three Days, 5 - Notify Immediately).
582
583
Example of JSON body payload structure: 
584
`   {
585
        "appID": "string",
586
        "description": "string",
587
        "parameter": "string",
588
        "conditionValue": "string",
589
        "controlValue": "string",
590
        "notificationType": "string"
591
    }`
592
593
#### Return Payload
594
595
The API response will contain a JSON document with the property `success`: **true**, **false** and the `reason` if the `success` became **false**.
596
597
Example:
598
599
```json
600
{
601
     "success": true
602
}
603
```
604
605
#### Return Codes
606
Code | Description
558
---- | ----
607
---- | ----
559
api_version | Identifies the API version that will be used for the request
560
561
#### JSON Body Payload
562
563
Name | Required | Type | Description
564
 | ---- | ---- | ---
565
body | Yes | JSON | JSON document where the custom notification parameters are. Example: [{"appID" : "KBZ"},{"description" : "So many Tests"},{"parameter" : "Test"},{"conditionValue" : ">"},{"controlValue" : "100"},{"notificationType" : "5"}]
566
567
#### Return Payload
568
569
The API response will contain a JSON document with the property `success`: **true**, **false** and the `reason` if the `success` became **false**.
570
571
Example:
572
573
```json
574
{
575
     "success": true
576
}
577
```
578
579
#### Return Codes
580
Code | Description
581
 | ----
582
200 | Rule created successfully.
608
200  | Rule created successfully.
583
500 | Internal Server Error - There was an unexpected error at some point during the processing of the request.
609
500  | Internal Server Error - There was an unexpected error at some point during the processing of the request.
584
610
585
611
586
### Powered by:
612
### Powered by:
587
613
588
![alt text](https://static.wixstatic.com/media/d65bd8_d460ab5a6ff54207a8ac3e7497af18c4~mv2_d_4201_2594_s_4_2.png "Notification Enabler")
614
![alt text](https://static.wixstatic.com/media/d65bd8_d460ab5a6ff54207a8ac3e7497af18c4~mv2_d_4201_2594_s_4_2.png "Notification Enabler")