MDF REST API Resource Reference

Every resource on /api/3.0/mdf/{resource}/{id}, with the permission level it requires. For authentication, the gates, impersonation and error handling, start at MDF REST API.

Reading the Method column. The dispatcher accepts GET, POST, PUT and DELETE. Where a resource branches on the verb, the branches are listed. Where it shows any, the resource does not branch at dispatch and the handler decides - some return 405 for the wrong verb.

Reading the Permission column. This is the gate applied at the endpoint. Read means only the module read gate applies at that point; the resource may still enforce scope and authorization deeper, in the approval engine or the entity layer. Several Read-gated resources change state.

All Resources

Resource	Method	Permission	Purpose
`settings`	GET, else write	Admin	Read or save module settings
`sendtestnotification`	any	Manage	Send a test notification email
`enabled`	any	Admin	Enable or activate the module, returning the step report
`nudge`	any	Read	Nudge a partner about an ageing claim
`migrateactivitytype`	any	Admin	Migrate legacy activities onto current activity types
`dashboard`	any	Read	Partner dashboard: their four balance figures and open work
`myreports`	any	Read	Partner's own reports
`myrequests`	POST, else read	Read	Read or save the partner's own fund request
`myactivities`	DELETE, else write	Read	Save or delete an activity on the partner's request
`myclaims`	any	Read	Save the partner's own claim
`popmanifest`	any	Read	Required and optional proof items for an activity
`popupload`	DELETE, else write	Read	Upload or delete a proof-of-performance item
`popsubmit`	any	Read	Submit proof of performance for review
`poptemplate`	any	Read	Download a proof-of-performance template
`myprograms`	any	Read	Programs the partner has an allocation in
`newrequest`	any	Read	Scaffold a new partner request
`mysubmit`	any	Read	Submit the partner's request for approval
`myactivitytemplates`	any	Read	Templates available to the partner
`myactivitytypes`	any	Read	Activity types eligible for the partner
`newactivity`	any	Read	Scaffold a new activity
`activity`	any	Read	Load one activity
`newclaim`	any	Read	Scaffold a new claim
`claim`	any	Read	Load one claim
`approvals`	GET, else write	Admin	Read or save the approval chain
`activitytemplates`	GET / DELETE / else write	Manage	List, save or delete activity templates
`activitytemplatestatus`	any	Manage	Activate or deactivate a template
`activitytypes`	GET / DELETE / else write	Manage	List, save or delete activity types
`activitytypetemplates`	GET / DELETE / PUT / else upload	Manage	List, upload, link or delete templates on a type
`picklist`	any	Read	Picklist values for MDF fields
`programs`	any	Read	Fund programs and allocations
`programstatus`	any	Read	Change a program's status
`allocationstatus`	any	Read	Change an allocation's status
`partnerfilters`	any	Read	Partner filter options
`queue`	any	Read	The review queue, scoped to the caller
`review`	any	Read	Load one item for review
`reviewactivity`	any	Read	Decide an individual activity
`reviewcomments`	any	Read	Reviewer comments on an item
`approverfilter`	any	Read	Approver filter options
`submit`	any	Read	Submit a request on a partner's behalf
`decide`	any	Read	Decide one approval step
`bulkdecide`	any	Read	Decide several items at once
`claims`	any	Read	Claims list
`reimburse`	any	Admin	Issue a reimbursement
`claimsexport`	any	Read	Export claims
`claimaudit`	any	Read	Claim audit trail
`reimbursement`	any	Read	Reimbursement detail
`reversereimbursement`	any	Admin	Reverse a reimbursement
`claimdetail`	any	Read	Claim detail
`reviewpop`	GET, else write	Read	Read or set proof-item verification
`reports`	any	Read	Run a report
`reportdrill`	any	Read	Drill into a report figure
`partnertieroptions`	any	Read	Partner tier options
`reportsexport`	any	Read	Export a report
`attribution`	any	Read	Attributions on an activity
`attributionsearch`	any	Read	Search leads to attribute
`attributionbulkemail`	any	Read	Bulk-attribute leads by email address
`activitytypefilter`	any	Read	Activity type filter options

Grouped by Audience

Group	Resources
Module state and setup	`settingsenabledmigrateactivitytypesendtestnotification`
Partner-scoped	`dashboardmyprogramsmyrequestsmyactivitiesmyclaimsmyreportsmyactivitytypesmyactivitytemplatesnewrequestnewactivitynewclaimmysubmitactivityclaim`
Proof of performance	`popmanifestpopuploadpopsubmitpoptemplatereviewpop`
Review and approval	`queuereviewreviewactivityreviewcommentssubmitdecidebulkdecideapprovalsapproverfilter`
Claims and payment	`claimsclaimdetailclaimauditclaimsexportreimbursereimbursementreversereimbursementnudge`
Programs and allocations	`programsprogramstatusallocationstatuspartnerfilterspartnertieroptions`
Types and templates	`activitytypesactivitytypefilteractivitytypetemplatesactivitytemplatesactivitytemplatestatus`
Reports	`reportsreportdrillreportsexport`
Attribution	`attributionattributionsearchattributionbulkemail`
Reference data	`picklist`

Common Sequences

Submitting a request as a partner

myprograms - which programs the partner can request against.
newrequest - scaffold the request.
myactivitytypes and myactivitytemplates - what may be added.
newactivity, then myactivities to save each one.
myrequests to save the request, then mysubmit to submit it.

Working the queue

queue - items awaiting a decision, scoped to the caller.
review - load one item.
reviewactivity to decide individual activities, then decide for the step - or bulkdecide across several items.

Claim to payment

popmanifest - what evidence the activity requires.
popupload per item, then popsubmit.
reviewpop to verify or reject individual items.
claims and claimdetail to review, then reimburse (administrator).
reimbursement for the payment record; reversereimbursement to undo it.

Attribution

attributionsearch - find leads to attribute.
attribution for one at a time, or attributionbulkemail to attach many by email address.
reports and reportdrill to read the resulting pipeline figures.

See More

MDF REST API - authentication, gates, impersonation, errors
MDF Data Model

<< MDF REST API

Table of Contents