Class VenueApiService

Exam-venue, room, contact, promotion, and consequence operations.

Index

Constructors

Methods

checkExamVenueDuplicates createExamRoom createExamVenue createExamVenueContact decideExamVenuePromotion deleteExamRoom deleteExamVenue deleteExamVenueContact geocodeExamVenue getExamRoomChangeImpact getExamVenueChangeImpact requestExamVenuePromotion retryExamVenueConsequences updateExamRoom updateExamVenue updateExamVenueContact

Constructors

constructor

new VenueApiService(): VenueApiService

Returns VenueApiService

Methods

checkExamVenueDuplicates

checkExamVenueDuplicates(
    payload: ExamVenueDuplicateCheckRequest,
    excludedId?: number,
): Observable<
    {
        items: { address: string; id: number; name: string; scope: string }[];
    },
>
Parameters
- payload: ExamVenueDuplicateCheckRequest
- OptionalexcludedId: number
Returns Observable<
    {
        items: { address: string; id: number; name: string; scope: string }[];
    },
>
- Defined in api/venue-api.service.ts:33

createExamRoom

createExamRoom(
venueId: number,
payload: ExamRoomCreateRequest,
): Observable<ExamRoom>
Parameters
- venueId: number
- payload: ExamRoomCreateRequest
Returns Observable<ExamRoom>
- Defined in api/venue-api.service.ts:64

createExamVenue

createExamVenue(payload: ExamVenueCreateRequest): Observable<ExamVenue>
Parameters
- payload: ExamVenueCreateRequest
Returns Observable<ExamVenue>
- Defined in api/venue-api.service.ts:29

createExamVenueContact

createExamVenueContact(
venueId: number,
payload: ExamVenueContactCreateRequest,
): Observable<ExamVenueContact>
Parameters
- venueId: number
- payload: ExamVenueContactCreateRequest
Returns Observable<ExamVenueContact>
- Defined in api/venue-api.service.ts:88

decideExamVenuePromotion

decideExamVenuePromotion(
    id: number,
    expectedRevision: number,
    decision: "approve" | "reject",
    reason: string,
): Observable<ExamVenue>
Parameters
- id: number
- expectedRevision: number
- decision: "approve" | "reject"
- reason: string
Returns Observable<ExamVenue>
- Defined in api/venue-api.service.ts:110

deleteExamRoom

deleteExamRoom(id: number, expectedRevision: number): Observable<void>
Parameters
- id: number
- expectedRevision: number
Returns Observable<void>
- Defined in api/venue-api.service.ts:82

deleteExamVenue

deleteExamVenue(id: number, expectedRevision: number): Observable<void>
Parameters
- id: number
- expectedRevision: number
Returns Observable<void>
- Defined in api/venue-api.service.ts:58

deleteExamVenueContact

deleteExamVenueContact(id: number, expectedRevision: number): Observable<void>
Parameters
- id: number
- expectedRevision: number
Returns Observable<void>
- Defined in api/venue-api.service.ts:96

geocodeExamVenue

geocodeExamVenue(
id: number,
expectedRevision: number,
): Observable<{ latitude: number; longitude: number; source: string }>
Parameters
- id: number
- expectedRevision: number
Returns Observable<{ latitude: number; longitude: number; source: string }>
- Defined in api/venue-api.service.ts:51

getExamRoomChangeImpact

getExamRoomChangeImpact(
id: number,
payload: Record<string, unknown>,
): Observable<VenueChangeImpact>
Parameters
- id: number
- payload: Record<string, unknown>
Returns Observable<VenueChangeImpact>
- Defined in api/venue-api.service.ts:43

getExamVenueChangeImpact

getExamVenueChangeImpact(
id: number,
payload: Record<string, unknown>,
): Observable<VenueChangeImpact>
Parameters
- id: number
- payload: Record<string, unknown>
Returns Observable<VenueChangeImpact>
- Defined in api/venue-api.service.ts:39

requestExamVenuePromotion

requestExamVenuePromotion(
    id: number,
    expectedRevision: number,
    reason: string,
): Observable<unknown>
Parameters
- id: number
- expectedRevision: number
- reason: string
Returns Observable<unknown>
- Defined in api/venue-api.service.ts:102

retryExamVenueConsequences

retryExamVenueConsequences(
    auditId: number,
): Observable<
    {
        audit_id: number;
        pending: number;
        problems: number;
        processed: number;
        superseded: number;
    },
>
Parameters
- auditId: number
Returns Observable<
    {
        audit_id: number;
        pending: number;
        problems: number;
        processed: number;
        superseded: number;
    },
>
- Defined in api/venue-api.service.ts:72

updateExamRoom

updateExamRoom(id: number, payload: ExamRoomUpdateRequest): Observable<ExamRoom>
Parameters
- id: number
- payload: ExamRoomUpdateRequest
Returns Observable<ExamRoom>
- Defined in api/venue-api.service.ts:68

updateExamVenue

updateExamVenue(
id: number,
payload: ExamVenueUpdateRequest,
): Observable<ExamVenue>
Parameters
- id: number
- payload: ExamVenueUpdateRequest
Returns Observable<ExamVenue>
- Defined in api/venue-api.service.ts:47

updateExamVenueContact

updateExamVenueContact(
id: number,
payload: ExamVenueContactUpdateRequest,
): Observable<ExamVenueContact>
Parameters
- id: number
- payload: ExamVenueContactUpdateRequest
Returns Observable<ExamVenueContact>
- Defined in api/venue-api.service.ts:92