Skip to content

Recipient (Purpose) ​

sfc.recipient · every change is kept in the audit log

Fields ​

Every record also has id, created_at and updated_at.

FieldLabelTypeRules
applicationapplicationlink → sfc.applicationrequired
studentstudentlink → core.studentrequired
entered_byentered bylink → core.user
purposepurposelink → sfc.purpose
purpose_namepurpose nametext
typetypetext
namenametext
emailemailemailpersonal data
reference_noreference notext
university_nameuniversity nametext
countrycountrytext
contact_personcontact persontextpersonal data
contact_phonecontact phonephonepersonal data
addressaddresslongtextpersonal data
wes_emailwes emailemailpersonal data
wes_surnamewes surnametextpersonal data
wes_reference_nowes reference notext
delivery_typedelivery typeselectone of: Digital, Courier, Pickup
copiescopiesnumbermin 0
verification_typeverification typetext
verifiedverifiedcheckdefault false
errataerratacheckdefault false
extra_fieldsextra fieldsjson

Permissions ​

RoleCan
sfc:adminread, create, update, delete
sfc:verifierread, update
sfc:signatoryread
sfc:printerread
sfc:dispatcherread
sfc:studentread, create, update — only own rows (via student)
sfc:agentread, create, update — only own rows (via entered_by)

API ​

http
GET    /api/sfc/recipient?<field>=<value>&limit=100&offset=0
POST   /api/sfc/recipient
GET    /api/sfc/recipient/:id
PATCH  /api/sfc/recipient/:id
DELETE /api/sfc/recipient/:id

Edulab Bench developer documentation