> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://apidoc.dreamclass.io/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://apidoc.dreamclass.io/_mcp/server. # Period POST https://#post5 Content-Type: application/json Webhook related to school period, trigged upon - Period created: PERIOD_CREATED - Period updated: PERIOD_UPDATED - Period deleted: PERIOD_DELETED Using the provided id, use the GetSchoolPeriods API to retrieve more data. Reference: https://apidoc.dreamclass.io/dream-class-api/webhooks/period ## OpenAPI Specification ```yaml openapi: 3.1.0 info: title: collection version: 1.0.0 paths: /#post5: post: operationId: period summary: Period description: >- Webhook related to school period, trigged upon - Period created: PERIOD_CREATED - Period updated: PERIOD_UPDATED - Period deleted: PERIOD_DELETED Using the provided id, use the GetSchoolPeriods API to retrieve more data. tags: - subpackage_webhooks responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/Webhooks_Period_Response_200' requestBody: content: application/json: schema: type: object properties: id: type: string format: uuid data: $ref: >- #/components/schemas/Post5PostRequestBodyContentApplicationJsonSchemaData type: type: string tenant: type: string signature: type: string timestamp: type: integer required: - id - data - type - tenant - signature - timestamp servers: - url: https:/ description: https://{server} - url: https://your-webhook-url description: https://your-webhook-url components: schemas: Post5PostRequestBodyContentApplicationJsonSchemaData: type: object properties: id: type: integer name: type: string endDate: type: string format: date duration: description: Any type shortName: type: string startDate: type: string format: date schoolyear: description: Any type required: - id - name - endDate - shortName - startDate title: Post5PostRequestBodyContentApplicationJsonSchemaData Webhooks_Period_Response_200: type: object properties: {} description: Empty response body title: Webhooks_Period_Response_200 ``` ## Examples **Request** ```json { "id": "d0df8e25-10b5-477c-9d82-2e16c2a26f48", "data": { "id": 54, "name": "2024-2025", "endDate": "2024-12-25", "shortName": "S4", "startDate": "2024-09-24" }, "type": "PERIOD_CREATED", "tenant": "my-school", "signature": "6cs/CkypYhXApXCMXaCeU8NkhxRSM/bA+FZuIkDAykg=", "timestamp": 1727883521394 } ``` **Response** ```json {} ``` **SDK Code** ```python import requests url = "https://https/#post5" payload = { "id": "d0df8e25-10b5-477c-9d82-2e16c2a26f48", "data": { "id": 54, "name": "2024-2025", "endDate": "2024-12-25", "shortName": "S4", "startDate": "2024-09-24" }, "type": "PERIOD_CREATED", "tenant": "my-school", "signature": "6cs/CkypYhXApXCMXaCeU8NkhxRSM/bA+FZuIkDAykg=", "timestamp": 1727883521394 } headers = {"Content-Type": "application/json"} response = requests.post(url, json=payload, headers=headers) print(response.json()) ``` ```javascript const url = 'https://https/#post5'; const options = { method: 'POST', headers: {'Content-Type': 'application/json'}, body: '{"id":"d0df8e25-10b5-477c-9d82-2e16c2a26f48","data":{"id":54,"name":"2024-2025","endDate":"2024-12-25","shortName":"S4","startDate":"2024-09-24"},"type":"PERIOD_CREATED","tenant":"my-school","signature":"6cs/CkypYhXApXCMXaCeU8NkhxRSM/bA+FZuIkDAykg=","timestamp":1727883521394}' }; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go package main import ( "fmt" "strings" "net/http" "io" ) func main() { url := "https://https/#post5" payload := strings.NewReader("{\n \"id\": \"d0df8e25-10b5-477c-9d82-2e16c2a26f48\",\n \"data\": {\n \"id\": 54,\n \"name\": \"2024-2025\",\n \"endDate\": \"2024-12-25\",\n \"shortName\": \"S4\",\n \"startDate\": \"2024-09-24\"\n },\n \"type\": \"PERIOD_CREATED\",\n \"tenant\": \"my-school\",\n \"signature\": \"6cs/CkypYhXApXCMXaCeU8NkhxRSM/bA+FZuIkDAykg=\",\n \"timestamp\": 1727883521394\n}") req, _ := http.NewRequest("POST", url, payload) req.Header.Add("Content-Type", "application/json") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby require 'uri' require 'net/http' url = URI("https://https/#post5") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Post.new(url) request["Content-Type"] = 'application/json' request.body = "{\n \"id\": \"d0df8e25-10b5-477c-9d82-2e16c2a26f48\",\n \"data\": {\n \"id\": 54,\n \"name\": \"2024-2025\",\n \"endDate\": \"2024-12-25\",\n \"shortName\": \"S4\",\n \"startDate\": \"2024-09-24\"\n },\n \"type\": \"PERIOD_CREATED\",\n \"tenant\": \"my-school\",\n \"signature\": \"6cs/CkypYhXApXCMXaCeU8NkhxRSM/bA+FZuIkDAykg=\",\n \"timestamp\": 1727883521394\n}" response = http.request(request) puts response.read_body ``` ```java import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.post("https://https/#post5") .header("Content-Type", "application/json") .body("{\n \"id\": \"d0df8e25-10b5-477c-9d82-2e16c2a26f48\",\n \"data\": {\n \"id\": 54,\n \"name\": \"2024-2025\",\n \"endDate\": \"2024-12-25\",\n \"shortName\": \"S4\",\n \"startDate\": \"2024-09-24\"\n },\n \"type\": \"PERIOD_CREATED\",\n \"tenant\": \"my-school\",\n \"signature\": \"6cs/CkypYhXApXCMXaCeU8NkhxRSM/bA+FZuIkDAykg=\",\n \"timestamp\": 1727883521394\n}") .asString(); ``` ```php request('POST', 'https://https/#post5', [ 'body' => '{ "id": "d0df8e25-10b5-477c-9d82-2e16c2a26f48", "data": { "id": 54, "name": "2024-2025", "endDate": "2024-12-25", "shortName": "S4", "startDate": "2024-09-24" }, "type": "PERIOD_CREATED", "tenant": "my-school", "signature": "6cs/CkypYhXApXCMXaCeU8NkhxRSM/bA+FZuIkDAykg=", "timestamp": 1727883521394 }', 'headers' => [ 'Content-Type' => 'application/json', ], ]); echo $response->getBody(); ``` ```csharp using RestSharp; var client = new RestClient("https://https/#post5"); var request = new RestRequest(Method.POST); request.AddHeader("Content-Type", "application/json"); request.AddParameter("application/json", "{\n \"id\": \"d0df8e25-10b5-477c-9d82-2e16c2a26f48\",\n \"data\": {\n \"id\": 54,\n \"name\": \"2024-2025\",\n \"endDate\": \"2024-12-25\",\n \"shortName\": \"S4\",\n \"startDate\": \"2024-09-24\"\n },\n \"type\": \"PERIOD_CREATED\",\n \"tenant\": \"my-school\",\n \"signature\": \"6cs/CkypYhXApXCMXaCeU8NkhxRSM/bA+FZuIkDAykg=\",\n \"timestamp\": 1727883521394\n}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); ``` ```swift import Foundation let headers = ["Content-Type": "application/json"] let parameters = [ "id": "d0df8e25-10b5-477c-9d82-2e16c2a26f48", "data": [ "id": 54, "name": "2024-2025", "endDate": "2024-12-25", "shortName": "S4", "startDate": "2024-09-24" ], "type": "PERIOD_CREATED", "tenant": "my-school", "signature": "6cs/CkypYhXApXCMXaCeU8NkhxRSM/bA+FZuIkDAykg=", "timestamp": 1727883521394 ] as [String : Any] let postData = JSONSerialization.data(withJSONObject: parameters, options: []) let request = NSMutableURLRequest(url: NSURL(string: "https://https/#post5")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "POST" request.allHTTPHeaderFields = headers request.httpBody = postData as Data let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```