MANSOQ Knowledge
← Technical API reference

Frontend module · STATIC DECLARATIONS

Value Set Api client API reference · mansoq-web-teleicu

15 client route/call declarations with path parameters, named payload/response types and source references. Exact server acceptance and permissions require the matched backend contract.

Static API contract — behavior review pending. Source baseline f6e9f05f76d4.

Enable JavaScript to inspect structured operation, parameter, schema and permission evidence. Download this reference and its evidence.

Client contract scope

These 15 declarations come from repositories/teleicu/mansoq-web-teleicu/src/types/valueSet/valueSetApi.ts. Client types and noAuth flags describe the caller; they do not authorize a server action. Dynamic paths and missing backend matches are retained as review work, not repaired into invented endpoints.

Operation map

Client method HTTP method Path pattern Resolution
default.list GET /api/v1/valueset/ literal
default.create POST /api/v1/valueset/ literal
default.get GET /api/v1/valueset/{slug}/ literal
default.update PUT /api/v1/valueset/{slug}/ literal
default.lookup POST /api/v1/valueset/lookup_code/ literal
default.expand POST /api/v1/valueset/{slug}/expand/ literal
default.previewSearch POST /api/v1/valueset/preview_search/ literal
default.favourites GET /api/v1/valueset/{slug}/favourites/ literal
default.addFavourite POST /api/v1/valueset/{slug}/add_favourite/ literal
default.removeFavourite POST /api/v1/valueset/{slug}/remove_favourite/ literal
default.clearFavourites POST /api/v1/valueset/{slug}/clear_favourites/ literal
default.recentViews GET /api/v1/valueset/{slug}/recent_views/ literal
default.addRecentView POST /api/v1/valueset/{slug}/add_recent_view/ literal
default.removeRecentView POST /api/v1/valueset/{slug}/remove_recent_view/ literal
default.clearRecentViews POST /api/v1/valueset/{slug}/clear_recent_views/ literal

default.list

GET /api/v1/valueset/. typed route object; literal. multiple static method/path matches across source registrations; installed target and boundary require review.

response type: PaginatedResponse<ValueSetRead>. client-side declaration; not proof of accepted server payload.

PaginatedResponse declared fields:

Field Type Required Description
count number true —
results TItem[] true —

ValueSetRead declared fields:

Field Type Required Description
id string true —
created_by string | null true —
updated_by string | null true —

Composed/inherited schema references: ValueSetBase. Exact generic composition is retained in the structured reference and requires server-side confirmation.

Operational limitation: request validation, permission checks, error statuses and irreversible side effects belong to the server implementation. An unmatched or computed client route requires contract review before use.

default.create

POST /api/v1/valueset/. typed route object; literal. multiple static method/path matches across source registrations; installed target and boundary require review.

request type: ValueSetCreate. client-side declaration; not proof of accepted server payload.

Composed/inherited schema references: ValueSetBase. Exact generic composition is retained in the structured reference and requires server-side confirmation.

response type: ValueSetRead. client-side declaration; not proof of accepted server payload.

Operational limitation: request validation, permission checks, error statuses and irreversible side effects belong to the server implementation. An unmatched or computed client route requires contract review before use.

default.get

GET /api/v1/valueset/{slug}/. typed route object; literal. multiple static method/path matches across source registrations; installed target and boundary require review.

Path parameters: slug. Transport strings are declared here; semantic identifier types require the server contract.

response type: ValueSetRead. client-side declaration; not proof of accepted server payload.

Operational limitation: request validation, permission checks, error statuses and irreversible side effects belong to the server implementation. An unmatched or computed client route requires contract review before use.

default.update

PUT /api/v1/valueset/{slug}/. typed route object; literal. multiple static method/path matches across source registrations; installed target and boundary require review.

Path parameters: slug. Transport strings are declared here; semantic identifier types require the server contract.

request type: ValueSetUpdate. client-side declaration; not proof of accepted server payload.

ValueSetUpdate declared fields:

Field Type Required Description
id string true —

Composed/inherited schema references: ValueSetBase. Exact generic composition is retained in the structured reference and requires server-side confirmation.

response type: ValueSetRead. client-side declaration; not proof of accepted server payload.

Operational limitation: request validation, permission checks, error statuses and irreversible side effects belong to the server implementation. An unmatched or computed client route requires contract review before use.

default.lookup

POST /api/v1/valueset/lookup_code/. typed route object; literal. multiple static method/path matches across source registrations; installed target and boundary require review.

request type: ValueSetLookupRequest. client-side declaration; not proof of accepted server payload.

ValueSetLookupRequest declared fields:

Field Type Required Description
system string true —
code string true —

response type: ValueSetLookupResponse. client-side declaration; not proof of accepted server payload.

ValueSetLookupResponse declared fields:

Field Type Required Description
designations DesignationItem[] true —
metadata ValueSetCodeMetadata true —
properties Record<string, unknown> true —

Operational limitation: request validation, permission checks, error statuses and irreversible side effects belong to the server implementation. An unmatched or computed client route requires contract review before use.

default.expand

POST /api/v1/valueset/{slug}/expand/. typed route object; literal. multiple static method/path matches across source registrations; installed target and boundary require review.

Path parameters: slug. Transport strings are declared here; semantic identifier types require the server contract.

request type: ExpandRequest. client-side declaration; not proof of accepted server payload.

ExpandRequest declared fields:

Field Type Required Description
search string true —
count number true —

response type: object. client-side declaration; not proof of accepted server payload.

CodeConceptMinimal declared fields:

Field Type Required Description
code string true —
display string true —
system string true —
designation Designation[] true —

