Skip to content

Service

A Service is a Product that warrants an outcome, delivered by Agents and Humans under an Outcome Contract.

Properties

PropertyTypeRequiredDescription
floorstringThe human floor: none, sign, or practice.
Inherited from Product: 3 properties
PropertyTypeRequiredDescription
namestringrequiredThe name of the Product.
promisetextrequiredWhat the Customer can rely on.
statusstringrequiredOne of draft, selling or retired, set by its Offers.

Object

JSON
{
  "$id": "https://api.sb/routewise.dev/services/service_1",
  "$type": "Service",
  "name": "RouteWise",
  "promise": "A route plan for 500 stops in under two seconds.",
  "status": "draft",
  "floor": "none"
}

Relationships

Verbs

  1. createCreates a Service.
    POST /{namespace}/servicesdoService.created
  2. getReturns one Service by id.
    GET /{namespace}/services/{id}readNo Event
  3. listReturns Services, newest first, one page at a time.
    GET /{namespace}/servicesreadNo Event
  4. updateChanges the given properties of a Service.
    PATCH /{namespace}/services/{id}doService.updated
  5. deleteDeletes a Service; its history is kept.
    DELETE /{namespace}/services/{id}doService.deleted

Permissions

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

Operationowneradminmemberviewer
Service.createYesYesYesNo
Service.getYesYesYesYes
Service.listYesYesYesYes
Service.updateYesYesYesNo
Service.deleteYesYesYesNo

Call it

Text
Add a service to LedgerLark.

Example

A bookkeeping Service warrants a reconciled month by the fifth working day. Agents do the matching, and a Human accountant reviews exceptions.