> For the complete documentation index, see [llms.txt](https://docs.mymedtrics.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.mymedtrics.com/api-reference/medtrics-classic-sis-bridge/program-schedules.md). # Program Schedules ## GET /api-banner/program-schedules/ > Legacy /api-banner/program-schedules/ bridge resource.\ > \ > Mirrors the \`\`ProgramScheduleViewSet\`\` contract from the legacy Django app:\ > GET /api-banner/program-schedules/ → list\ > GET /api-banner/program-schedules/{id}/ → retrieve\ > POST /api-banner/program-schedules/ → create (201)\ > PUT /api-banner/program-schedules/{id}/ → full update (200)\ > PATCH /api-banner/program-schedules/{id}/ → partial update (200)\ > DELETE /api-banner/program-schedules/{id}/ → destroy (204)\ > POST /api-banner/program-schedules/{id}/add\_user/ → 200\ > POST /api-banner/program-schedules/{id}/add\_admin/ → 200\ > \ > Request body translation (legacy → Connect):\ > name, description → direct\ > schedule\_details, show\_rotation\_tab\_default, restrict\_rotation\_view,\ > show\_block\_naming, enable\_rotation\_block\_directors → schedule\_config booleans\ > program (int) → program\_id (resolved via /programs)\ > academic\_year (int) → academic\_period\_id (resolved via /academic-periods)\ > admin\_users (int\[]) → admin\_user\_ids (resolved via /learners)\ > users (int\[]) → participant\_user\_ids (resolved via /learners)\ > view\_access\_to\_users (int\[]) → view\_only\_user\_ids (resolved via /learners)\ > sites (int\[]) → site\_ids (resolved via /sites)\ > show\_contact\_faculty / show\_contact\_trainee: accepted but ignored — read\ > path always returns literal False so ignoring keeps GET→PUT round-trips\ > consistent.\ > view\_access\_to\_roles, roles, groups: read-only / excluded in legacy → ignored.\ > \ > Required on create (per legacy test\_create): name, program, academic\_year.\ > Required on PUT (per legacy test\_update): name, program, academic\_year. ```json {"openapi":"3.1.0","info":{"title":"Medtrics Legacy SIS Bridge (Compatibility API)","version":"draft-2026-10-29"},"servers":[{"url":"https://{client}.mymedtrics.com","description":"Tenant host; Caddy routes /api-banner/* and /api/* to the bridge (internal only)","variables":{"client":{"default":"","description":"Tenant subdomain"}}},{"url":"http://localhost:8090","description":"local dev (see docker/caddy/Caddyfile for deployed hosts)"}],"security":[{"LegacyToken":[]},{"LegacyBasic":[]}],"components":{"securitySchemes":{"LegacyToken":{"type":"apiKey","in":"header","name":"Authorization","description":"Authorization: Token "},"LegacyBasic":{"type":"http","scheme":"basic"}},"schemas":{"ListEnvelope":{"type":"object","description":"Bridge-wide list envelope. count is always null and page_range always [] (cursor pagination upstream).","properties":{"count":{"type":["integer","null"]},"page_range":{"type":"array"},"per_page":{"type":"integer"},"next":{"type":["string","null"]},"previous":{"type":["string","null"]},"results":{"type":"array"}}},"ProgramSchedules":{"type":"object","description":"Legacy-shaped banner/program-schedules record as served by the bridge; translated from Connect /clinical-schedules","properties":{"id":{"type":"integer","description":"legacy id of legacy_id"},"academic_year":{"type":"integer","description":"legacy id of academic_period_legacy_id"},"program":{"type":"integer","description":"legacy id of program_legacy_id"},"updated_by":{"type":"integer","description":"legacy id of updated_by_legacy_id"},"name":{"type":"string","description":"Connect name"},"description":{"type":"string","description":"Connect description"},"schedule_details":{"type":"string","description":"Connect schedule_details"},"show_rotation_tab_default":{"type":"string","description":"Connect show_rotation_tab_default"},"restrict_rotation_view":{"type":"string","description":"Connect restrict_rotation_view"},"show_block_naming":{"type":"string","description":"Connect show_block_naming"},"enable_rotation_block_directors":{"type":"string","description":"Connect enable_rotation_block_directors"},"created_date":{"type":"string","description":"Connect created_at (datetime_to_legacy_iso)"},"updated_at":{"type":"string","description":"Connect updated_at (datetime_to_legacy_iso)"},"admin_users":{"type":"string","description":"Connect admin_user_legacy_ids (legacy_id_array_to_int_list)"},"users":{"type":"string","description":"Connect participant_user_legacy_ids (legacy_id_array_to_int_list)"},"view_access_to_users":{"type":"string","description":"Connect view_only_user_legacy_ids (legacy_id_array_to_int_list)"},"sites":{"type":"string","description":"Connect site_legacy_ids (legacy_id_array_to_int_list)"},"view_access_to_roles":{"type":"string","description":"Connect view_role_names"},"show_contact_faculty":{"type":"string","description":"literal False"},"show_contact_trainee":{"type":"string","description":"literal False"}}}}},"paths":{"/api-banner/program-schedules/":{"get":{"operationId":"programSchedules_list","tags":["ProgramSchedules"],"description":"Legacy /api-banner/program-schedules/ bridge resource.\n\nMirrors the ``ProgramScheduleViewSet`` contract from the legacy Django app:\n GET /api-banner/program-schedules/ → list\n GET /api-banner/program-schedules/{id}/ → retrieve\n POST /api-banner/program-schedules/ → create (201)\n PUT /api-banner/program-schedules/{id}/ → full update (200)\n PATCH /api-banner/program-schedules/{id}/ → partial update (200)\n DELETE /api-banner/program-schedules/{id}/ → destroy (204)\n POST /api-banner/program-schedules/{id}/add_user/ → 200\n POST /api-banner/program-schedules/{id}/add_admin/ → 200\n\nRequest body translation (legacy → Connect):\n name, description → direct\n schedule_details, show_rotation_tab_default, restrict_rotation_view,\n show_block_naming, enable_rotation_block_directors → schedule_config booleans\n program (int) → program_id (resolved via /programs)\n academic_year (int) → academic_period_id (resolved via /academic-periods)\n admin_users (int[]) → admin_user_ids (resolved via /learners)\n users (int[]) → participant_user_ids (resolved via /learners)\n view_access_to_users (int[]) → view_only_user_ids (resolved via /learners)\n sites (int[]) → site_ids (resolved via /sites)\n show_contact_faculty / show_contact_trainee: accepted but ignored — read\n path always returns literal False so ignoring keeps GET→PUT round-trips\n consistent.\n view_access_to_roles, roles, groups: read-only / excluded in legacy → ignored.\n\nRequired on create (per legacy test_create): name, program, academic_year.\nRequired on PUT (per legacy test_update): name, program, academic_year.","parameters":[{"name":"page","in":"query","schema":{"type":"integer"}},{"name":"page_size","in":"query","schema":{"type":"integer","maximum":100}},{"name":"id","in":"query","schema":{"type":"integer"},"description":"maps to Connect legacy_id"},{"name":"academic_year","in":"query","schema":{"type":"integer"},"description":"maps to Connect academic_period_legacy_id"},{"name":"site_id","in":"query","schema":{"type":"integer"},"description":"maps to Connect site_legacy_id"}],"responses":{"200":{"description":"ListEnvelope","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ListEnvelope"},{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/components/schemas/ProgramSchedules"}}}}]}}}},"400":{"description":"validation error"},"401":{"description":"unauthenticated"},"404":{"description":"not found or out of tenant scope"}}}}}} ``` ## POST /api-banner/program-schedules/ > Legacy /api-banner/program-schedules/ bridge resource.\ > \ > Mirrors the \`\`ProgramScheduleViewSet\`\` contract from the legacy Django app:\ > GET /api-banner/program-schedules/ → list\ > GET /api-banner/program-schedules/{id}/ → retrieve\ > POST /api-banner/program-schedules/ → create (201)\ > PUT /api-banner/program-schedules/{id}/ → full update (200)\ > PATCH /api-banner/program-schedules/{id}/ → partial update (200)\ > DELETE /api-banner/program-schedules/{id}/ → destroy (204)\ > POST /api-banner/program-schedules/{id}/add\_user/ → 200\ > POST /api-banner/program-schedules/{id}/add\_admin/ → 200\ > \ > Request body translation (legacy → Connect):\ > name, description → direct\ > schedule\_details, show\_rotation\_tab\_default, restrict\_rotation\_view,\ > show\_block\_naming, enable\_rotation\_block\_directors → schedule\_config booleans\ > program (int) → program\_id (resolved via /programs)\ > academic\_year (int) → academic\_period\_id (resolved via /academic-periods)\ > admin\_users (int\[]) → admin\_user\_ids (resolved via /learners)\ > users (int\[]) → participant\_user\_ids (resolved via /learners)\ > view\_access\_to\_users (int\[]) → view\_only\_user\_ids (resolved via /learners)\ > sites (int\[]) → site\_ids (resolved via /sites)\ > show\_contact\_faculty / show\_contact\_trainee: accepted but ignored — read\ > path always returns literal False so ignoring keeps GET→PUT round-trips\ > consistent.\ > view\_access\_to\_roles, roles, groups: read-only / excluded in legacy → ignored.\ > \ > Required on create (per legacy test\_create): name, program, academic\_year.\ > Required on PUT (per legacy test\_update): name, program, academic\_year. ```json {"openapi":"3.1.0","info":{"title":"Medtrics Legacy SIS Bridge (Compatibility API)","version":"draft-2026-10-29"},"servers":[{"url":"https://{client}.mymedtrics.com","description":"Tenant host; Caddy routes /api-banner/* and /api/* to the bridge (internal only)","variables":{"client":{"default":"","description":"Tenant subdomain"}}},{"url":"http://localhost:8090","description":"local dev (see docker/caddy/Caddyfile for deployed hosts)"}],"security":[{"LegacyToken":[]},{"LegacyBasic":[]}],"components":{"securitySchemes":{"LegacyToken":{"type":"apiKey","in":"header","name":"Authorization","description":"Authorization: Token "},"LegacyBasic":{"type":"http","scheme":"basic"}},"schemas":{"ProgramSchedules":{"type":"object","description":"Legacy-shaped banner/program-schedules record as served by the bridge; translated from Connect /clinical-schedules","properties":{"id":{"type":"integer","description":"legacy id of legacy_id"},"academic_year":{"type":"integer","description":"legacy id of academic_period_legacy_id"},"program":{"type":"integer","description":"legacy id of program_legacy_id"},"updated_by":{"type":"integer","description":"legacy id of updated_by_legacy_id"},"name":{"type":"string","description":"Connect name"},"description":{"type":"string","description":"Connect description"},"schedule_details":{"type":"string","description":"Connect schedule_details"},"show_rotation_tab_default":{"type":"string","description":"Connect show_rotation_tab_default"},"restrict_rotation_view":{"type":"string","description":"Connect restrict_rotation_view"},"show_block_naming":{"type":"string","description":"Connect show_block_naming"},"enable_rotation_block_directors":{"type":"string","description":"Connect enable_rotation_block_directors"},"created_date":{"type":"string","description":"Connect created_at (datetime_to_legacy_iso)"},"updated_at":{"type":"string","description":"Connect updated_at (datetime_to_legacy_iso)"},"admin_users":{"type":"string","description":"Connect admin_user_legacy_ids (legacy_id_array_to_int_list)"},"users":{"type":"string","description":"Connect participant_user_legacy_ids (legacy_id_array_to_int_list)"},"view_access_to_users":{"type":"string","description":"Connect view_only_user_legacy_ids (legacy_id_array_to_int_list)"},"sites":{"type":"string","description":"Connect site_legacy_ids (legacy_id_array_to_int_list)"},"view_access_to_roles":{"type":"string","description":"Connect view_role_names"},"show_contact_faculty":{"type":"string","description":"literal False"},"show_contact_trainee":{"type":"string","description":"literal False"}}}}},"paths":{"/api-banner/program-schedules/":{"post":{"operationId":"programSchedules_create","tags":["ProgramSchedules"],"description":"Legacy /api-banner/program-schedules/ bridge resource.\n\nMirrors the ``ProgramScheduleViewSet`` contract from the legacy Django app:\n GET /api-banner/program-schedules/ → list\n GET /api-banner/program-schedules/{id}/ → retrieve\n POST /api-banner/program-schedules/ → create (201)\n PUT /api-banner/program-schedules/{id}/ → full update (200)\n PATCH /api-banner/program-schedules/{id}/ → partial update (200)\n DELETE /api-banner/program-schedules/{id}/ → destroy (204)\n POST /api-banner/program-schedules/{id}/add_user/ → 200\n POST /api-banner/program-schedules/{id}/add_admin/ → 200\n\nRequest body translation (legacy → Connect):\n name, description → direct\n schedule_details, show_rotation_tab_default, restrict_rotation_view,\n show_block_naming, enable_rotation_block_directors → schedule_config booleans\n program (int) → program_id (resolved via /programs)\n academic_year (int) → academic_period_id (resolved via /academic-periods)\n admin_users (int[]) → admin_user_ids (resolved via /learners)\n users (int[]) → participant_user_ids (resolved via /learners)\n view_access_to_users (int[]) → view_only_user_ids (resolved via /learners)\n sites (int[]) → site_ids (resolved via /sites)\n show_contact_faculty / show_contact_trainee: accepted but ignored — read\n path always returns literal False so ignoring keeps GET→PUT round-trips\n consistent.\n view_access_to_roles, roles, groups: read-only / excluded in legacy → ignored.\n\nRequired on create (per legacy test_create): name, program, academic_year.\nRequired on PUT (per legacy test_update): name, program, academic_year.","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["name","program","academic_year"],"properties":{"academic_year":{"type":"integer","description":"legacy id of academic_period_legacy_id"},"program":{"type":"integer","description":"legacy id of program_legacy_id"},"updated_by":{"type":"integer","description":"legacy id of updated_by_legacy_id"},"name":{"type":"string","description":"Connect name"},"description":{"type":"string","description":"Connect description"},"schedule_details":{"type":"string","description":"Connect schedule_details"},"show_rotation_tab_default":{"type":"string","description":"Connect show_rotation_tab_default"},"restrict_rotation_view":{"type":"string","description":"Connect restrict_rotation_view"},"show_block_naming":{"type":"string","description":"Connect show_block_naming"},"enable_rotation_block_directors":{"type":"string","description":"Connect enable_rotation_block_directors"},"created_date":{"type":"string","description":"Connect created_at (datetime_to_legacy_iso)"},"updated_at":{"type":"string","description":"Connect updated_at (datetime_to_legacy_iso)"},"admin_users":{"type":"string","description":"Connect admin_user_legacy_ids (legacy_id_array_to_int_list)"},"users":{"type":"string","description":"Connect participant_user_legacy_ids (legacy_id_array_to_int_list)"},"view_access_to_users":{"type":"string","description":"Connect view_only_user_legacy_ids (legacy_id_array_to_int_list)"},"sites":{"type":"string","description":"Connect site_legacy_ids (legacy_id_array_to_int_list)"},"view_access_to_roles":{"type":"string","description":"Connect view_role_names"},"show_contact_faculty":{"type":"string","description":"literal False"},"show_contact_trainee":{"type":"string","description":"literal False"}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProgramSchedules"}}}},"400":{"description":"validation error"},"401":{"description":"unauthenticated"},"404":{"description":"not found or out of tenant scope"}}}}}} ``` ## GET /api-banner/program-schedules/{id}/ > Legacy /api-banner/program-schedules/ bridge resource.\ > \ > Mirrors the \`\`ProgramScheduleViewSet\`\` contract from the legacy Django app:\ > GET /api-banner/program-schedules/ → list\ > GET /api-banner/program-schedules/{id}/ → retrieve\ > POST /api-banner/program-schedules/ → create (201)\ > PUT /api-banner/program-schedules/{id}/ → full update (200)\ > PATCH /api-banner/program-schedules/{id}/ → partial update (200)\ > DELETE /api-banner/program-schedules/{id}/ → destroy (204)\ > POST /api-banner/program-schedules/{id}/add\_user/ → 200\ > POST /api-banner/program-schedules/{id}/add\_admin/ → 200\ > \ > Request body translation (legacy → Connect):\ > name, description → direct\ > schedule\_details, show\_rotation\_tab\_default, restrict\_rotation\_view,\ > show\_block\_naming, enable\_rotation\_block\_directors → schedule\_config booleans\ > program (int) → program\_id (resolved via /programs)\ > academic\_year (int) → academic\_period\_id (resolved via /academic-periods)\ > admin\_users (int\[]) → admin\_user\_ids (resolved via /learners)\ > users (int\[]) → participant\_user\_ids (resolved via /learners)\ > view\_access\_to\_users (int\[]) → view\_only\_user\_ids (resolved via /learners)\ > sites (int\[]) → site\_ids (resolved via /sites)\ > show\_contact\_faculty / show\_contact\_trainee: accepted but ignored — read\ > path always returns literal False so ignoring keeps GET→PUT round-trips\ > consistent.\ > view\_access\_to\_roles, roles, groups: read-only / excluded in legacy → ignored.\ > \ > Required on create (per legacy test\_create): name, program, academic\_year.\ > Required on PUT (per legacy test\_update): name, program, academic\_year. ```json {"openapi":"3.1.0","info":{"title":"Medtrics Legacy SIS Bridge (Compatibility API)","version":"draft-2026-10-29"},"servers":[{"url":"https://{client}.mymedtrics.com","description":"Tenant host; Caddy routes /api-banner/* and /api/* to the bridge (internal only)","variables":{"client":{"default":"","description":"Tenant subdomain"}}},{"url":"http://localhost:8090","description":"local dev (see docker/caddy/Caddyfile for deployed hosts)"}],"security":[{"LegacyToken":[]},{"LegacyBasic":[]}],"components":{"securitySchemes":{"LegacyToken":{"type":"apiKey","in":"header","name":"Authorization","description":"Authorization: Token "},"LegacyBasic":{"type":"http","scheme":"basic"}},"schemas":{"ProgramSchedules":{"type":"object","description":"Legacy-shaped banner/program-schedules record as served by the bridge; translated from Connect /clinical-schedules","properties":{"id":{"type":"integer","description":"legacy id of legacy_id"},"academic_year":{"type":"integer","description":"legacy id of academic_period_legacy_id"},"program":{"type":"integer","description":"legacy id of program_legacy_id"},"updated_by":{"type":"integer","description":"legacy id of updated_by_legacy_id"},"name":{"type":"string","description":"Connect name"},"description":{"type":"string","description":"Connect description"},"schedule_details":{"type":"string","description":"Connect schedule_details"},"show_rotation_tab_default":{"type":"string","description":"Connect show_rotation_tab_default"},"restrict_rotation_view":{"type":"string","description":"Connect restrict_rotation_view"},"show_block_naming":{"type":"string","description":"Connect show_block_naming"},"enable_rotation_block_directors":{"type":"string","description":"Connect enable_rotation_block_directors"},"created_date":{"type":"string","description":"Connect created_at (datetime_to_legacy_iso)"},"updated_at":{"type":"string","description":"Connect updated_at (datetime_to_legacy_iso)"},"admin_users":{"type":"string","description":"Connect admin_user_legacy_ids (legacy_id_array_to_int_list)"},"users":{"type":"string","description":"Connect participant_user_legacy_ids (legacy_id_array_to_int_list)"},"view_access_to_users":{"type":"string","description":"Connect view_only_user_legacy_ids (legacy_id_array_to_int_list)"},"sites":{"type":"string","description":"Connect site_legacy_ids (legacy_id_array_to_int_list)"},"view_access_to_roles":{"type":"string","description":"Connect view_role_names"},"show_contact_faculty":{"type":"string","description":"literal False"},"show_contact_trainee":{"type":"string","description":"literal False"}}}}},"paths":{"/api-banner/program-schedules/{id}/":{"get":{"operationId":"programSchedules_retrieve","tags":["ProgramSchedules"],"description":"Legacy /api-banner/program-schedules/ bridge resource.\n\nMirrors the ``ProgramScheduleViewSet`` contract from the legacy Django app:\n GET /api-banner/program-schedules/ → list\n GET /api-banner/program-schedules/{id}/ → retrieve\n POST /api-banner/program-schedules/ → create (201)\n PUT /api-banner/program-schedules/{id}/ → full update (200)\n PATCH /api-banner/program-schedules/{id}/ → partial update (200)\n DELETE /api-banner/program-schedules/{id}/ → destroy (204)\n POST /api-banner/program-schedules/{id}/add_user/ → 200\n POST /api-banner/program-schedules/{id}/add_admin/ → 200\n\nRequest body translation (legacy → Connect):\n name, description → direct\n schedule_details, show_rotation_tab_default, restrict_rotation_view,\n show_block_naming, enable_rotation_block_directors → schedule_config booleans\n program (int) → program_id (resolved via /programs)\n academic_year (int) → academic_period_id (resolved via /academic-periods)\n admin_users (int[]) → admin_user_ids (resolved via /learners)\n users (int[]) → participant_user_ids (resolved via /learners)\n view_access_to_users (int[]) → view_only_user_ids (resolved via /learners)\n sites (int[]) → site_ids (resolved via /sites)\n show_contact_faculty / show_contact_trainee: accepted but ignored — read\n path always returns literal False so ignoring keeps GET→PUT round-trips\n consistent.\n view_access_to_roles, roles, groups: read-only / excluded in legacy → ignored.\n\nRequired on create (per legacy test_create): name, program, academic_year.\nRequired on PUT (per legacy test_update): name, program, academic_year.","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProgramSchedules"}}}},"400":{"description":"validation error"},"401":{"description":"unauthenticated"},"404":{"description":"not found or out of tenant scope"}}}}}} ``` ## PUT /api-banner/program-schedules/{id}/ > Legacy /api-banner/program-schedules/ bridge resource.\ > \ > Mirrors the \`\`ProgramScheduleViewSet\`\` contract from the legacy Django app:\ > GET /api-banner/program-schedules/ → list\ > GET /api-banner/program-schedules/{id}/ → retrieve\ > POST /api-banner/program-schedules/ → create (201)\ > PUT /api-banner/program-schedules/{id}/ → full update (200)\ > PATCH /api-banner/program-schedules/{id}/ → partial update (200)\ > DELETE /api-banner/program-schedules/{id}/ → destroy (204)\ > POST /api-banner/program-schedules/{id}/add\_user/ → 200\ > POST /api-banner/program-schedules/{id}/add\_admin/ → 200\ > \ > Request body translation (legacy → Connect):\ > name, description → direct\ > schedule\_details, show\_rotation\_tab\_default, restrict\_rotation\_view,\ > show\_block\_naming, enable\_rotation\_block\_directors → schedule\_config booleans\ > program (int) → program\_id (resolved via /programs)\ > academic\_year (int) → academic\_period\_id (resolved via /academic-periods)\ > admin\_users (int\[]) → admin\_user\_ids (resolved via /learners)\ > users (int\[]) → participant\_user\_ids (resolved via /learners)\ > view\_access\_to\_users (int\[]) → view\_only\_user\_ids (resolved via /learners)\ > sites (int\[]) → site\_ids (resolved via /sites)\ > show\_contact\_faculty / show\_contact\_trainee: accepted but ignored — read\ > path always returns literal False so ignoring keeps GET→PUT round-trips\ > consistent.\ > view\_access\_to\_roles, roles, groups: read-only / excluded in legacy → ignored.\ > \ > Required on create (per legacy test\_create): name, program, academic\_year.\ > Required on PUT (per legacy test\_update): name, program, academic\_year. ```json {"openapi":"3.1.0","info":{"title":"Medtrics Legacy SIS Bridge (Compatibility API)","version":"draft-2026-10-29"},"servers":[{"url":"https://{client}.mymedtrics.com","description":"Tenant host; Caddy routes /api-banner/* and /api/* to the bridge (internal only)","variables":{"client":{"default":"","description":"Tenant subdomain"}}},{"url":"http://localhost:8090","description":"local dev (see docker/caddy/Caddyfile for deployed hosts)"}],"security":[{"LegacyToken":[]},{"LegacyBasic":[]}],"components":{"securitySchemes":{"LegacyToken":{"type":"apiKey","in":"header","name":"Authorization","description":"Authorization: Token "},"LegacyBasic":{"type":"http","scheme":"basic"}},"schemas":{"ProgramSchedules":{"type":"object","description":"Legacy-shaped banner/program-schedules record as served by the bridge; translated from Connect /clinical-schedules","properties":{"id":{"type":"integer","description":"legacy id of legacy_id"},"academic_year":{"type":"integer","description":"legacy id of academic_period_legacy_id"},"program":{"type":"integer","description":"legacy id of program_legacy_id"},"updated_by":{"type":"integer","description":"legacy id of updated_by_legacy_id"},"name":{"type":"string","description":"Connect name"},"description":{"type":"string","description":"Connect description"},"schedule_details":{"type":"string","description":"Connect schedule_details"},"show_rotation_tab_default":{"type":"string","description":"Connect show_rotation_tab_default"},"restrict_rotation_view":{"type":"string","description":"Connect restrict_rotation_view"},"show_block_naming":{"type":"string","description":"Connect show_block_naming"},"enable_rotation_block_directors":{"type":"string","description":"Connect enable_rotation_block_directors"},"created_date":{"type":"string","description":"Connect created_at (datetime_to_legacy_iso)"},"updated_at":{"type":"string","description":"Connect updated_at (datetime_to_legacy_iso)"},"admin_users":{"type":"string","description":"Connect admin_user_legacy_ids (legacy_id_array_to_int_list)"},"users":{"type":"string","description":"Connect participant_user_legacy_ids (legacy_id_array_to_int_list)"},"view_access_to_users":{"type":"string","description":"Connect view_only_user_legacy_ids (legacy_id_array_to_int_list)"},"sites":{"type":"string","description":"Connect site_legacy_ids (legacy_id_array_to_int_list)"},"view_access_to_roles":{"type":"string","description":"Connect view_role_names"},"show_contact_faculty":{"type":"string","description":"literal False"},"show_contact_trainee":{"type":"string","description":"literal False"}}}}},"paths":{"/api-banner/program-schedules/{id}/":{"put":{"operationId":"programSchedules_update","tags":["ProgramSchedules"],"description":"Legacy /api-banner/program-schedules/ bridge resource.\n\nMirrors the ``ProgramScheduleViewSet`` contract from the legacy Django app:\n GET /api-banner/program-schedules/ → list\n GET /api-banner/program-schedules/{id}/ → retrieve\n POST /api-banner/program-schedules/ → create (201)\n PUT /api-banner/program-schedules/{id}/ → full update (200)\n PATCH /api-banner/program-schedules/{id}/ → partial update (200)\n DELETE /api-banner/program-schedules/{id}/ → destroy (204)\n POST /api-banner/program-schedules/{id}/add_user/ → 200\n POST /api-banner/program-schedules/{id}/add_admin/ → 200\n\nRequest body translation (legacy → Connect):\n name, description → direct\n schedule_details, show_rotation_tab_default, restrict_rotation_view,\n show_block_naming, enable_rotation_block_directors → schedule_config booleans\n program (int) → program_id (resolved via /programs)\n academic_year (int) → academic_period_id (resolved via /academic-periods)\n admin_users (int[]) → admin_user_ids (resolved via /learners)\n users (int[]) → participant_user_ids (resolved via /learners)\n view_access_to_users (int[]) → view_only_user_ids (resolved via /learners)\n sites (int[]) → site_ids (resolved via /sites)\n show_contact_faculty / show_contact_trainee: accepted but ignored — read\n path always returns literal False so ignoring keeps GET→PUT round-trips\n consistent.\n view_access_to_roles, roles, groups: read-only / excluded in legacy → ignored.\n\nRequired on create (per legacy test_create): name, program, academic_year.\nRequired on PUT (per legacy test_update): name, program, academic_year.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"academic_year":{"type":"integer","description":"legacy id of academic_period_legacy_id"},"program":{"type":"integer","description":"legacy id of program_legacy_id"},"updated_by":{"type":"integer","description":"legacy id of updated_by_legacy_id"},"name":{"type":"string","description":"Connect name"},"description":{"type":"string","description":"Connect description"},"schedule_details":{"type":"string","description":"Connect schedule_details"},"show_rotation_tab_default":{"type":"string","description":"Connect show_rotation_tab_default"},"restrict_rotation_view":{"type":"string","description":"Connect restrict_rotation_view"},"show_block_naming":{"type":"string","description":"Connect show_block_naming"},"enable_rotation_block_directors":{"type":"string","description":"Connect enable_rotation_block_directors"},"created_date":{"type":"string","description":"Connect created_at (datetime_to_legacy_iso)"},"updated_at":{"type":"string","description":"Connect updated_at (datetime_to_legacy_iso)"},"admin_users":{"type":"string","description":"Connect admin_user_legacy_ids (legacy_id_array_to_int_list)"},"users":{"type":"string","description":"Connect participant_user_legacy_ids (legacy_id_array_to_int_list)"},"view_access_to_users":{"type":"string","description":"Connect view_only_user_legacy_ids (legacy_id_array_to_int_list)"},"sites":{"type":"string","description":"Connect site_legacy_ids (legacy_id_array_to_int_list)"},"view_access_to_roles":{"type":"string","description":"Connect view_role_names"},"show_contact_faculty":{"type":"string","description":"literal False"},"show_contact_trainee":{"type":"string","description":"literal False"}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProgramSchedules"}}}},"400":{"description":"validation error"},"401":{"description":"unauthenticated"},"404":{"description":"not found or out of tenant scope"}}}}}} ``` ## DELETE /api-banner/program-schedules/{id}/ > Legacy /api-banner/program-schedules/ bridge resource.\ > \ > Mirrors the \`\`ProgramScheduleViewSet\`\` contract from the legacy Django app:\ > GET /api-banner/program-schedules/ → list\ > GET /api-banner/program-schedules/{id}/ → retrieve\ > POST /api-banner/program-schedules/ → create (201)\ > PUT /api-banner/program-schedules/{id}/ → full update (200)\ > PATCH /api-banner/program-schedules/{id}/ → partial update (200)\ > DELETE /api-banner/program-schedules/{id}/ → destroy (204)\ > POST /api-banner/program-schedules/{id}/add\_user/ → 200\ > POST /api-banner/program-schedules/{id}/add\_admin/ → 200\ > \ > Request body translation (legacy → Connect):\ > name, description → direct\ > schedule\_details, show\_rotation\_tab\_default, restrict\_rotation\_view,\ > show\_block\_naming, enable\_rotation\_block\_directors → schedule\_config booleans\ > program (int) → program\_id (resolved via /programs)\ > academic\_year (int) → academic\_period\_id (resolved via /academic-periods)\ > admin\_users (int\[]) → admin\_user\_ids (resolved via /learners)\ > users (int\[]) → participant\_user\_ids (resolved via /learners)\ > view\_access\_to\_users (int\[]) → view\_only\_user\_ids (resolved via /learners)\ > sites (int\[]) → site\_ids (resolved via /sites)\ > show\_contact\_faculty / show\_contact\_trainee: accepted but ignored — read\ > path always returns literal False so ignoring keeps GET→PUT round-trips\ > consistent.\ > view\_access\_to\_roles, roles, groups: read-only / excluded in legacy → ignored.\ > \ > Required on create (per legacy test\_create): name, program, academic\_year.\ > Required on PUT (per legacy test\_update): name, program, academic\_year. ```json {"openapi":"3.1.0","info":{"title":"Medtrics Legacy SIS Bridge (Compatibility API)","version":"draft-2026-10-29"},"servers":[{"url":"https://{client}.mymedtrics.com","description":"Tenant host; Caddy routes /api-banner/* and /api/* to the bridge (internal only)","variables":{"client":{"default":"","description":"Tenant subdomain"}}},{"url":"http://localhost:8090","description":"local dev (see docker/caddy/Caddyfile for deployed hosts)"}],"security":[{"LegacyToken":[]},{"LegacyBasic":[]}],"components":{"securitySchemes":{"LegacyToken":{"type":"apiKey","in":"header","name":"Authorization","description":"Authorization: Token "},"LegacyBasic":{"type":"http","scheme":"basic"}},"schemas":{"ProgramSchedules":{"type":"object","description":"Legacy-shaped banner/program-schedules record as served by the bridge; translated from Connect /clinical-schedules","properties":{"id":{"type":"integer","description":"legacy id of legacy_id"},"academic_year":{"type":"integer","description":"legacy id of academic_period_legacy_id"},"program":{"type":"integer","description":"legacy id of program_legacy_id"},"updated_by":{"type":"integer","description":"legacy id of updated_by_legacy_id"},"name":{"type":"string","description":"Connect name"},"description":{"type":"string","description":"Connect description"},"schedule_details":{"type":"string","description":"Connect schedule_details"},"show_rotation_tab_default":{"type":"string","description":"Connect show_rotation_tab_default"},"restrict_rotation_view":{"type":"string","description":"Connect restrict_rotation_view"},"show_block_naming":{"type":"string","description":"Connect show_block_naming"},"enable_rotation_block_directors":{"type":"string","description":"Connect enable_rotation_block_directors"},"created_date":{"type":"string","description":"Connect created_at (datetime_to_legacy_iso)"},"updated_at":{"type":"string","description":"Connect updated_at (datetime_to_legacy_iso)"},"admin_users":{"type":"string","description":"Connect admin_user_legacy_ids (legacy_id_array_to_int_list)"},"users":{"type":"string","description":"Connect participant_user_legacy_ids (legacy_id_array_to_int_list)"},"view_access_to_users":{"type":"string","description":"Connect view_only_user_legacy_ids (legacy_id_array_to_int_list)"},"sites":{"type":"string","description":"Connect site_legacy_ids (legacy_id_array_to_int_list)"},"view_access_to_roles":{"type":"string","description":"Connect view_role_names"},"show_contact_faculty":{"type":"string","description":"literal False"},"show_contact_trainee":{"type":"string","description":"literal False"}}}}},"paths":{"/api-banner/program-schedules/{id}/":{"delete":{"operationId":"programSchedules_destroy","tags":["ProgramSchedules"],"description":"Legacy /api-banner/program-schedules/ bridge resource.\n\nMirrors the ``ProgramScheduleViewSet`` contract from the legacy Django app:\n GET /api-banner/program-schedules/ → list\n GET /api-banner/program-schedules/{id}/ → retrieve\n POST /api-banner/program-schedules/ → create (201)\n PUT /api-banner/program-schedules/{id}/ → full update (200)\n PATCH /api-banner/program-schedules/{id}/ → partial update (200)\n DELETE /api-banner/program-schedules/{id}/ → destroy (204)\n POST /api-banner/program-schedules/{id}/add_user/ → 200\n POST /api-banner/program-schedules/{id}/add_admin/ → 200\n\nRequest body translation (legacy → Connect):\n name, description → direct\n schedule_details, show_rotation_tab_default, restrict_rotation_view,\n show_block_naming, enable_rotation_block_directors → schedule_config booleans\n program (int) → program_id (resolved via /programs)\n academic_year (int) → academic_period_id (resolved via /academic-periods)\n admin_users (int[]) → admin_user_ids (resolved via /learners)\n users (int[]) → participant_user_ids (resolved via /learners)\n view_access_to_users (int[]) → view_only_user_ids (resolved via /learners)\n sites (int[]) → site_ids (resolved via /sites)\n show_contact_faculty / show_contact_trainee: accepted but ignored — read\n path always returns literal False so ignoring keeps GET→PUT round-trips\n consistent.\n view_access_to_roles, roles, groups: read-only / excluded in legacy → ignored.\n\nRequired on create (per legacy test_create): name, program, academic_year.\nRequired on PUT (per legacy test_update): name, program, academic_year.","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProgramSchedules"}}}},"400":{"description":"validation error"},"401":{"description":"unauthenticated"},"404":{"description":"not found or out of tenant scope"}}}}}} ``` ## PATCH /api-banner/program-schedules/{id}/ > Legacy /api-banner/program-schedules/ bridge resource.\ > \ > Mirrors the \`\`ProgramScheduleViewSet\`\` contract from the legacy Django app:\ > GET /api-banner/program-schedules/ → list\ > GET /api-banner/program-schedules/{id}/ → retrieve\ > POST /api-banner/program-schedules/ → create (201)\ > PUT /api-banner/program-schedules/{id}/ → full update (200)\ > PATCH /api-banner/program-schedules/{id}/ → partial update (200)\ > DELETE /api-banner/program-schedules/{id}/ → destroy (204)\ > POST /api-banner/program-schedules/{id}/add\_user/ → 200\ > POST /api-banner/program-schedules/{id}/add\_admin/ → 200\ > \ > Request body translation (legacy → Connect):\ > name, description → direct\ > schedule\_details, show\_rotation\_tab\_default, restrict\_rotation\_view,\ > show\_block\_naming, enable\_rotation\_block\_directors → schedule\_config booleans\ > program (int) → program\_id (resolved via /programs)\ > academic\_year (int) → academic\_period\_id (resolved via /academic-periods)\ > admin\_users (int\[]) → admin\_user\_ids (resolved via /learners)\ > users (int\[]) → participant\_user\_ids (resolved via /learners)\ > view\_access\_to\_users (int\[]) → view\_only\_user\_ids (resolved via /learners)\ > sites (int\[]) → site\_ids (resolved via /sites)\ > show\_contact\_faculty / show\_contact\_trainee: accepted but ignored — read\ > path always returns literal False so ignoring keeps GET→PUT round-trips\ > consistent.\ > view\_access\_to\_roles, roles, groups: read-only / excluded in legacy → ignored.\ > \ > Required on create (per legacy test\_create): name, program, academic\_year.\ > Required on PUT (per legacy test\_update): name, program, academic\_year. ```json {"openapi":"3.1.0","info":{"title":"Medtrics Legacy SIS Bridge (Compatibility API)","version":"draft-2026-10-29"},"servers":[{"url":"https://{client}.mymedtrics.com","description":"Tenant host; Caddy routes /api-banner/* and /api/* to the bridge (internal only)","variables":{"client":{"default":"","description":"Tenant subdomain"}}},{"url":"http://localhost:8090","description":"local dev (see docker/caddy/Caddyfile for deployed hosts)"}],"security":[{"LegacyToken":[]},{"LegacyBasic":[]}],"components":{"securitySchemes":{"LegacyToken":{"type":"apiKey","in":"header","name":"Authorization","description":"Authorization: Token "},"LegacyBasic":{"type":"http","scheme":"basic"}},"schemas":{"ProgramSchedules":{"type":"object","description":"Legacy-shaped banner/program-schedules record as served by the bridge; translated from Connect /clinical-schedules","properties":{"id":{"type":"integer","description":"legacy id of legacy_id"},"academic_year":{"type":"integer","description":"legacy id of academic_period_legacy_id"},"program":{"type":"integer","description":"legacy id of program_legacy_id"},"updated_by":{"type":"integer","description":"legacy id of updated_by_legacy_id"},"name":{"type":"string","description":"Connect name"},"description":{"type":"string","description":"Connect description"},"schedule_details":{"type":"string","description":"Connect schedule_details"},"show_rotation_tab_default":{"type":"string","description":"Connect show_rotation_tab_default"},"restrict_rotation_view":{"type":"string","description":"Connect restrict_rotation_view"},"show_block_naming":{"type":"string","description":"Connect show_block_naming"},"enable_rotation_block_directors":{"type":"string","description":"Connect enable_rotation_block_directors"},"created_date":{"type":"string","description":"Connect created_at (datetime_to_legacy_iso)"},"updated_at":{"type":"string","description":"Connect updated_at (datetime_to_legacy_iso)"},"admin_users":{"type":"string","description":"Connect admin_user_legacy_ids (legacy_id_array_to_int_list)"},"users":{"type":"string","description":"Connect participant_user_legacy_ids (legacy_id_array_to_int_list)"},"view_access_to_users":{"type":"string","description":"Connect view_only_user_legacy_ids (legacy_id_array_to_int_list)"},"sites":{"type":"string","description":"Connect site_legacy_ids (legacy_id_array_to_int_list)"},"view_access_to_roles":{"type":"string","description":"Connect view_role_names"},"show_contact_faculty":{"type":"string","description":"literal False"},"show_contact_trainee":{"type":"string","description":"literal False"}}}}},"paths":{"/api-banner/program-schedules/{id}/":{"patch":{"operationId":"programSchedules_partial_update","tags":["ProgramSchedules"],"description":"Legacy /api-banner/program-schedules/ bridge resource.\n\nMirrors the ``ProgramScheduleViewSet`` contract from the legacy Django app:\n GET /api-banner/program-schedules/ → list\n GET /api-banner/program-schedules/{id}/ → retrieve\n POST /api-banner/program-schedules/ → create (201)\n PUT /api-banner/program-schedules/{id}/ → full update (200)\n PATCH /api-banner/program-schedules/{id}/ → partial update (200)\n DELETE /api-banner/program-schedules/{id}/ → destroy (204)\n POST /api-banner/program-schedules/{id}/add_user/ → 200\n POST /api-banner/program-schedules/{id}/add_admin/ → 200\n\nRequest body translation (legacy → Connect):\n name, description → direct\n schedule_details, show_rotation_tab_default, restrict_rotation_view,\n show_block_naming, enable_rotation_block_directors → schedule_config booleans\n program (int) → program_id (resolved via /programs)\n academic_year (int) → academic_period_id (resolved via /academic-periods)\n admin_users (int[]) → admin_user_ids (resolved via /learners)\n users (int[]) → participant_user_ids (resolved via /learners)\n view_access_to_users (int[]) → view_only_user_ids (resolved via /learners)\n sites (int[]) → site_ids (resolved via /sites)\n show_contact_faculty / show_contact_trainee: accepted but ignored — read\n path always returns literal False so ignoring keeps GET→PUT round-trips\n consistent.\n view_access_to_roles, roles, groups: read-only / excluded in legacy → ignored.\n\nRequired on create (per legacy test_create): name, program, academic_year.\nRequired on PUT (per legacy test_update): name, program, academic_year.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"academic_year":{"type":"integer","description":"legacy id of academic_period_legacy_id"},"program":{"type":"integer","description":"legacy id of program_legacy_id"},"updated_by":{"type":"integer","description":"legacy id of updated_by_legacy_id"},"name":{"type":"string","description":"Connect name"},"description":{"type":"string","description":"Connect description"},"schedule_details":{"type":"string","description":"Connect schedule_details"},"show_rotation_tab_default":{"type":"string","description":"Connect show_rotation_tab_default"},"restrict_rotation_view":{"type":"string","description":"Connect restrict_rotation_view"},"show_block_naming":{"type":"string","description":"Connect show_block_naming"},"enable_rotation_block_directors":{"type":"string","description":"Connect enable_rotation_block_directors"},"created_date":{"type":"string","description":"Connect created_at (datetime_to_legacy_iso)"},"updated_at":{"type":"string","description":"Connect updated_at (datetime_to_legacy_iso)"},"admin_users":{"type":"string","description":"Connect admin_user_legacy_ids (legacy_id_array_to_int_list)"},"users":{"type":"string","description":"Connect participant_user_legacy_ids (legacy_id_array_to_int_list)"},"view_access_to_users":{"type":"string","description":"Connect view_only_user_legacy_ids (legacy_id_array_to_int_list)"},"sites":{"type":"string","description":"Connect site_legacy_ids (legacy_id_array_to_int_list)"},"view_access_to_roles":{"type":"string","description":"Connect view_role_names"},"show_contact_faculty":{"type":"string","description":"literal False"},"show_contact_trainee":{"type":"string","description":"literal False"}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProgramSchedules"}}}},"400":{"description":"validation error"},"401":{"description":"unauthenticated"},"404":{"description":"not found or out of tenant scope"}}}}}} ``` ## POST /api-banner/program-schedules/{id}/add\_user/ > Legacy /api-banner/program-schedules/ bridge resource.\ > \ > Mirrors the \`\`ProgramScheduleViewSet\`\` contract from the legacy Django app:\ > GET /api-banner/program-schedules/ → list\ > GET /api-banner/program-schedules/{id}/ → retrieve\ > POST /api-banner/program-schedules/ → create (201)\ > PUT /api-banner/program-schedules/{id}/ → full update (200)\ > PATCH /api-banner/program-schedules/{id}/ → partial update (200)\ > DELETE /api-banner/program-schedules/{id}/ → destroy (204)\ > POST /api-banner/program-schedules/{id}/add\_user/ → 200\ > POST /api-banner/program-schedules/{id}/add\_admin/ → 200\ > \ > Request body translation (legacy → Connect):\ > name, description → direct\ > schedule\_details, show\_rotation\_tab\_default, restrict\_rotation\_view,\ > show\_block\_naming, enable\_rotation\_block\_directors → schedule\_config booleans\ > program (int) → program\_id (resolved via /programs)\ > academic\_year (int) → academic\_period\_id (resolved via /academic-periods)\ > admin\_users (int\[]) → admin\_user\_ids (resolved via /learners)\ > users (int\[]) → participant\_user\_ids (resolved via /learners)\ > view\_access\_to\_users (int\[]) → view\_only\_user\_ids (resolved via /learners)\ > sites (int\[]) → site\_ids (resolved via /sites)\ > show\_contact\_faculty / show\_contact\_trainee: accepted but ignored — read\ > path always returns literal False so ignoring keeps GET→PUT round-trips\ > consistent.\ > view\_access\_to\_roles, roles, groups: read-only / excluded in legacy → ignored.\ > \ > Required on create (per legacy test\_create): name, program, academic\_year.\ > Required on PUT (per legacy test\_update): name, program, academic\_year. ```json {"openapi":"3.1.0","info":{"title":"Medtrics Legacy SIS Bridge (Compatibility API)","version":"draft-2026-10-29"},"servers":[{"url":"https://{client}.mymedtrics.com","description":"Tenant host; Caddy routes /api-banner/* and /api/* to the bridge (internal only)","variables":{"client":{"default":"","description":"Tenant subdomain"}}},{"url":"http://localhost:8090","description":"local dev (see docker/caddy/Caddyfile for deployed hosts)"}],"security":[{"LegacyToken":[]},{"LegacyBasic":[]}],"components":{"securitySchemes":{"LegacyToken":{"type":"apiKey","in":"header","name":"Authorization","description":"Authorization: Token "},"LegacyBasic":{"type":"http","scheme":"basic"}},"schemas":{"ProgramSchedules":{"type":"object","description":"Legacy-shaped banner/program-schedules record as served by the bridge; translated from Connect /clinical-schedules","properties":{"id":{"type":"integer","description":"legacy id of legacy_id"},"academic_year":{"type":"integer","description":"legacy id of academic_period_legacy_id"},"program":{"type":"integer","description":"legacy id of program_legacy_id"},"updated_by":{"type":"integer","description":"legacy id of updated_by_legacy_id"},"name":{"type":"string","description":"Connect name"},"description":{"type":"string","description":"Connect description"},"schedule_details":{"type":"string","description":"Connect schedule_details"},"show_rotation_tab_default":{"type":"string","description":"Connect show_rotation_tab_default"},"restrict_rotation_view":{"type":"string","description":"Connect restrict_rotation_view"},"show_block_naming":{"type":"string","description":"Connect show_block_naming"},"enable_rotation_block_directors":{"type":"string","description":"Connect enable_rotation_block_directors"},"created_date":{"type":"string","description":"Connect created_at (datetime_to_legacy_iso)"},"updated_at":{"type":"string","description":"Connect updated_at (datetime_to_legacy_iso)"},"admin_users":{"type":"string","description":"Connect admin_user_legacy_ids (legacy_id_array_to_int_list)"},"users":{"type":"string","description":"Connect participant_user_legacy_ids (legacy_id_array_to_int_list)"},"view_access_to_users":{"type":"string","description":"Connect view_only_user_legacy_ids (legacy_id_array_to_int_list)"},"sites":{"type":"string","description":"Connect site_legacy_ids (legacy_id_array_to_int_list)"},"view_access_to_roles":{"type":"string","description":"Connect view_role_names"},"show_contact_faculty":{"type":"string","description":"literal False"},"show_contact_trainee":{"type":"string","description":"literal False"}}}}},"paths":{"/api-banner/program-schedules/{id}/add_user/":{"post":{"operationId":"programSchedules_add_user","tags":["ProgramSchedules"],"description":"Legacy /api-banner/program-schedules/ bridge resource.\n\nMirrors the ``ProgramScheduleViewSet`` contract from the legacy Django app:\n GET /api-banner/program-schedules/ → list\n GET /api-banner/program-schedules/{id}/ → retrieve\n POST /api-banner/program-schedules/ → create (201)\n PUT /api-banner/program-schedules/{id}/ → full update (200)\n PATCH /api-banner/program-schedules/{id}/ → partial update (200)\n DELETE /api-banner/program-schedules/{id}/ → destroy (204)\n POST /api-banner/program-schedules/{id}/add_user/ → 200\n POST /api-banner/program-schedules/{id}/add_admin/ → 200\n\nRequest body translation (legacy → Connect):\n name, description → direct\n schedule_details, show_rotation_tab_default, restrict_rotation_view,\n show_block_naming, enable_rotation_block_directors → schedule_config booleans\n program (int) → program_id (resolved via /programs)\n academic_year (int) → academic_period_id (resolved via /academic-periods)\n admin_users (int[]) → admin_user_ids (resolved via /learners)\n users (int[]) → participant_user_ids (resolved via /learners)\n view_access_to_users (int[]) → view_only_user_ids (resolved via /learners)\n sites (int[]) → site_ids (resolved via /sites)\n show_contact_faculty / show_contact_trainee: accepted but ignored — read\n path always returns literal False so ignoring keeps GET→PUT round-trips\n consistent.\n view_access_to_roles, roles, groups: read-only / excluded in legacy → ignored.\n\nRequired on create (per legacy test_create): name, program, academic_year.\nRequired on PUT (per legacy test_update): name, program, academic_year.","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["name","program","academic_year"],"properties":{"academic_year":{"type":"integer","description":"legacy id of academic_period_legacy_id"},"program":{"type":"integer","description":"legacy id of program_legacy_id"},"updated_by":{"type":"integer","description":"legacy id of updated_by_legacy_id"},"name":{"type":"string","description":"Connect name"},"description":{"type":"string","description":"Connect description"},"schedule_details":{"type":"string","description":"Connect schedule_details"},"show_rotation_tab_default":{"type":"string","description":"Connect show_rotation_tab_default"},"restrict_rotation_view":{"type":"string","description":"Connect restrict_rotation_view"},"show_block_naming":{"type":"string","description":"Connect show_block_naming"},"enable_rotation_block_directors":{"type":"string","description":"Connect enable_rotation_block_directors"},"created_date":{"type":"string","description":"Connect created_at (datetime_to_legacy_iso)"},"updated_at":{"type":"string","description":"Connect updated_at (datetime_to_legacy_iso)"},"admin_users":{"type":"string","description":"Connect admin_user_legacy_ids (legacy_id_array_to_int_list)"},"users":{"type":"string","description":"Connect participant_user_legacy_ids (legacy_id_array_to_int_list)"},"view_access_to_users":{"type":"string","description":"Connect view_only_user_legacy_ids (legacy_id_array_to_int_list)"},"sites":{"type":"string","description":"Connect site_legacy_ids (legacy_id_array_to_int_list)"},"view_access_to_roles":{"type":"string","description":"Connect view_role_names"},"show_contact_faculty":{"type":"string","description":"literal False"},"show_contact_trainee":{"type":"string","description":"literal False"}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProgramSchedules"}}}},"400":{"description":"validation error"},"401":{"description":"unauthenticated"},"404":{"description":"not found or out of tenant scope"}}}}}} ``` ## POST /api-banner/program-schedules/{id}/add\_admin/ > Legacy /api-banner/program-schedules/ bridge resource.\ > \ > Mirrors the \`\`ProgramScheduleViewSet\`\` contract from the legacy Django app:\ > GET /api-banner/program-schedules/ → list\ > GET /api-banner/program-schedules/{id}/ → retrieve\ > POST /api-banner/program-schedules/ → create (201)\ > PUT /api-banner/program-schedules/{id}/ → full update (200)\ > PATCH /api-banner/program-schedules/{id}/ → partial update (200)\ > DELETE /api-banner/program-schedules/{id}/ → destroy (204)\ > POST /api-banner/program-schedules/{id}/add\_user/ → 200\ > POST /api-banner/program-schedules/{id}/add\_admin/ → 200\ > \ > Request body translation (legacy → Connect):\ > name, description → direct\ > schedule\_details, show\_rotation\_tab\_default, restrict\_rotation\_view,\ > show\_block\_naming, enable\_rotation\_block\_directors → schedule\_config booleans\ > program (int) → program\_id (resolved via /programs)\ > academic\_year (int) → academic\_period\_id (resolved via /academic-periods)\ > admin\_users (int\[]) → admin\_user\_ids (resolved via /learners)\ > users (int\[]) → participant\_user\_ids (resolved via /learners)\ > view\_access\_to\_users (int\[]) → view\_only\_user\_ids (resolved via /learners)\ > sites (int\[]) → site\_ids (resolved via /sites)\ > show\_contact\_faculty / show\_contact\_trainee: accepted but ignored — read\ > path always returns literal False so ignoring keeps GET→PUT round-trips\ > consistent.\ > view\_access\_to\_roles, roles, groups: read-only / excluded in legacy → ignored.\ > \ > Required on create (per legacy test\_create): name, program, academic\_year.\ > Required on PUT (per legacy test\_update): name, program, academic\_year. ```json {"openapi":"3.1.0","info":{"title":"Medtrics Legacy SIS Bridge (Compatibility API)","version":"draft-2026-10-29"},"servers":[{"url":"https://{client}.mymedtrics.com","description":"Tenant host; Caddy routes /api-banner/* and /api/* to the bridge (internal only)","variables":{"client":{"default":"","description":"Tenant subdomain"}}},{"url":"http://localhost:8090","description":"local dev (see docker/caddy/Caddyfile for deployed hosts)"}],"security":[{"LegacyToken":[]},{"LegacyBasic":[]}],"components":{"securitySchemes":{"LegacyToken":{"type":"apiKey","in":"header","name":"Authorization","description":"Authorization: Token "},"LegacyBasic":{"type":"http","scheme":"basic"}},"schemas":{"ProgramSchedules":{"type":"object","description":"Legacy-shaped banner/program-schedules record as served by the bridge; translated from Connect /clinical-schedules","properties":{"id":{"type":"integer","description":"legacy id of legacy_id"},"academic_year":{"type":"integer","description":"legacy id of academic_period_legacy_id"},"program":{"type":"integer","description":"legacy id of program_legacy_id"},"updated_by":{"type":"integer","description":"legacy id of updated_by_legacy_id"},"name":{"type":"string","description":"Connect name"},"description":{"type":"string","description":"Connect description"},"schedule_details":{"type":"string","description":"Connect schedule_details"},"show_rotation_tab_default":{"type":"string","description":"Connect show_rotation_tab_default"},"restrict_rotation_view":{"type":"string","description":"Connect restrict_rotation_view"},"show_block_naming":{"type":"string","description":"Connect show_block_naming"},"enable_rotation_block_directors":{"type":"string","description":"Connect enable_rotation_block_directors"},"created_date":{"type":"string","description":"Connect created_at (datetime_to_legacy_iso)"},"updated_at":{"type":"string","description":"Connect updated_at (datetime_to_legacy_iso)"},"admin_users":{"type":"string","description":"Connect admin_user_legacy_ids (legacy_id_array_to_int_list)"},"users":{"type":"string","description":"Connect participant_user_legacy_ids (legacy_id_array_to_int_list)"},"view_access_to_users":{"type":"string","description":"Connect view_only_user_legacy_ids (legacy_id_array_to_int_list)"},"sites":{"type":"string","description":"Connect site_legacy_ids (legacy_id_array_to_int_list)"},"view_access_to_roles":{"type":"string","description":"Connect view_role_names"},"show_contact_faculty":{"type":"string","description":"literal False"},"show_contact_trainee":{"type":"string","description":"literal False"}}}}},"paths":{"/api-banner/program-schedules/{id}/add_admin/":{"post":{"operationId":"programSchedules_add_admin","tags":["ProgramSchedules"],"description":"Legacy /api-banner/program-schedules/ bridge resource.\n\nMirrors the ``ProgramScheduleViewSet`` contract from the legacy Django app:\n GET /api-banner/program-schedules/ → list\n GET /api-banner/program-schedules/{id}/ → retrieve\n POST /api-banner/program-schedules/ → create (201)\n PUT /api-banner/program-schedules/{id}/ → full update (200)\n PATCH /api-banner/program-schedules/{id}/ → partial update (200)\n DELETE /api-banner/program-schedules/{id}/ → destroy (204)\n POST /api-banner/program-schedules/{id}/add_user/ → 200\n POST /api-banner/program-schedules/{id}/add_admin/ → 200\n\nRequest body translation (legacy → Connect):\n name, description → direct\n schedule_details, show_rotation_tab_default, restrict_rotation_view,\n show_block_naming, enable_rotation_block_directors → schedule_config booleans\n program (int) → program_id (resolved via /programs)\n academic_year (int) → academic_period_id (resolved via /academic-periods)\n admin_users (int[]) → admin_user_ids (resolved via /learners)\n users (int[]) → participant_user_ids (resolved via /learners)\n view_access_to_users (int[]) → view_only_user_ids (resolved via /learners)\n sites (int[]) → site_ids (resolved via /sites)\n show_contact_faculty / show_contact_trainee: accepted but ignored — read\n path always returns literal False so ignoring keeps GET→PUT round-trips\n consistent.\n view_access_to_roles, roles, groups: read-only / excluded in legacy → ignored.\n\nRequired on create (per legacy test_create): name, program, academic_year.\nRequired on PUT (per legacy test_update): name, program, academic_year.","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["name","program","academic_year"],"properties":{"academic_year":{"type":"integer","description":"legacy id of academic_period_legacy_id"},"program":{"type":"integer","description":"legacy id of program_legacy_id"},"updated_by":{"type":"integer","description":"legacy id of updated_by_legacy_id"},"name":{"type":"string","description":"Connect name"},"description":{"type":"string","description":"Connect description"},"schedule_details":{"type":"string","description":"Connect schedule_details"},"show_rotation_tab_default":{"type":"string","description":"Connect show_rotation_tab_default"},"restrict_rotation_view":{"type":"string","description":"Connect restrict_rotation_view"},"show_block_naming":{"type":"string","description":"Connect show_block_naming"},"enable_rotation_block_directors":{"type":"string","description":"Connect enable_rotation_block_directors"},"created_date":{"type":"string","description":"Connect created_at (datetime_to_legacy_iso)"},"updated_at":{"type":"string","description":"Connect updated_at (datetime_to_legacy_iso)"},"admin_users":{"type":"string","description":"Connect admin_user_legacy_ids (legacy_id_array_to_int_list)"},"users":{"type":"string","description":"Connect participant_user_legacy_ids (legacy_id_array_to_int_list)"},"view_access_to_users":{"type":"string","description":"Connect view_only_user_legacy_ids (legacy_id_array_to_int_list)"},"sites":{"type":"string","description":"Connect site_legacy_ids (legacy_id_array_to_int_list)"},"view_access_to_roles":{"type":"string","description":"Connect view_role_names"},"show_contact_faculty":{"type":"string","description":"literal False"},"show_contact_trainee":{"type":"string","description":"literal False"}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProgramSchedules"}}}},"400":{"description":"validation error"},"401":{"description":"unauthenticated"},"404":{"description":"not found or out of tenant scope"}}}}}} ``` --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation by asking a question. Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters: ``` GET https://docs.mymedtrics.com/api-reference/medtrics-classic-sis-bridge/program-schedules.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.