Deprecated
Use POST endpoints when creating something in the system.
All requests must use Limited API Auth.
POST requests require a body containing content for the new item.
Routes are for the url: https://pb.tansy.app
Note: if a body field isn’t marked required, you can omit it and the default value will be used.
Current endpoints
task
POST /api/v1/records/tasks
Creates a new task
Body:
{
title: "", // string, required
details: "", // string
memberID: "", // string, required
counselorID: "", // string
completed: false, // boolean
seen: false, // boolean
hidden: true, // boolean
status: "Not Started" // select (string options: "Not Started", "In Progress", "Blocked", "Done", "Canceled")
}
message
POST /api/v1/records/messages
Creates a new task
Body:
{
message: "", // string, required
memberID: "", // string, required
senderID: "", // string, default: null
role: "" // string, default: "bot"
}
appointment
POST /api/v1/records/appointments
Creates a new appointment
Body:
{
memberID: "", // string, required
counselorID: "", // string
title: "", // string, required
startTime: "", // Datetime, required (format: "YYYY-MM-DD HH:MM:SS")
timezone: "", // string, required (format: "America/Detroit" - full list: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones)
details: "", // string
private: false, // boolean
status: "pending", // select (string options: "pending", "booked", "completed", "canceled", "suggested", "open", "missed")
address: { // object (address is optional)
streetAddress: "", // string
streetAddressLine2: "", // string
city: "", // string
state: "", // string
zipcode: "" // string
}
}