Skip to content
Sanmopia Modernization

Open reservation collaboration workspace

Switch to Zen Mode
POST
/reservation-collaboration-workspaces/{reservationId}
curl --request POST \
  --url https://example.com/reservation-collaboration-workspaces/example \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "branchContext": { "branchId": 1, "branchCode": "example", "branchName": "example", "headquartersId": 1, "branchOperatorId": 1, "caregiverIds": [ 1 ] }, "branchActor": { "actorUserId": "example", "branchId": 1, "role": "example" }, "requestedFieldPaths": [ "example" ], "draftToken": "example", "returnStateToken": "example" }'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
reservationId
required
string
>= 1 characters

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
branchContext
required
object
branchId
required
integer
>= 1
branchCode
required
string
>= 1 characters
branchName
required
string
>= 1 characters
headquartersId
required
integer | null
>= 1
branchOperatorId
required
integer | null
>= 1
caregiverIds
required
Array<integer>
key
additional properties
branchActor
required
object
actorUserId
required
string
>= 1 characters
branchId
required
integer
>= 1
role
required
string
>= 1 characters
key
additional properties
requestedFieldPaths
required
Array<string>
draftToken
string
>= 1 characters
returnStateToken
string
>= 1 characters
key
additional properties

Responses

Section titled “Responses”

200

Section titled “200”

Reservation collaboration workspace state

Media typeapplication/json
ReservationCollaborationWorkspaceState
object
reservationId
required
string
>= 1 characters
currentRevision
required
integer
realtimeTopic
required
string
>= 1 characters
currentValuesByField
required
object
payment_fact.operator_edit_targets
Array<object>
OperatorPaymentFactEditTargetProjection
object
paymentFactId
required
string
>= 1 characters
reservationBookingId
required
string
>= 1 characters
paymentPurpose
required
string
Allowed values: customer_share_deposit customer_share_balance service_balance pre_reservation_deposit
paymentFactRevision
required
integer
amountSnapshot
required
object
amountSnapshotKey
required
string
>= 1 characters
amountKrw
required
integer
priceCatalogRevision
required
string
>= 1 characters
capturedAt
required
string format: date-time
chargeSnapshotKey
string | null
>= 1 characters
couponSnapshotKey
string | null
>= 1 characters
supportBenefitSnapshotKey
string | null
>= 1 characters
sourceEvidenceKeys
required
Array<string>
>= 1 items unique items
key
additional properties
editCapability
required
string
Allowed values: enabled disabled
allowedIntents
required
Array<string>
unique items
Allowed values: mark_paid mark_unpaid
disabledReasonCode
required
string | null
Allowed values: payment_fact_refunded settlement_locked edit_capability_denied
key
additional properties
key
additional properties
latestJournalEntry
required
One of:
object
auditEventId
required
string
>= 1 characters
reservationId
required
string
>= 1 characters
operationCommand
required
string
Allowed values: start_consultation confirm_service_schedule begin_care_delivery prepare_settlement complete_reservation cancel_reservation stop_care_delivery approve_extension resume_care_delivery register_offline_reservation request_reservation_change request_care_stop approve_cancellation_request expire_virtual_account_reservation record_virtual_account_deposit assign_primary_caregiver replace_primary_caregiver assign_assistant_caregiver remove_assistant_caregiver record_caregiver_attendance record_care_delivery record_daily_care_report record_caregiver_service_balance_receipt transfer_reservation_branch change_reservation_price_version
actorKind
required
string
Allowed values: mother caregiver branch_operator hq_admin
actorProfileId
required
string
>= 1 characters
beforeRevision
required
integer
afterRevision
required
integer
>= 1
idempotencyKey
required
string
>= 1 characters
sourceWorkspaceId
required
string
>= 1 characters
mutationKinds
required
Array<string>
>= 1 items
Allowed values: status_transition service_schedule caregiver_assignment payment_fact settlement_fact branch_handoff memo address document_state
fieldChanges
required
Array<object>
>= 1 items
object
fieldPath
required
string
/^[a-z][a-z0-9_]*(\.[a-z][a-z0-9_]*)*$/
beforeValue
required
afterValue
required
key
additional properties
recordedAt
required
string format: date-time
navigationIntent
required
string
Allowed values: stay_on_workspace return_to_saved_list_state open_next_work_item close_modal
returnStateToken
required
string | null
>= 1 characters
reasonCode
required
string | null
/^[a-z][a-z0-9_]*$/
note
required
string | null
>= 1 characters
correlationId
required
string | null
>= 1 characters
causationId
required
string | null
>= 1 characters
key
additional properties
coordinationPolicy
required
object
realtimeProvider
required
string
Allowed value: supabase_realtime
realtimeEventName
required
string
Allowed value: reservation_projection_invalidated
realtimeChannelMode
required
string
Allowed value: private_broadcast_and_presence
staleCommitPolicy
required
string
Allowed value: expected_revision_required
dirtyNavigationPolicy
required
string
Allowed value: require_save_discard_or_draft
auditTrailMode
required
string
Allowed value: domain_change_journal
presenceEnabled
required
boolean
key
additional properties
draftSession
required
object
workspaceId
required
string
>= 1 characters
draftToken
required
string
>= 1 characters
baseRevision
required
integer
latestKnownRevision
required
integer
status
required
string
Allowed values: open dirty stale recovered discarded committed closed
openedAt
required
string format: date-time
lastSeenAt
required
string format: date-time
dirtySince
required
string | null format: date-time
returnStateToken
required
string | null
>= 1 characters
key
additional properties
key
additional properties

401

Section titled “401”

Supabase bearer token is required

403

Section titled “403”

Actor cannot open reservation collaboration workspace

404

Section titled “404”

Reservation collaboration workspace not found

503

Section titled “503”

Reservation collaboration reader is unavailable