DEdepartment-for-education
Teaching Events

Adds or updates a teaching event.

Changed on

If the id is specified then the existing teaching event will be updated, otherwise a new teaching event will be created.

post/api/teaching_events

Request

  • Base URL
    https://getintoteachingapi-production.teacherservices.cloud (the document declares no server; this is the origin it was published from)
  • Auth
    API key in header Authorization

Request body

idstring uuid nullable
typeIdinteger
statusIdinteger
regionIdinteger nullable
readableIdstring required
webFeedIdstring nullable

If set, the API will accept new attendees for this event (an external sign up should be used if this value is nil).

referenceNumberstring nullable
registrationEmailLinkstring nullable
isOnlineboolean
namestring required
summarystring nullable
messagestring nullable

Used to push miscellaneous messages to users (if an event is close to being booked out, for example).

descriptionstring nullable
videoUrlstring nullable
scribbleIdstring nullable
providerWebsiteUrlstring nullable
providerTargetAudiencestring nullable
providerOrganiserstring nullable
providerContactEmailstring email nullable
startAtstring date-time
endAtstring date-time
providersListstring nullable
isVirtualboolean
accessibilityOptionsinteger[] nullable
isInPersonboolean

Response

Created

idstring uuid nullable
typeIdinteger
statusIdinteger
regionIdinteger nullable
readableIdstring required
webFeedIdstring nullable

If set, the API will accept new attendees for this event (an external sign up should be used if this value is nil).

referenceNumberstring nullable
registrationEmailLinkstring nullable
isOnlineboolean
namestring required
summarystring nullable
messagestring nullable

Used to push miscellaneous messages to users (if an event is close to being booked out, for example).

descriptionstring nullable
videoUrlstring nullable
scribbleIdstring nullable
providerWebsiteUrlstring nullable
providerTargetAudiencestring nullable
providerOrganiserstring nullable
providerContactEmailstring email nullable
startAtstring date-time
endAtstring date-time
providersListstring nullable
isVirtualboolean
accessibilityOptionsinteger[] nullable
isInPersonboolean

Changes

  • f3548f6dfc30Revision changes
    • info

      added the new optional request property (media type: application/json)

    • info

      added the new optional request property (media type: text/json)

    • info

      added the new optional request property (media type: application/*+json)

    • info

      added the new optional request property (media type: application/json)

    • info

      added the new optional request property (media type: text/json)

    • info

      added the new optional request property (media type: application/*+json)

    • info

      added the optional property to the response with the status (media type: text/plain)

    • info

      added the optional property to the response with the status (media type: application/json)

    • info

      added the optional property to the response with the status (media type: text/json)

    • info

      added the optional property to the response with the status (media type: text/plain)

    • info

      added the optional property to the response with the status (media type: application/json)

    • info

      added the optional property to the response with the status (media type: text/json)