Portal

PropertiesCopy Anchor Link

ObjectCopy Anchor Link

{
  "$id": "https://api.sb/tutorloop.com/portals/portal_1",
  "$type": "Portal",
  "path": "/",
  "tools": [
    "keys"
  ]
}

RelationshipsCopy Anchor Link

• A Portal is included in one Site: a Site includes one Portal, the signed-in part where each Customer sees only their own records. includedIn, inverse includes.
• A Portal serves many Customers: Customers sign in to a Portal to order, track delivery, accept work, and pay. serves, inverse signsInto.

VerbsCopy Anchor Link

1. createCreates a Portal.
   POST /{namespace}/portalsdoPortal.created
2. getReturns one Portal by id.
   GET /{namespace}/portals/{id}readNo Event
3. listReturns Portals, newest first, one page at a time.
   GET /{namespace}/portalsreadNo Event
4. updateChanges the given properties of a Portal.
   PATCH /{namespace}/portals/{id}doPortal.updated
5. deleteDeletes a Portal; its history is kept.
   DELETE /{namespace}/portals/{id}doPortal.deleted

PermissionsCopy Anchor Link

Which Access level may call each Verb. One-way Verbs wait their delay window.

Call itCopy Anchor Link

Add a portal to QuietCopy.

ExampleCopy Anchor Link

A client of a bookkeeping service signs in at /portal, accepts last month's close, uploads two receipts, and pays the Invoice. She sees only her own records.