frontend
Preparing search index...
api/exam-round-api.service
ExamRoundApiService
Class ExamRoundApiService
Exam-half-year and exam-round lifecycle operations.
Index
Constructors
constructor
Methods
cancel
Exam
Round
close
Exam
Round
create
Exam
Half
Year
create
Exam
Round
delete
Empty
Exam
Round
document
Exam
Round
Ihk
Status
get
Exam
Round
Lifecycle
list
Exam
Half
Years
list
Exam
Rounds
reopen
Exam
Round
set
Round
Candidate
Terminal
Status
update
Exam
Half
Year
Constructors
constructor
new
ExamRoundApiService
()
:
ExamRoundApiService
Returns
ExamRoundApiService
Methods
cancel
Exam
Round
cancelExamRound
(
roundId
:
number
,
revision
:
number
,
reason
:
string
,
)
:
Observable
<
ExamRoundLifecycle
>
Parameters
roundId
:
number
revision
:
number
reason
:
string
Returns
Observable
<
ExamRoundLifecycle
>
close
Exam
Round
closeExamRound
(
roundId
:
number
,
revision
:
number
,
)
:
Observable
<
ExamRoundLifecycle
>
Parameters
roundId
:
number
revision
:
number
Returns
Observable
<
ExamRoundLifecycle
>
create
Exam
Half
Year
createExamHalfYear
(
payload
:
Pick
<
ExamHalfYear
,
"season"
|
"year"
|
"status"
>
,
)
:
Observable
<
ExamHalfYear
>
Parameters
payload
:
Pick
<
ExamHalfYear
,
"season"
|
"year"
|
"status"
>
Returns
Observable
<
ExamHalfYear
>
create
Exam
Round
createExamRound
(
payload
:
ExamRoundCreate
)
:
Observable
<
ExamRound
>
Parameters
payload
:
ExamRoundCreate
Returns
Observable
<
ExamRound
>
delete
Empty
Exam
Round
deleteEmptyExamRound
(
roundId
:
number
)
:
Observable
<
void
>
Parameters
roundId
:
number
Returns
Observable
<
void
>
document
Exam
Round
Ihk
Status
documentExamRoundIhkStatus
(
roundId
:
number
,
resultId
:
number
,
documentStatus
:
string
,
documentReference
:
string
,
)
:
Observable
<
ExamRoundLifecycle
>
Parameters
roundId
:
number
resultId
:
number
documentStatus
:
string
documentReference
:
string
Returns
Observable
<
ExamRoundLifecycle
>
get
Exam
Round
Lifecycle
getExamRoundLifecycle
(
roundId
:
number
)
:
Observable
<
ExamRoundLifecycle
>
Parameters
roundId
:
number
Returns
Observable
<
ExamRoundLifecycle
>
list
Exam
Half
Years
listExamHalfYears
()
:
Observable
<
ExamHalfYear
[]
>
Returns
Observable
<
ExamHalfYear
[]
>
list
Exam
Rounds
listExamRounds
()
:
Observable
<
ExamRound
[]
>
Returns
Observable
<
ExamRound
[]
>
reopen
Exam
Round
reopenExamRound
(
roundId
:
number
,
payload
:
{
occasion
:
string
;
reason
:
string
;
revision
:
number
;
scope
:
{
entity_id
:
number
;
kind
:
string
}
[]
;
source
:
string
;
}
,
)
:
Observable
<
ExamRoundLifecycle
>
Parameters
roundId
:
number
payload
:
{
occasion
:
string
;
reason
:
string
;
revision
:
number
;
scope
:
{
entity_id
:
number
;
kind
:
string
}
[]
;
source
:
string
;
}
Returns
Observable
<
ExamRoundLifecycle
>
set
Round
Candidate
Terminal
Status
setRoundCandidateTerminalStatus
(
roundId
:
number
,
roundCandidateId
:
number
,
payload
:
{
effective_new_round_id
?:
number
;
ihk_decision_reference
?:
string
;
postponed_until
?:
string
;
reason
?:
string
;
revision
:
number
;
terminal_status
:
string
;
}
,
)
:
Observable
<
ExamRoundLifecycle
>
Parameters
roundId
:
number
roundCandidateId
:
number
payload
:
{
effective_new_round_id
?:
number
;
ihk_decision_reference
?:
string
;
postponed_until
?:
string
;
reason
?:
string
;
revision
:
number
;
terminal_status
:
string
;
}
Returns
Observable
<
ExamRoundLifecycle
>
update
Exam
Half
Year
updateExamHalfYear
(
id
:
number
,
payload
:
Partial
<
Pick
<
ExamHalfYear
,
"season"
|
"year"
|
"status"
>
>
,
)
:
Observable
<
ExamHalfYear
>
Parameters
id
:
number
payload
:
Partial
<
Pick
<
ExamHalfYear
,
"season"
|
"year"
|
"status"
>
>
Returns
Observable
<
ExamHalfYear
>
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Constructors
constructor
Methods
cancel
Exam
Round
close
Exam
Round
create
Exam
Half
Year
create
Exam
Round
delete
Empty
Exam
Round
document
Exam
Round
Ihk
Status
get
Exam
Round
Lifecycle
list
Exam
Half
Years
list
Exam
Rounds
reopen
Exam
Round
set
Round
Candidate
Terminal
Status
update
Exam
Half
Year
frontend
Loading...
Exam-half-year and exam-round lifecycle operations.