-
Notifications
You must be signed in to change notification settings - Fork 0
/
opportunities_v6_05022024.yaml
353 lines (353 loc) · 10.4 KB
/
opportunities_v6_05022024.yaml
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
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
openapi: 3.0.0
info:
title: Developer V6 API - Opportunities
version: 1.0.0
servers:
- url: https://dpdhlstg.edcastpreview.com
- url: https://dpdhlsandbox.edcast.com
paths:
/api/developer/v6/opportunities/recommended:
get:
tags:
- default
summary: Fetch recommended job or role based on user_id
parameters:
- name: X-API-KEY
in: header
schema:
type: string
description: Use API key from Developer API credentials
example: '{{dev6_api_key}}'
- name: X-ACCESS-TOKEN
in: header
schema:
type: string
description: JWT Access Token generated from Auth request
example: '{{dev6_access_token}}'
- name: user_id
in: query
description: "User id, Supported format ID-, EMAIL-, EXT-"
required: true
schema:
type: string
- name: opportunity_type
in: query
description: "Opportunity type of either job_vacancy or job_role, default: job_role"
required: false
schema:
type: string
- name: iso_language
in: query
required: false
schema:
type: string
- name: recommendations_count
in: query
required: false
schema:
type: integer
default: 15
maximum: 100
minimum: 1
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/UserOpportunityMatchResultDtoArrayResponse'
'404':
description: Profile not found in opportunity marketplace
content:
application/json:
examples:
UserOpportunityMatchResultDtoResponseError:
$ref: '#/components/examples/UserOpportunityMatchResultDtoResponseError'
/api/developer/v6/opportunities:
get:
summary: List all job opportunities
parameters:
- name: user_id
in: query
description: "User id, Supported format ID-, EMAIL-, EXT-"
required: true
schema:
type: string
- name: page
in: query
description: "Page number. Default: 1"
required: false
schema:
type: integer
- name: limit
in: query
description: "Number of opportunities. Default: 15"
required: false
schema:
type: integer
- name: reference_number
in: query
description: "Reference number"
required: false
schema:
type: string
- name: source
in: query
description: "source of job opportunity"
required: false
schema:
type: string
- name: status
in: query
description: "Status of job opportunity"
required: false
schema:
type: string
- name: start_date_time
in: query
description: "Start date time of job opportunity"
required: false
schema:
type: string
- name: end_date_time
in: query
description: "Start date time of job opportunity"
required: false
schema:
type: string
responses:
'200':
description: A list of job opportunities
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Opportunity'
post:
summary: Create opportunity
parameters:
- name: user_id
in: query
description: User id, Supported format ID-, EMAIL-, EXT-
required: true
schema:
type: string
responses:
'200':
description: Successful operation
content:
application/json:
schema:
type: object
properties:
id:
type: integer
title:
type: string
description:
type: string
status:
type: string
source:
type: string
start_date_time:
type: string
end_date_time:
type: string
/api/developer/v6/opportunities/{id}:
get:
summary: Fetch opportunity based on job_vacancy_id
parameters:
- name: user_id
in: query
description: "User id, Supported format ID-, EMAIL-, EXT-"
required: true
schema:
type: string
- name: id
in: path
description: "Id of either job_vacancy or job_role, default: job_vacancy_id"
required: true
schema:
type: string
responses:
'200':
description: A job opportunity
content:
application/json:
schema:
$ref: '#/components/schemas/Opportunity'
put:
summary: Update opportunity based on job_vacancy_id or job_role_id
parameters:
- name: user_id
in: query
description: "User id, Supported format ID-, EMAIL-, EXT-"
required: true
schema:
type: string
- name: id
in: path
description: "Id of either job_vacancy or job_role, default: job_vacancy_id"
required: true
schema:
type: string
responses:
'200':
description: Successful operation
content:
application/json:
schema:
type: object
properties:
id:
type: integer
title:
type: string
description:
type: string
status:
type: string
source:
type: string
start_date_time:
type: string
end_date_time:
type: string
delete:
summary: Delete opportunity based on job_vacancy_id or job_role_id
parameters:
- name: user_id
in: query
description: "User id, Supported format ID-, EMAIL-, EXT-"
required: true
schema:
type: string
- name: id
in: path
description: "Id of either job_vacancy or job_role, default: job_vacancy_id"
required: true
schema:
type: string
responses:
'200':
description: Successful operation
content:
application/json:
schema:
type: object
properties:
id:
type: integer
title:
type: string
description:
type: string
status:
type: string
source:
type: string
start_date_time:
type: string
end_date_time:
type: string
/api/developer/v6/opportunities/tm_config:
get:
summary: Get Talent Marketplace config values
parameters:
- name: type
in: query
description: "Type is nodes from tm_config. Valid Types: talent_marketplace, labels, lovs, configurations, opportunities, aspirations, superadmin_config. Default: Passing all tm_config"
required: false
schema:
type: string
responses:
'200':
description: Successful operation
content:
application/json:
schema:
type: object
components:
examples:
UserOpportunityMatchResultDtoResponseError:
value:
- timestamp: "2022-10-27T14:21:02.755+00:00"
status: 404
error: "Not Found"
message: "Profile not found in opportunity marketplace"
schemas:
UserOpportunityMatchResultDtoArrayResponse:
type: array
items:
anyOf:
- $ref: '#/components/schemas/UserOpportunityMatchResultDtoExample1'
- $ref: '#/components/schemas/UserOpportunityMatchResultDtoExample2'
UserOpportunityMatchResultDtoExample1:
example:
opportunity_type: job_role
id: id0001
title: Junior Software Developer
overall_score: 80
overall_score_status: EXCELLENT
is_bookmarked: true
is_dismissed: false
is_aspirational: false
has_open_jobs: false
locations:
- location_id: 110
country_code: Poland
city: Warsaw
- location_id: 111
country_code: Poland
city: Cracow
organizations:
- organization_type_id: DIVISION,
external_id: external_id_123
- organization_type_id: BUSINESS_UNIT,
external_id: external_id_124
job_family:
external_id: job_family_external_id
UserOpportunityMatchResultDtoExample2:
example:
opportunity_type: job_role
id: id0002
title: Regular Software Developer
overall_score: 70
overall_score_status: EXCELLENT
is_bookmarked: true
is_dismissed: false
is_aspirational: false
has_open_jobs: false
locations:
- location_id: 110
country_code: Poland
city: Warsaw
- location_id: 111
country_code: Poland
city: Cracow
organizations:
- organization_type_id: DIVISION,
external_id: external_id_123
- organization_type_id: BUSINESS_UNIT,
external_id: external_id_124
job_family:
external_id: job_family_external_id
Opportunity:
type: object
properties:
id:
type: integer
title:
type: string
description:
type: string
status:
type: string
source:
type: string
start_date_time:
type: string
end_date_time:
type: string