How do I add Assistance records to a case?

Demographic records are considered Detail records internally in the Charity Tracker / Oasis Insight application. To add a demographic record, simply add the relevant Detail record.

See the above section on “How do I add details to a case?” for more information.

How do I add Assistance records to a case?

Adding an Assistance record is similar to adding a Detail record. You will need to query the /api/v1/categories/ and /api/v1/units/ endpoints to get a list of Assistance categories (“Financial Planning”, “Counseling”, etc.) and the Assistance units (”Boxes”, “Cans”, “Dollars”, etc) that are used to denote how much Assistance was rendered.

Along with this, you will need the ID of the Agent adding the Assistance record. You can fetch this from the /api/v1/agents/ endpoint.

Click here for the Swagger documentation for the Agent endpoint along with query parameters you can use to help filter results down with!

Once you have all the relevant IDs, you can make a POST request to the /api/v1/assistances/ endpoint:

{
    "case": 1001, 
    "amount": 20, 
    "unit": 1, 
    "category": 1,
    "entry_agent":1,
    "mod_agent":1
}

Note: Both entry_agent and mod_agent IDs are necessary for the submission, but you can set the IDs to any agent ID that fits your use case. Just be aware that there is no special denotation to say “This value came from an API request”, so it should be treated as though it were being entered by that Agent themselves.