default.expand.response declared fields:

Field Type Required Description
results CodeConceptMinimal[] true —

Operational limitation: request validation, permission checks, error statuses and irreversible side effects belong to the server implementation. An unmatched or computed client route requires contract review before use.

default.previewSearch

POST /api/v1/valueset/preview_search/. typed route object; literal. multiple static method/path matches across source registrations; installed target and boundary require review.

request type: ValueSetBase. client-side declaration; not proof of accepted server payload.

ValueSetBase declared fields:

Field Type Required Description
slug string true —
name string true —
description string true —
compose ValueSetCompose true —
status ValueSetStatus true —
is_system_defined boolean true —

response type: object. client-side declaration; not proof of accepted server payload.

default.previewSearch.response declared fields:

Field Type Required Description
results CodeConceptMinimal[] true —

Operational limitation: request validation, permission checks, error statuses and irreversible side effects belong to the server implementation. An unmatched or computed client route requires contract review before use.

default.favourites

GET /api/v1/valueset/{slug}/favourites/. typed route object; literal. multiple static method/path matches across source registrations; installed target and boundary require review.

Path parameters: slug. Transport strings are declared here; semantic identifier types require the server contract.

response type: CodeConceptMinimal[]. client-side declaration; not proof of accepted server payload.

Operational limitation: request validation, permission checks, error statuses and irreversible side effects belong to the server implementation. An unmatched or computed client route requires contract review before use.

default.addFavourite

POST /api/v1/valueset/{slug}/add_favourite/. typed route object; literal. multiple static method/path matches across source registrations; installed target and boundary require review.

Path parameters: slug. Transport strings are declared here; semantic identifier types require the server contract.

request type: CodeConceptMinimal. client-side declaration; not proof of accepted server payload.

response type: object. client-side declaration; not proof of accepted server payload.

default.addFavourite.response declared fields:

Field Type Required Description
message string true —

Operational limitation: request validation, permission checks, error statuses and irreversible side effects belong to the server implementation. An unmatched or computed client route requires contract review before use.

default.removeFavourite

POST /api/v1/valueset/{slug}/remove_favourite/. typed route object; literal. multiple static method/path matches across source registrations; installed target and boundary require review.

Path parameters: slug. Transport strings are declared here; semantic identifier types require the server contract.

request type: CodeConceptMinimal. client-side declaration; not proof of accepted server payload.

response type: object. client-side declaration; not proof of accepted server payload.

default.removeFavourite.response declared fields:

Field Type Required Description
message string true —

Operational limitation: request validation, permission checks, error statuses and irreversible side effects belong to the server implementation. An unmatched or computed client route requires contract review before use.

default.clearFavourites

POST /api/v1/valueset/{slug}/clear_favourites/. typed route object; literal. multiple static method/path matches across source registrations; installed target and boundary require review.

Path parameters: slug. Transport strings are declared here; semantic identifier types require the server contract.

request type: void. client-side declaration; not proof of accepted server payload.

response type: object. client-side declaration; not proof of accepted server payload.

default.clearFavourites.response declared fields:

Field Type Required Description
message string true —

Operational limitation: request validation, permission checks, error statuses and irreversible side effects belong to the server implementation. An unmatched or computed client route requires contract review before use.

default.recentViews

GET /api/v1/valueset/{slug}/recent_views/. typed route object; literal. multiple static method/path matches across source registrations; installed target and boundary require review.

Path parameters: slug. Transport strings are declared here; semantic identifier types require the server contract.

response type: CodeConceptMinimal[]. client-side declaration; not proof of accepted server payload.

Operational limitation: request validation, permission checks, error statuses and irreversible side effects belong to the server implementation. An unmatched or computed client route requires contract review before use.

default.addRecentView

POST /api/v1/valueset/{slug}/add_recent_view/. typed route object; literal. multiple static method/path matches across source registrations; installed target and boundary require review.

Path parameters: slug. Transport strings are declared here; semantic identifier types require the server contract.

request type: CodeConceptMinimal. client-side declaration; not proof of accepted server payload.

response type: object. client-side declaration; not proof of accepted server payload.

default.addRecentView.response declared fields:

Field Type Required Description
message string true —

Operational limitation: request validation, permission checks, error statuses and irreversible side effects belong to the server implementation. An unmatched or computed client route requires contract review before use.

default.removeRecentView

POST /api/v1/valueset/{slug}/remove_recent_view/. typed route object; literal. multiple static method/path matches across source registrations; installed target and boundary require review.

Path parameters: slug. Transport strings are declared here; semantic identifier types require the server contract.

request type: CodeConceptMinimal. client-side declaration; not proof of accepted server payload.

response type: object. client-side declaration; not proof of accepted server payload.

default.removeRecentView.response declared fields:

Field Type Required Description
message string true —

Operational limitation: request validation, permission checks, error statuses and irreversible side effects belong to the server implementation. An unmatched or computed client route requires contract review before use.

default.clearRecentViews

POST /api/v1/valueset/{slug}/clear_recent_views/. typed route object; literal. multiple static method/path matches across source registrations; installed target and boundary require review.

Path parameters: slug. Transport strings are declared here; semantic identifier types require the server contract.

request type: void. client-side declaration; not proof of accepted server payload.

response type: object. client-side declaration; not proof of accepted server payload.

default.clearRecentViews.response declared fields:

Field Type Required Description
message string true —

Operational limitation: request validation, permission checks, error statuses and irreversible side effects belong to the server implementation. An unmatched or computed client route requires contract review before use.

Pinned source evidence

Links require access to the private source repository.