Skip to content
Sanmopia Modernization

Get the current result of one authenticated HQ branch onboarding command

Switch to Zen Mode
GET
/admin/branch-onboarding-commands/{commandId}/current-result
curl --request GET \
  --url https://example.com/admin/branch-onboarding-commands/example/current-result \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
commandId
required
string
>= 1 characters <= 200 characters /.*\S.*/

Responses

Section titled “Responses”

200

Section titled “200”

Current durable result, including any post-acceptance repair progress

Media typeapplication/json
object
commandId
required
string
>= 1 characters <= 200 characters /\S/
actorId
required
string
>= 1 characters /\S/
reason
required
string
>= 1 characters <= 500 characters /\S/
commandFingerprint
required
string
/^[a-f0-9]{64}$/
branchId
required
string
>= 1 characters /\S/
branchCode
required
string
/^[A-Za-z0-9][A-Za-z0-9_-]{0,31}$/
revision
required
Allowed value: 1
organizationRevision
required
integer
>= 1
lifecycleStatus
required
Allowed value: onboarding
operatorIdentityId
required
One of:
string
>= 1 characters /\S/
operatorIdentityDisposition
required
One of:
string
Allowed values: created attached
managerMembershipId
required
One of:
string
>= 1 characters /\S/
managerMembershipStatus
required
One of:
string
Allowed values: invited active
managerInvitationStatus
required
string
Allowed values: pending sent accepted retrying
authorizationRelationshipStatus
required
string
Allowed values: pending active retrying
authorizationRelationships
required
membershipFeePolicyId
required
One of:
string
>= 1 characters /\S/
membershipFeePolicyRevision
required
One of:
Allowed value: 1
membershipFeePolicyStatus
required
string
Allowed values: pending published retrying
sideEffects
required
auditEventId
required
string
>= 1 characters /\S/
outcomeStatus
required
string
Allowed values: completed repair_pending
idempotentReplay
required
boolean
repair
required
One of:
object
repairId
required
string
>= 1 characters /\S/
nextRetryAt
required
One of:
string format: date-time
/^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-5][0-9]\.[0-9]{3}Z$/
key
additional properties
allowedNextActions
required
Array<string>
>= 1 items unique items
Allowed values: complete_branch_profile configure_service_area resend_manager_invitation inspect_onboarding_repair
One of:
object
operatorIdentityId
string
>= 1 characters
operatorIdentityDisposition
Allowed values: created attached
sideEffects
array
One of:
object
managerMembershipId
string
>= 1 characters
managerMembershipStatus
Allowed values: invited active
sideEffects
array
One of:
object
managerInvitationStatus
Allowed value: sent
allowedNextActions
array
>= 3 items <= 3 items
sideEffects
array
One of:
object
authorizationRelationshipStatus
Allowed value: active
sideEffects
array
One of:
object
membershipFeePolicyId
string
>= 1 characters
membershipFeePolicyRevision
Allowed value: 1
membershipFeePolicyStatus
Allowed value: published
sideEffects
array
idempotentReplay
required

401

Section titled “401”

Bearer access token is required

Media typeapplication/json
BranchOnboardingProblem
object
status
required
integer
Allowed values: 401 403 409 422 503
code
required
string
Allowed values: authentication_required branch_create_forbidden validation_failed business_identity_conflict manager_invitation_conflict stale_organization_revision idempotency_payload_mismatch onboarding_dependency_unavailable
message
required
string
>= 1 characters
fieldErrors
required
Array<object>
object
fieldPath
required
string
>= 1 characters
code
required
string
>= 1 characters
message
required
string
>= 1 characters
key
additional properties
currentOrganizationRevision
required
One of:
integer
conflictingFieldPaths
required
Array<string>
unique items
retryable
required
boolean
key
additional properties

403

Section titled “403”

Actor is not an authenticated HQ administrator

Media typeapplication/json
BranchOnboardingProblem
object
status
required
integer
Allowed values: 401 403 409 422 503
code
required
string
Allowed values: authentication_required branch_create_forbidden validation_failed business_identity_conflict manager_invitation_conflict stale_organization_revision idempotency_payload_mismatch onboarding_dependency_unavailable
message
required
string
>= 1 characters
fieldErrors
required
Array<object>
object
fieldPath
required
string
>= 1 characters
code
required
string
>= 1 characters
message
required
string
>= 1 characters
key
additional properties
currentOrganizationRevision
required
One of:
integer
conflictingFieldPaths
required
Array<string>
unique items
retryable
required
boolean
key
additional properties

404

Section titled “404”

No accepted current result exists in the authenticated actor and HQ scope

422

Section titled “422”

Command identifier is invalid

Media typeapplication/json
BranchOnboardingProblem
object
status
required
integer
Allowed values: 401 403 409 422 503
code
required
string
Allowed values: authentication_required branch_create_forbidden validation_failed business_identity_conflict manager_invitation_conflict stale_organization_revision idempotency_payload_mismatch onboarding_dependency_unavailable
message
required
string
>= 1 characters
fieldErrors
required
Array<object>
object
fieldPath
required
string
>= 1 characters
code
required
string
>= 1 characters
message
required
string
>= 1 characters
key
additional properties
currentOrganizationRevision
required
One of:
integer
conflictingFieldPaths
required
Array<string>
unique items
retryable
required
boolean
key
additional properties

503

Section titled “503”

Durable onboarding result authority is unavailable or invalid

Media typeapplication/json
BranchOnboardingProblem
object
status
required
integer
Allowed values: 401 403 409 422 503
code
required
string
Allowed values: authentication_required branch_create_forbidden validation_failed business_identity_conflict manager_invitation_conflict stale_organization_revision idempotency_payload_mismatch onboarding_dependency_unavailable
message
required
string
>= 1 characters
fieldErrors
required
Array<object>
object
fieldPath
required
string
>= 1 characters
code
required
string
>= 1 characters
message
required
string
>= 1 characters
key
additional properties
currentOrganizationRevision
required
One of:
integer
conflictingFieldPaths
required
Array<string>
unique items
retryable
required
boolean
key
additional properties