Skip to content
StartupBuilder
by startups.studio
by Startups.Studio
Code
Changelog
APIGrowthRegistration

Registration routes: admit, approve, attend

The Registration Verbs admit, approve, attend as api.sb routes, with inputs, result, refusals and an example.

Reference for Registration, one group of Registration routes.

Registration.admit

Admit gives the next Contact in line a place at a Gathering when one frees up or its capacity rises. Verb page.

Text
POST /{namespace}/registrations/{registration}/admit

Path: registration. Emits Registration.admitted.

Inputs

InputTypeRequiredDescription
registrationRegistrationrequiredThe waitlisted Registration.

Returns

OutputTypeRequiredDescription
registrationRegistrationrequiredThe Registration, now registered.

Refuses when

CheckErrorFixThen call
The key is valid, but its scopes do not allow this operation.forbiddenUse a key whose scopes cover the operation, or ask an owner of the namespace to grant them.None.
The Gathering is at capacityrefusedClear what the check names, then call it again.None.

Example

Terminal
curl -X POST https://api.sb/leaseline.app/registrations/registration_95lvb7R17L/admit \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"
JSON
{
  "api": "https://api.sb/leaseline.app",
  "registration": {
    "$id": "https://api.sb/leaseline.app/registrations/registration_95lvb7R17L",
    "$type": "Registration",
    "status": "invited"
  },
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/act_br07HsG8MG",
    "operation": "Registration.admit",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}

Registration.approve

Approve gives a requested place at a Gathering to the Contact who asked, or a place in line when the Gathering is full. Verb page.

Text
POST /{namespace}/registrations/{registration}/approve

Path: registration. Emits Registration.approved.

Inputs

InputTypeRequiredDescription
registrationRegistrationrequiredThe requested Registration.

Returns

OutputTypeRequiredDescription
registrationRegistrationrequiredThe Registration, registered or waitlisted.

Refuses when

CheckErrorFixThen call
The key is valid, but its scopes do not allow this operation.forbiddenUse a key whose scopes cover the operation, or ask an owner of the namespace to grant them.None.

Example

Terminal
curl -X POST https://api.sb/leaseline.app/registrations/registration_95lvb7R17L/approve \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"
JSON
{
  "api": "https://api.sb/leaseline.app",
  "registration": {
    "$id": "https://api.sb/leaseline.app/registrations/registration_95lvb7R17L",
    "$type": "Registration",
    "status": "invited"
  },
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/act_br07HsG8MG",
    "operation": "Registration.approve",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}

Registration.attend

Attend records that a registered Contact joined the Gathering; an online room calls it on join. Verb page.

Text
POST /{namespace}/registrations/{registration}/attend

Path: registration. Emits Registration.attended.

Inputs

InputTypeRequiredDescription
registrationRegistrationrequiredThe Registration of the Contact who joined.

Returns

OutputTypeRequiredDescription
registrationRegistrationrequiredThe Registration, now attended.

Refuses when

CheckErrorFixThen call
The key is valid, but its scopes do not allow this operation.forbiddenUse a key whose scopes cover the operation, or ask an owner of the namespace to grant them.None.

Example

Terminal
curl -X POST https://api.sb/leaseline.app/registrations/registration_95lvb7R17L/attend \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"
JSON
{
  "api": "https://api.sb/leaseline.app",
  "registration": {
    "$id": "https://api.sb/leaseline.app/registrations/registration_95lvb7R17L",
    "$type": "Registration",
    "status": "attended"
  },
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/act_br07HsG8MG",
    "operation": "Registration.attend",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}

update, delete

Previous

Review

Next