MANSOQ Frontend module · STATIC DECLARATIONS
User Api client API reference · mansoq-hmis-web
12 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 12 declarations come from repositories/teleicu/mansoq-hmis-web/src/types/user/userApi.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/users/ |
literal |
| default.create | POST | /api/v1/users/ |
literal |
| default.get | GET | /api/v1/users/{username}/ |
literal |
| default.update | PUT | /api/v1/users/{username}/ |
literal |
| default.delete | DELETE | /api/v1/users/{username}/ |
literal |
| default.checkUsername | GET | /api/v1/users/{username}/check_availability/ |
literal |
| default.currentUser | GET | /api/v1/users/getcurrentuser/ |
literal |
| default.uploadProfilePicture | POST | /api/v1/users/{username}/profile_picture/ |
literal |
| default.deleteProfilePicture | DELETE | /api/v1/users/{username}/profile_picture/ |
literal |
| default.generateServiceAccountToken | POST | /api/v1/users/{username}/generate_service_account_token/ |
literal |
| default.revokeServiceAccountToken | DELETE | /api/v1/users/{username}/revoke_service_account_token/ |
literal |
| default.setPreferences | POST | /api/v1/users/set_preferences/ |
literal |
default.list
GET /api/v1/users/. typed route object; literal. multiple static method/path matches across source registrations; installed target and boundary require review.
response type: PaginatedResponse<UserReadMinimal>. client-side declaration; not proof of accepted server payload.
PaginatedResponse declared fields:
| Field | Type | Required | Description |
|---|---|---|---|
| count | number | true | — |
| results | TItem[] | true | — |
UserReadMinimal declared fields:
| Field | Type | Required | Description |
|---|---|---|---|
| last_login | string | true | — |
| profile_picture_url | string | true | — |
| mfa_enabled | boolean | true | — |
| deleted | boolean | true | — |
| is_service_account | boolean | true | — |
Composed/inherited schema references: UserBase. 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/users/. typed route object; literal. multiple static method/path matches across source registrations; installed target and boundary require review.
request type: UserCreate. client-side declaration; not proof of accepted server payload.
UserCreate declared fields:
| Field | Type | Required | Description |
|---|---|---|---|
| password | string | false | — |
| string | true | — | |
| is_service_account | boolean | false | — |
Composed/inherited schema references: UserUpdate. Exact generic composition is retained in the structured reference and requires server-side confirmation.
response type: UserReadMinimal. 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/users/{username}/. typed route object; literal. multiple static method/path matches across source registrations; installed target and boundary require review.
Path parameters: username. Transport strings are declared here; semantic identifier types require the server contract.
response type: UserRead. client-side declaration; not proof of accepted server payload.
UserRead declared fields:
| Field | Type | Required | Description |
|---|---|---|---|
| geo_organization | Organization | false | — |
| created_by | UserReadMinimal | false | — |
| string | true | — | |
| flags | string[] | true | — |
Composed/inherited schema references: UserReadMinimal. 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.update
PUT /api/v1/users/{username}/. typed route object; literal. multiple static method/path matches across source registrations; installed target and boundary require review.
Path parameters: username. Transport strings are declared here; semantic identifier types require the server contract.
request type: UserUpdate. client-side declaration; not proof of accepted server payload.
UserUpdate declared fields:
| Field | Type | Required | Description |
|---|---|---|---|
| geo_organization | string | false | — |
Composed/inherited schema references: UserBase. Exact generic composition is retained in the structured reference and requires server-side confirmation.
response type: UserReadMinimal. 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.delete
DELETE /api/v1/users/{username}/. typed route object; literal. multiple static method/path matches across source registrations; installed target and boundary require review.
Path parameters: username. 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: Record<string, never>. 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.checkUsername
GET /api/v1/users/{username}/check_availability/. typed route object; literal. multiple static method/path matches across source registrations; installed target and boundary require review.
Path parameters: username. Transport strings are declared here; semantic identifier types require the server contract.
response type: void. 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.currentUser
GET /api/v1/users/getcurrentuser/. typed route object; literal. multiple static method/path matches across source registrations; installed target and boundary require review.
response type: CurrentUserRead. client-side declaration; not proof of accepted server payload.
CurrentUserRead declared fields:
| Field | Type | Required | Description |
|---|---|---|---|
| alt_phone_number | string | false | — |
| date_of_birth | string | false | — |
| is_superuser | boolean | true | — |
| qualification | string | null | true | — |
| doctor_experience_commenced_on | string | null | true | — |
| doctor_medical_council_registration | string | null | true | — |
| weekly_working_hours | string | null | true | — |
| verified | boolean | true | — |
| facilities | FacilityBareMinimum[] | true | — |
| organizations | Organization[] | true | — |
| last_login | string | true | — |
| pf_endpoint | string | null | true | — |
| pf_p256dh | string | null | true | — |
| pf_auth | string | null | true | — |
| preferences | Record<string, unknown> | true | — |
Composed/inherited schema references: UserRead, Permissions. 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.uploadProfilePicture
POST /api/v1/users/{username}/profile_picture/. typed route object; literal. multiple static method/path matches across source registrations; installed target and boundary require review.
Path parameters: username. Transport strings are declared here; semantic identifier types require the server contract.
request type: FormData. client-side declaration; not proof of accepted server payload.
response type: void. 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.deleteProfilePicture
DELETE /api/v1/users/{username}/profile_picture/. typed route object; literal. multiple static method/path matches across source registrations; installed target and boundary require review.
Path parameters: username. 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: void. 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.generateServiceAccountToken
POST /api/v1/users/{username}/generate_service_account_token/. typed route object; literal. multiple static method/path matches across source registrations; installed target and boundary require review.
Path parameters: username. Transport strings are declared here; semantic identifier types require the server contract.
response type: GenerateServiceAccountTokenResponse. client-side declaration; not proof of accepted server payload.
GenerateServiceAccountTokenResponse declared fields:
| Field | Type | Required | Description |
|---|---|---|---|
| token | string | true | — |
| user | string | true | — |
| created | 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.revokeServiceAccountToken
DELETE /api/v1/users/{username}/revoke_service_account_token/. typed route object; literal. multiple static method/path matches across source registrations; installed target and boundary require review.
Path parameters: username. Transport strings are declared here; semantic identifier types require the server contract.
response type: void. 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.setPreferences
POST /api/v1/users/set_preferences/. typed route object; literal. multiple static method/path matches across source registrations; installed target and boundary require review.
request type: UserPreferenceRequest. client-side declaration; not proof of accepted server payload.
UserPreferenceRequest declared fields:
| Field | Type | Required | Description |
|---|---|---|---|
| preference | string | true | — |
| version | string | false | — |
| value | Record<string, unknown> | true | — |
response type: CurrentUserRead. 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.
Pinned source evidence
Links require access to the private source repository.
- repositories/teleicu/mansoq-hmis-web/src/types/user/userApi.ts:13
- repositories/teleicu/mansoq-hmis-web/src/types/user/userApi.ts:18
- repositories/teleicu/mansoq-hmis-web/src/types/user/userApi.ts:24
- repositories/teleicu/mansoq-hmis-web/src/types/user/userApi.ts:29
- repositories/teleicu/mansoq-hmis-web/src/types/user/userApi.ts:35
- repositories/teleicu/mansoq-hmis-web/src/types/user/userApi.ts:41
- repositories/teleicu/mansoq-hmis-web/src/types/user/userApi.ts:46
- repositories/teleicu/mansoq-hmis-web/src/types/user/userApi.ts:51
- repositories/teleicu/mansoq-hmis-web/src/types/user/userApi.ts:57
- repositories/teleicu/mansoq-hmis-web/src/types/user/userApi.ts:63
- repositories/teleicu/mansoq-hmis-web/src/types/user/userApi.ts:68
- repositories/teleicu/mansoq-hmis-web/src/types/user/userApi.ts:73
- repositories/teleicu/mansoq-hmis-web/src/Utils/request/types.ts:66
- repositories/teleicu/mansoq-hmis-web/src/types/user/user.ts:26
- repositories/teleicu/mansoq-hmis-web/src/types/user/user.ts:65
- repositories/teleicu/mansoq-hmis-web/src/types/user/user.ts:34
- repositories/teleicu/mansoq-hmis-web/src/types/user/user.ts:61
- repositories/teleicu/mansoq-hmis-web/src/types/user/user.ts:41
- repositories/teleicu/mansoq-hmis-web/src/types/user/user.ts:76
- repositories/teleicu/mansoq-hmis-web/src/types/user/userPreferences.ts:14