Update Program

PATCH /v1/programs/{id}

Path parameters

id string Required

Program ID

application/json

Body

The user attributes

program object Required

A program
Hide program attributes Show program attributes object
- admission_criteria array[object]
  Hide admission_criteria attributes Show admission_criteria attributes object
  
  criterion string
  
  Admission criterion
  
  type string
  
  Admission criterion type
- audience string
  
  Audience
  
  Values are single or group.
- degree string
  
  Degree
  
  Values are trade, federal, internal, other, or none.
- id integer
  
  Program ID
- industry_branch string
  
  Industry branch
  
  Values are gtb, kmb, ubd, or psd.
- insertedAt string(date-time)
  
  Creation timestamp
- lessons integer
  
  Number of lessons (UE)
- practical_lessons integer
  
  Number of practical lessons (UE) -> Betriebliche Lernphase
- program_type string
  
  Program type
  
  Values are program or module_program.
- slug string
  
  Program slug
- subject_area float
  
  Subject area
- teaching_style string
  
  Teaching style
  
  Values are full_time, part_time, or next_to_work.
- title string Required
  
  Program name
- updatedAt string(date-time)
  
  Update timestamp

Responses

200 application/json

Program response
Hide response attribute Show response attribute object
- data object
  
  A program
  
  Hide data attributes Show data attributes object
  
  admission_criteria array[object]
  
  Hide admission_criteria attributes Show admission_criteria attributes object
  
  criterion string
  
  Admission criterion
  
  type string
  
  Admission criterion type
  
  audience string
  
  Audience
  
  Values are single or group.
  
  degree string
  
  Degree
  
  Values are trade, federal, internal, other, or none.
  
  id integer
  
  Program ID
  
  industry_branch string
  
  Industry branch
  
  Values are gtb, kmb, ubd, or psd.
  
  insertedAt string(date-time)
  
  Creation timestamp
  
  lessons integer
  
  Number of lessons (UE)
  
  practical_lessons integer
  
  Number of practical lessons (UE) -> Betriebliche Lernphase
  
  program_type string
  
  Program type
  
  Values are program or module_program.
  
  slug string
  
  Program slug
  
  subject_area float
  
  Subject area
  
  teaching_style string
  
  Teaching style
  
  Values are full_time, part_time, or next_to_work.
  
  title string Required
  
  Program name
  
  updatedAt string(date-time)
  
  Update timestamp

PATCH /v1/programs/{id}

curl \
 -X PATCH https://api.azav-pilot.de/v1/programs/uuidv4 \
 -H "Content-Type: application/json" \
 -d '{"program":{"id":"\u003cuuid v4\u003e","slug":"zertifizierter-scrum-master","title":"Zertifizierter SCRUM Master","degree":"trade","lessons":0,"audience":"single","program_type":"program","subject_area":1.1,"teaching_style":"full_time","certified_since":{"day":15,"year":2024,"month":10,"calendar":"Elixir.Calendar.ISO"},"certified_until":{"day":15,"year":2025,"month":10,"calendar":"Elixir.Calendar.ISO"},"cost_per_lesson":0,"industry_branch":"gtb","cost_per_attendee":0,"practical_lessons":0,"admission_criteria":[{"type":"boolean","criterion":"Deutschkenntnisse min. B3"}],"expected_class_size":0,"minimum_attendance_rate":0}}'

Request example

{
  "program": {
    "id": "<uuid v4>",
    "slug": "zertifizierter-scrum-master",
    "title": "Zertifizierter SCRUM Master",
    "degree": "trade",
    "lessons": 0,
    "audience": "single",
    "program_type": "program",
    "subject_area": 1.1,
    "teaching_style": "full_time",
    "certified_since": {
      "day": 15,
      "year": 2024,
      "month": 10,
      "calendar": "Elixir.Calendar.ISO"
    },
    "certified_until": {
      "day": 15,
      "year": 2025,
      "month": 10,
      "calendar": "Elixir.Calendar.ISO"
    },
    "cost_per_lesson": 0,
    "industry_branch": "gtb",
    "cost_per_attendee": 0,
    "practical_lessons": 0,
    "admission_criteria": [
      {
        "type": "boolean",
        "criterion": "Deutschkenntnisse min. B3"
      }
    ],
    "expected_class_size": 0,
    "minimum_attendance_rate": 0
  }
}

Response examples (200)

{
  "data": {
    "id": "<uuid v4>",
    "slug": "zertifizierter-scrum-master",
    "title": "Zertifizierter SCRUM Master",
    "degree": "trade",
    "lessons": 0,
    "audience": "single",
    "program_type": "program",
    "subject_area": 1.1,
    "teaching_style": "full_time",
    "certified_since": {
      "day": 15,
      "year": 2024,
      "month": 10,
      "calendar": "Elixir.Calendar.ISO"
    },
    "certified_until": {
      "day": 15,
      "year": 2025,
      "month": 10,
      "calendar": "Elixir.Calendar.ISO"
    },
    "cost_per_lesson": 0,
    "industry_branch": "gtb",
    "cost_per_attendee": 0,
    "practical_lessons": 0,
    "admission_criteria": [
      {
        "type": "boolean",
        "criterion": "Deutschkenntnisse min. B3"
      }
    ],
    "expected_class_size": 0,
    "minimum_attendance_rate": 0
  }
}