-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathapiary.apib
139 lines (99 loc) · 3.57 KB
/
apiary.apib
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
FORMAT: 1A
HOST: http://broadbean.meteor.com/api
# Exertis Micro-P Jobs Board
API for posting and retrieving Jobs
# Group Job
Job related resources
## Job Collection [/job]
### List Jobs [GET]
This resource has the following attributes
- `id` ...TBD
+ Response 200 (application/hal+json)
[{"job":{"command":["add"],
"username":["bobsmith"],
"password":["p455w0rd"],
"contact_name":["Bob Smith"],
"contact_email":["[email protected]"],
"contact_telephone":["020 7987 6900"],
"contact_url":["www.smith.com"],
"days_to_advertise":["7"],
"application_email":["[email protected]"],
"application_url":["http://www.url.com/ad.asp?adid=12345123"],
"job_reference":["abc123"],
"job_title":"Test Engineer 1390429894480",
"job_type":["Contract"],
"job_duration":["6 Months"],
"job_startdate":["ASAP"],
"job_skills":["VB, C++, PERL, Java"],
"job_description":["This is the detailed description"],
"job_location":["London"],
"job_industry":["Marketing"],
"salary_currency":["gbp"],
"salary_from":["25000"],
"salary_to":["30000"],
"salary_per":["annum"],
"salary_benefits":["Bonus and Pension"],
"salary":["£25000 - £30000 per annum + Bonus and Pension"],
"_id":"8sAHXJnbfDhLynqqn"}
}]
### Create Job [POST]
This resource has the following attributes
- `email` ...TBD
+ Request (application/json)
{ tbd }
+ Response 201
{
"success": true | false,
"message": "description of outcome or failure"
}
+ Response 409
{
"message" : "The platform Fancy Platform already exists. Platform names must be unique"
}
## Job [/job/{id}]
The `Job` resource has the following attributes
- `id` ...TBD
+ Model
HAL+JSON representation of the platform
+ Body
{"job":{"command":["add"],
"username":["bobsmith"],
"password":["p455w0rd"],
"contact_name":["Bob Smith"],
"contact_email":["[email protected]"],
"contact_telephone":["020 7987 6900"],
"contact_url":["www.smith.com"],
"days_to_advertise":["7"],
"application_email":["[email protected]"],
"application_url":["http://www.url.com/ad.asp?adid=12345123"],
"job_reference":["abc123"],
"job_title":"Test Engineer 1390429894480",
"job_type":["Contract"],
"job_duration":["6 Months"],
"job_startdate":["ASAP"],
"job_skills":["VB, C++, PERL, Java"],
"job_description":["This is the detailed description"],
"job_location":["London"],
"job_industry":["Marketing"],
"salary_currency":["gbp"],
"salary_from":["25000"],
"salary_to":["30000"],
"salary_per":["annum"],
"salary_benefits":["Bonus and Pension"],
"salary":["£25000 - £30000 per annum + Bonus and Pension"],
"_id":"8sAHXJnbfDhLynqqn"}
}
### Get Job [GET]
+ Parameters
+ id (string, required) ... The id of the `Job` to retrieve (MongoDB document _id)
+ Response 200 (application/hal+json)
[Job][]
+ Response 401
+ Response 403
### Delete Job [DELETE]
+ Parameters
+ id (string, required) ... The id of the `Job` to retrieve (MongoDB document _id)
+ Response 200 (application/hal+json)
[Job][]
+ Response 401
+ Response 403