-
Notifications
You must be signed in to change notification settings - Fork 0
/
data.txt
91 lines (84 loc) · 1.76 KB
/
data.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
=== CLASSES ===
class Recipient {
"first_name": String,
"last_name": String,
"email": String,
"placeholders": {
// ex: "Position": "Product Manager", "Company": "Apple Inc.", ...
}
}
=== DATABASE CONTENT ===
collection tracks: {
"_id": some type of object, created automatically (DO NOT CREATE!),
"first_name": String,
"last_name": String,
"email": String,
"sent_to": String,
"status": String,
"desc": String
}
collection templates: {
"_id": some type of object, created automatically (DO NOT CREATE!),
"template": String,
"type": String
}
=== STATUS CODES ===
ER: Error
SC: Success
NR: No Reply
RN: Reply Negative
RP: Reply Positive
UN: Uncertain ?
=== ENDPOINTS ===
/send --> POST
input: {
"recipients": Array<Recipient>,
"own_email": String,
"type": String
}
output: {
"status": "ER" or "SC"
}
/track --> POST
input: {
"email": String,
"first_name": String,
"last_name": String,
"sent_to": String
}
output: {
"status": "ER" or "SC"
}
/template --> POST/GET
POST:
input: {
"template": String
"type": String
}
output: {
"status": "ER" or "SC"
}
GET:
input: ?type=<String>
output: {
"template": String
}
or {
"status": "ER"
}
/getListOfRecipients --> GET
input: ?own_email=<String>
output: {
"recipients": Array<String>
}
/getRecipient --> GET
input: ?recipient=<String>
output: {
"first_name": String,
"last_name": String,
"status": "NR" or "RN" or "RP" or "UN",
"desc": String
}
or {
"status": "ER"
}