-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathapiary.apib
More file actions
153 lines (126 loc) · 5.66 KB
/
apiary.apib
File metadata and controls
153 lines (126 loc) · 5.66 KB
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
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
FORMAT: 1A
HOST: http://orders.apiblueprint.org/
# OrderAPI
Search and view orders
## Order Collection [/orders]
### List All Orders [GET]
+ Response 200 (application/json)
[
{ "name" : "Karsten Nielsen",
"sku" : "20223",
"price" : 23.95,
"shipTo" : { "name" : "Svend Clausen",
"address" : "Bredgade 10",
"city" : "Odense",
"country" : "Denmark",
"zip" : "5500" },
"bill_to" : { "name" : "Svend Clausen",
"address" : "Bredgade 10",
"city" : "Odense",
"country" : "Denmark",
"zip" : "5500" }
},
{ "name" : "Morten Nielsen",
"sku" : "20223",
"price" : 23.95,
"shipTo" : { "name" : "Liselotte Svendsen",
"address" : "Olof Palme Alle 10",
"city" : "Frederiksberg",
"country" : "Denmark",
"zip" : "2250" },
"billTo" : { "name" : "Liselotte Svendsen",
"address" : "Olof Palme Alle 10",
"city" : "Frederiksberg",
"country" : "Denmark",
"zip" : "2250" }
}
]
## Order [/orders/{order_id}]
Search for orders based on OrderID
+ Parameters
+ order_id (number) - ID of the Question in the form of an integer
### View an Order [GET]
+ Response 200 (application/json)
{ "name" : "Svend GET Nielsen",
"sku" : "20223",
"price" : 23.95,
"shipTo" : { "name" : "Svend Clausen",
"address" : "Bredgade 10",
"city" : "Odense",
"country" : "Denmark",
"zip" : "5500" },
"billTo" : { "name" : "Svend Clausen",
"address" : "Bredgade 10",
"city" : "Odense",
"country" : "Denmark",
"zip" : "5500" }
}
### View an Order [PUT]
+ Response 200 (application/json)
{ "name" : "Karsten PUT Nielsen",
"sku" : "20223",
"price" : 23.95,
"shipTo" : { "name" : "Svend Clausen",
"address" : "Bredgade 10",
"city" : "Odense",
"country" : "Denmark",
"zip" : "5500" },
"billTo" : { "name" : "Svend Clausen",
"address" : "Bredgade 10",
"city" : "Odense",
"country" : "Denmark",
"zip" : "5500" }
}
### Delete an Order [DELETE]
+ Response 200 (application/json)
{ "name" : "Karsten DELETE Nielsen",
"sku" : "20223",
"price" : 23.95,
"shipTo" : { "name" : "Svend Clausen",
"address" : "Bredgade 10",
"city" : "Odense",
"country" : "Denmark",
"zip" : "5500" },
"billTo" : { "name" : "Svend Clausen",
"address" : "Bredgade 10",
"city" : "Odense",
"country" : "Denmark",
"zip" : "5500" }
}
## Order Search [/orders{?date,customer}]
Search for orders based on date and customer ID
+ Parameters
+ date (string) - the order date for the order
+ customer (string) - the customer ID for customer
### Search an Order [GET]
+ Response 200 (application/json)
{ "name" : "Karsten GET URL Nielsen",
"sku" : "20223",
"price" : 23.95,
"shipTo" : { "name" : "Svend Clausen",
"address" : "Bredgade 10",
"city" : "Odense",
"country" : "Denmark",
"zip" : "5500" },
"billTo" : { "name" : "Svend Clausen",
"address" : "Bredgade 10",
"city" : "Odense",
"country" : "Denmark",
"zip" : "5500" }
}
### Search an Order [POST]
+ Response 200 (application/json)
{ "name" : "Karsten POST URL Nielsen",
"sku" : "20223",
"price" : 23.95,
"shipTo" : { "name" : "Svend Clausen",
"address" : "Bredgade 10",
"city" : "Odense",
"country" : "Denmark",
"zip" : "5500" },
"billTo" : { "name" : "Svend Clausen",
"address" : "Bredgade 10",
"city" : "Odense",
"country" : "Denmark",
"zip" : "5500" }
}