Sign in
recitations

Create a new Recitation record

Changed on
post/recitations/

Request

  • The document declares no server URL.
  • Auth: API key in header Authorization

Request body

idstring uuid required
mushaf_idstring uuid required
get_mushaf_idstring required
status'draft' | 'pending_review' | 'published'
  • draft - Draft
  • pending_review - Pending review
  • published - Published
reciter_account_idstring uuid required
recitation_datestring date nullable
recitation_locationstring nullable
track_countstring required
total_durationstring required
recitation_typestring required
is_primaryboolean
created_atstring date-time required
updated_atstring date-time required

Response

idstring uuid required
mushaf_idstring uuid required
get_mushaf_idstring required
status'draft' | 'pending_review' | 'published'
  • draft - Draft
  • pending_review - Pending review
  • published - Published
reciter_account_idstring uuid required
recitation_datestring date nullable
recitation_locationstring nullable
track_countstring required
total_durationstring required
recitation_typestring required
is_primaryboolean
created_atstring date-time required
updated_atstring date-time required

Changes

  • aa7b100ef965Revision changes
    • info

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

    • info

      added the new optional request property (media type: application/x-www-form-urlencoded)

    • info

      added the new optional request property (media type: multipart/form-data)

    • info

      added the optional property to the response with the status

  • edd2c4f2de3bRevision changes
    • breaking

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

    • breaking

      added the new required request property (media type: application/x-www-form-urlencoded)

    • breaking

      added the new required request property (media type: multipart/form-data)

    • breaking

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

    • breaking

      added the new required request property (media type: application/x-www-form-urlencoded)

    • breaking

      added the new required request property (media type: multipart/form-data)

    • breaking

      the response property became nullable for the status

    • breaking

      the response property became nullable for the status

    • breaking

      the response property became optional for the status

    • breaking

      the response property became optional for the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • warning

      removed the request property (media type: application/json)

    • warning

      removed the request property (media type: application/x-www-form-urlencoded)

    • warning

      removed the request property (media type: multipart/form-data)

    • warning

      removed the request property (media type: application/json)

    • warning

      removed the request property (media type: application/x-www-form-urlencoded)

    • warning

      removed the request property (media type: multipart/form-data)

    • warning

      removed the request property (media type: application/json)

    • warning

      removed the request property (media type: application/x-www-form-urlencoded)

    • warning

      removed the request property (media type: multipart/form-data)

    • info

      the request property became nullable (media type: application/json)

    • info

      the request property became nullable (media type: application/x-www-form-urlencoded)

    • info

      the request property became nullable (media type: multipart/form-data)

    • info

      the request property became nullable (media type: application/json)

    • info

      the request property became nullable (media type: application/x-www-form-urlencoded)

    • info

      the request property became nullable (media type: multipart/form-data)

    • info

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

    • info

      the request property became optional (media type: application/x-www-form-urlencoded)

    • info

      the request property became optional (media type: multipart/form-data)

    • info

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

    • info

      the request property became optional (media type: application/x-www-form-urlencoded)

    • info

      the request property became optional (media type: multipart/form-data)

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required write-only property mushaf_id to the response with the status

    • info

      added the required write-only property reciter_account_id to the response with the status

    • info

      removed the required write-only property mushaf_uuid from the response with the status

    • info

      removed the required write-only property reciter_account_uuid from the response with the status