{"openapi":"3.0.3","info":{"title":"API | Church Community Builder","description":"## Overview\n\nWe use OAuth 2.0 to secure our endpoints so you will need to talk with Church Community Builder to get an application created.\n\nFor more information about becoming a value added partner fill out this [form](https://vendor.ccbchurch.com/goto/forms/12/responses/new).\n\n### API Base URL\n\nAll api calls must be made against `https://api.ccbchurch.com` and *not* `https://[subdomain].ccbchurch.com`.\n\n### Authentication\n\nThe authentication mechanism offered to Vendors and Churches to authorize the use of a given church's data is the three-legged OAuth flow. We offer two different auth types to authorize the church (System Auth) or authorize an individual in the church (Identity Auth).\n\n#### System Auth\n\nThis will be the first step to gain access to a church's data. The Master Administrator or a person with the ability to Edit System Wide Settings for a church can authorize a vendor to use their data. Without this authorization the vendor will not be able to access the church's data.\n\n* Authorization URL: https://oauth.ccbchurch.com/oauth/authorize\n* Token URL: https://api.ccbchurch.com/oauth/token (Make sure to provide the Accept header set to application/vnd.ccbchurch.v2+json)\n* Query String Parameters\n  * subdomain\n    * Optional\n    * If provided will bypass the church's subdomain step in the flow\n  * client_id\n    * Required\n    * OAuth Client Id provided by Church Community Builder, Inc\n  * response_type\n    * Required\n    * Will always equal `code`\n  * state\n    * Optional\n    * Unique identifier to protect against CSRF\n  * scope\n    * Optional\n    * This is what data your application can access\n    * A subset of requested scopes when you setup your OAuth Application with Church Community Builder\n    * By default if you do not provide this parameter it will default to the scopes you requested\n  * redirect_uri\n    * Required\n    * Must match the domain provided to Church Community Builder when the OAuth Application was created\n\n##### Steps to get an Access Token\n\n* Redirect to the Authorization URL with the required parameters\n* Master Administrator or Edit System Wide Settings will\n  * Provide the subdomain if not provided in the original redirect\n  * Login to their Church Community Builder site if not already logged in\n  * Review the list of requested scopes and authorize the vendor to use them on their site\n* Church Community Builder will redirect to the redirect_uri parameter provided when the OAuth application was created\n* Post to the Token URL with `grant_type=authorization_code` and `code` equal to the returned code from the previous step\n* This will return the access token model provided in the model section\n* Subsequent requests to the API are capable by providing the Authorization header with the Access Token as the Bearer token\n\n#### Identity Auth\n\nThis auth flow is similar to the System Auth flow without the need for the authorization step. In order to use this Auth Flow the church administration will need to authorize the vendor using the System Auth Flow first.\n\nThis is to perform API requests on behalf of the individual authenticated through this flow. Any permissions the authenticated individual has will be taken into account when API calls are made. This will allow you to add a login with Church Community Builder link within your application.\n\n* Authorization URL: https://oauth.ccbchurch.com/oauth/authorize\n* Token URL: https://api.ccbchurch.com/oauth/token\n* Query String Parameters\n  * Same as System Auth Flow\n  * resource_owner_auth\n    * boolean\n    * If provided will perform the Identity Auth instead of the System Auth flow\n","termsOfService":"https://www.churchcommunitybuilder.com/terms-of-service/","contact":{"name":"Church Community Builder","url":"https://www.churchcommunitybuilder.com/","email":"api@churchcommunitybuilder.com"},"version":"v2"},"servers":[{"url":"https://api.ccbchurch.com"}],"security":[{"BearerTokenHeader":[]}],"tags":[{"name":"authentication","description":"Actions associated with authentication"},{"name":"campuses","description":"Actions associated with campuses"},{"name":"church","description":"Actions associated with the current church"},{"name":"departments","description":"Actions associated with the departments"},{"name":"events","description":"Actions associated with events"},{"name":"families","description":"Actions associated with families"},{"name":"files","description":"Actions associated to files"},{"name":"forms","description":"Actions associated with forms"},{"name":"groups","description":"Actions associated with groups"},{"name":"individuals","description":"Actions associated with individuals"},{"name":"metrics","description":"Actions associated with metrics"},{"name":"session","description":"Actions associated with the current identity"},{"name":"process queues","description":"Actions associated with the process queues"},{"name":"workflows","description":"Actions associated with workflows"},{"name":"resources","description":"Actions associated with rooms and resources"},{"name":"scheduling","description":"Actions associated with scheduling"},{"name":"search","description":"Actions associated with advanced search"},{"name":"saved searches","description":"Actions associated with saved advanced search"},{"name":"needs","description":"Actions associated with needs"},{"name":"settings","description":"Actions associated with settings"}],"paths":{"/oauth/token":{"post":{"tags":["authentication"],"summary":"Get oauth access token","security":[],"operationId":"getAccessToken","requestBody":{"content":{"application/json":{"schema":{"required":["client_id","client_secret","grant_type","subdomain"],"properties":{"grant_type":{"type":"string","description":"oAuth Grant Type","enum":["authorization_code","refresh_token"]},"subdomain":{"type":"string","description":"Church subdomain"},"client_id":{"type":"string","description":"OAuth client id"},"client_secret":{"type":"string","description":"OAuth client secret"},"code":{"type":"string","description":"Required for authorization_code grant type"},"redirect_uri":{"type":"string","description":"Required for authorization_code grant type if provided during authorization.  Must EXACTLY match the redirect used during the authorization code flow, including the protocol.","example":"https://localhost:8000/redirect/url"},"refresh_token":{"type":"string","description":"Required for refresh_token grant type.  Do not pass in for authorization_code flow."}}},"examples":{"authorization_code":{"value":{"grant_type":"authorization_code","subdomain":"{subdomain}","client_id":"{your client id}","client_secret":"{your client secret}","code":"{code parameter from redirect}","redirect_uri":"{your redirect uri}"}},"refresh_token":{"value":{"grant_type":"refresh_token","subdomain":"{subdomain}","client_id":"{your client id}","client_secret":"{your client secret}","refresh_token":"{refresh token}"}}}}},"required":true},"responses":{"200":{"description":"Get Access Token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessTokenSerializer"},"example":{"access_token":"{access token}","token_type":"bearer","expires_in":7200,"scope":"{scopes}","refresh_token":"{refresh token}"}}}}}}},"/campuses":{"get":{"tags":["campuses"],"summary":"Get campus list","security":[{"oauth2":["read:campuses"]}],"operationId":"getCampuses","parameters":[{"name":"location","in":"query","description":"Current location coordinates","style":"deepObject","explode":true,"schema":{"type":"object","properties":{"latitude":{"type":"number","format":"float","description":"Current location latitude"},"longitude":{"type":"number","format":"float","description":"Current location longitude"}}},"example":{"latitude":37.7749,"longitude":-122.4194}},{"$ref":"#/components/parameters/UsedByGroupsFilter"}],"responses":{"200":{"description":"Church Campus Information","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BasicCampusSerializer"}}}}},"401":{"$ref":"#/components/responses/NotAuthenticated"},"403":{"$ref":"#/components/responses/NotAuthorized"},"412":{"$ref":"#/components/responses/NotValid"}}},"put":{"tags":["campuses"],"summary":"Update campus information","security":[{"oauth2":["write:campuses"]}],"operationId":"updateCampus","requestBody":{"description":"The campus to edit","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCampusRequestSerializer"}}},"required":false},"responses":{"200":{"description":"Campus Information","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BasicCampusSerializer"}}}},"401":{"$ref":"#/components/responses/NotAuthenticated"},"403":{"$ref":"#/components/responses/NotAuthorized"},"412":{"$ref":"#/components/responses/NotValid"}},"x-codegen-request-body-name":"campus"}},"/campuses/{id}/service_times":{"get":{"tags":["church"],"summary":"Get campus service times","security":[{"oauth2":["read:service_times"]}],"operationId":"getCampusServiceTimes","parameters":[{"name":"id","in":"path","description":"The campus id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"List of Campus Service Times","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CampusServiceSerializer"}}}}}}}},"/campuses/{id}/leadership_roles":{"get":{"tags":["church"],"summary":"Get campus leadership roles","security":[{"oauth2":["read:leadership_roles"]}],"operationId":"getLeadershipRoles","parameters":[{"name":"id","in":"path","description":"The campus id","required":true,"schema":{"type":"integer"}},{"name":"status","in":"query","description":"Status of the leadership role. If this param is not provided, both will be included.","schema":{"type":"string","enum":["ENABLED","DISABLED"]}},{"name":"assignment","in":"query","description":"Include leadership roles that are assigned or unassigned to individuals. If this param is not provided, both will be included.","schema":{"type":"string","enum":["ASSIGNED","UNASSIGNED"]}}],"responses":{"200":{"description":"List of Campus Leadership Roles","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BasicLeadershipRoleSerializer"}}}}}}}},"/individuals/{individual_id}/favorite_campuses/{campus_id}":{"post":{"tags":["church","individuals","campuses"],"summary":"Mark a campus as a favorite for an individual. Must be the currently logged in user.","security":[{"oauth2":["write:individuals"]}],"operationId":"addIndividualFavoriteCampus","parameters":[{"name":"individual_id","in":"path","description":"The current user's individual id","required":true,"schema":{"type":"integer"}},{"name":"campus_id","in":"path","description":"The campus id to mark as favorite","required":true,"schema":{"type":"integer"}}],"responses":{"201":{"description":"The individual favorite campus","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IndividualFavoriteCampusSerializer"}}}}}},"delete":{"tags":["church","individuals","campuses"],"summary":"Remove a favorite campus from an individual. Must be the currently logged in user.","security":[{"oauth2":["write:individuals"]}],"operationId":"removeIndividualFavoriteCampus","parameters":[{"name":"individual_id","in":"path","description":"The current user's individual id","required":true,"schema":{"type":"integer"}},{"name":"campus_id","in":"path","description":"The campus id to remove from favorites","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Empty response","content":{}}}}},"/church":{"get":{"tags":["church"],"summary":"Get current church information","security":[{"oauth2":["read:church"]}],"operationId":"getChurch","responses":{"200":{"description":"Church Information","content":{"*/*":{"schema":{"$ref":"#/components/schemas/BasicChurchSerializer"}}}}}}},"/church/areas_of_town":{"get":{"tags":["church"],"summary":"Get schools","security":[{"oauth2":["read:church"]}],"operationId":"getAreasOfTown","parameters":[{"$ref":"#/components/parameters/PerPage"},{"$ref":"#/components/parameters/Page"}],"responses":{"200":{"description":"List of Areas of Town","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/IdName"}}}}}}}},"/church/schools":{"get":{"tags":["church"],"summary":"Get schools","security":[{"oauth2":["read:church"]}],"operationId":"getSchools","responses":{"200":{"description":"List of Schools","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/IdName"}}}}}}}},"/church/school_grades":{"get":{"tags":["church"],"summary":"Get school grades","security":[{"oauth2":["read:church"]}],"operationId":"getSchoolGrades","responses":{"200":{"description":"List of School Grades","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/IdName"}}}}}}}},"/church/attendance_groupings":{"get":{"tags":["church"],"summary":"Get attendance groupings","security":[{"oauth2":["read:attendance_groupings"]}],"operationId":"getAttendanceGroupings","responses":{"200":{"description":"List of Attendance Groupings","headers":{"X-Offset":{"$ref":"#/components/headers/X-Offset"},"X-Per-Page":{"$ref":"#/components/headers/X-Per-Page"},"X-Total-Pages":{"$ref":"#/components/headers/X-Total-Pages"},"X-Page":{"$ref":"#/components/headers/X-Page"}},"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/IdName"}}}}}}}},"/church/social_networks":{"get":{"tags":["church"],"summary":"Get social networks","security":[{"oauth2":["read:church"]}],"operationId":"getSocialNetworks","responses":{"200":{"description":"List of Social Networks","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BasicSocialNetworkSerializer"}}}}}}}},"/church/mobile_carriers":{"get":{"tags":["church"],"summary":"Get mobile carriers","security":[{"oauth2":["read:church"]}],"operationId":"getMobileCarriers","responses":{"200":{"description":"List of Mobile Carriers","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BasicMobileCarrierSerializer"}}}}}}}},"/church/countries":{"get":{"tags":["church"],"summary":"Get countries","security":[{"oauth2":["read:church"]}],"operationId":"getCountries","responses":{"200":{"description":"List of Countries","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BasicCountrySerializer"}}}}}}}},"/church/membership_types":{"get":{"tags":["church"],"summary":"Get membership types","security":[{"oauth2":["read:church"]}],"operationId":"getMembershipTypes","responses":{"200":{"description":"List of Membership Types","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/IdName"}}}}}}}},"/church/services":{"get":{"tags":["church"],"summary":"Get services","security":[{"oauth2":["read:church"]}],"operationId":"getServices","responses":{"200":{"description":"List of Services","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/IdName"}}}}}}}},"/church/custom_fields":{"get":{"tags":["church"],"summary":"Get custom fields","security":[{"oauth2":["read:custom_fields"]}],"operationId":"getCustomFields","responses":{"200":{"description":"List of Custom Fields","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BasicCustomFieldSerializer"}}}}},"401":{"$ref":"#/components/responses/NotAuthenticated"},"403":{"$ref":"#/components/responses/NotAuthorized"}}}},"/church/reasons_left":{"get":{"tags":["church"],"summary":"Get reasons left options","security":[{"oauth2":["read:church"]}],"operationId":"getReasonsLeft","responses":{"200":{"description":"List of reasons left options","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/IdName"}}}}}}}},"/church/envelope_user_options":{"get":{"tags":["church"],"summary":"Get envelope user options","security":[{"oauth2":["read:church"]}],"operationId":"getEnvelopeUserOptions","responses":{"200":{"description":"List of Envelope User Options","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/IdName"}}}}}}}},"/church/religions":{"get":{"tags":["church"],"summary":"Get religion options","security":[{"oauth2":["read:church"]}],"operationId":"getReligions","responses":{"200":{"description":"List of Religion options","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/IdName"}}}}}}}},"/church/preferred_languages":{"get":{"tags":["church"],"summary":"Get preferred language options","security":[{"oauth2":["read:church"]}],"operationId":"getPreferredLanguages","responses":{"200":{"description":"List of Preferred Language Options","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/IdName"}}}}}}}},"/church/ethnicities":{"get":{"tags":["church"],"summary":"Get ethinicity options","security":[{"oauth2":["read:church"]}],"operationId":"getEthnicities","responses":{"200":{"description":"List of Ethnicity Options","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/IdName"}}}}}}}},"/church/homebound_ministries":{"get":{"tags":["church"],"summary":"Get homebound ministry options","security":[{"oauth2":["read:church"]}],"operationId":"getHomeboundMinistryOptions","responses":{"200":{"description":"List of Homebound Ministry Options","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/IdName"}}}}}}}},"/church/privacy_defaults":{"get":{"tags":["church"],"summary":"Get privacy defaults","security":[{"oauth2":["read:privacy_defaults"]}],"operationId":"getPrivacyDefaults","responses":{"200":{"description":"Privacy defaults","content":{"*/*":{"schema":{"$ref":"#/components/schemas/PrivacyDefaultsSerializer"}}}}}},"post":{"tags":["church"],"summary":"Update privacy defaults","security":[{"oauth2":["write:privacy_defaults"]}],"operationId":"updatePrivacyDefaults","requestBody":{"description":"The privacy defaults","content":{"*/*":{"schema":{"type":"object","properties":{"default_admin_created_profile":{"type":"string","enum":["LIMITED","BASIC"]},"default_approved_profile":{"type":"string","enum":["LIMITED","BASIC"]},"default_congregant_created_profile":{"type":"string","enum":["PENDING","LIMITED","BASIC"]},"default_listed":{"type":"boolean"},"default_address_privacy_level":{"type":"string","enum":["LEADERSHIP_ONLY","GROUP_MEMBERS","EVERYONE"]},"default_anniversary_privacy_level":{"type":"string","enum":["LEADERSHIP_ONLY","GROUP_MEMBERS","EVERYONE"]},"default_birthday_privacy_level":{"type":"string","enum":["LEADERSHIP_ONLY","GROUP_MEMBERS","EVERYONE"]},"default_email_privacy_level":{"type":"string","enum":["LEADERSHIP_ONLY","GROUP_MEMBERS","EVERYONE"]},"default_phone_privacy_level":{"type":"string","enum":["LEADERSHIP_ONLY","GROUP_MEMBERS","EVERYONE"]}}}}},"required":false},"responses":{"200":{"description":"Update privacy defaults","content":{"*/*":{"schema":{"$ref":"#/components/schemas/PrivacyDefaultsSerializer"}}}}},"x-codegen-request-body-name":"privacy_defaults"}},"/data_import/individuals":{"post":{"tags":["files"],"summary":"Upload a CSV file for import with the following columns of data as families of individuals.  Expected columns - First Name, Last Name, Email, Phone, Address.  Address must be formatted as - street, city, state abbreviation, zip code","security":[{"oauth2":["write:individuals"]}],"operationId":"importIndividuals","requestBody":{"content":{"multipart/form-data":{"schema":{"required":["file"],"properties":{"file":{"type":"string","description":"File to upload","format":"binary"}}}}},"required":true},"responses":{"201":{"description":"Returns a import serializer","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImportSerializer"}}}},"400":{"$ref":"#/components/responses/NotValid"}}}},"/data_import/sacraments":{"post":{"tags":["files"],"summary":"Upload a CSV file for importing sacraments for an individual. Expected columns - individual id, Name, sacrament data columns...","security":[{"oauth2":["write:individuals"]}],"operationId":"importSacraments","requestBody":{"content":{"multipart/form-data":{"schema":{"required":["file"],"properties":{"file":{"type":"string","description":"File to upload","format":"binary"}}}}},"required":true},"responses":{"201":{"description":"Returns a import serializer","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImportSerializer"}}}},"400":{"$ref":"#/components/responses/NotValid"}}}},"/departments":{"get":{"tags":["departments"],"summary":"Get Departments","security":[{"oauth2":["read:departments"]}],"operationId":"getDepartments","parameters":[{"$ref":"#/components/parameters/PerPage"},{"$ref":"#/components/parameters/Page"},{"$ref":"#/components/parameters/UsedByGroupsFilter"}],"responses":{"200":{"description":"List of Departments","headers":{"X-Offset":{"$ref":"#/components/headers/X-Offset"},"X-Per-Page":{"$ref":"#/components/headers/X-Per-Page"},"X-Total-Pages":{"$ref":"#/components/headers/X-Total-Pages"},"X-Page":{"$ref":"#/components/headers/X-Page"}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BasicDepartmentSerializer"}}}}}}}},"/individuals/{id}/departments":{"get":{"tags":["departments"],"summary":"Get the departments the individual is a department admin of","security":[{"oauth2":["read:individual_departments"]}],"operationId":"getIndividualsDepartments","parameters":[{"name":"id","in":"path","description":"The individual's id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"List of Individuals Departments","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/IndividualsDepartmentSerializer"}}}}},"401":{"$ref":"#/components/responses/NotAuthenticated"},"403":{"$ref":"#/components/responses/NotAuthorized"},"404":{"$ref":"#/components/responses/NotFound"}}}},"/events":{"get":{"tags":["events"],"summary":"Get event list","security":[{"oauth2":["read:events"]}],"operationId":"getEvents","parameters":[{"$ref":"#/components/parameters/PerPage"},{"$ref":"#/components/parameters/Page"},{"name":"name","in":"query","schema":{"type":"string"}},{"name":"range_type","in":"query","schema":{"$ref":"#/components/schemas/EventRangeTypeFilter"}}],"responses":{"200":{"description":"Get event list","headers":{"X-Offset":{"$ref":"#/components/headers/X-Offset"},"X-Per-Page":{"$ref":"#/components/headers/X-Per-Page"},"X-Total-Pages":{"$ref":"#/components/headers/X-Total-Pages"},"X-Page":{"$ref":"#/components/headers/X-Page"}},"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BasicEventOccurrenceSerializer"}}}}},"401":{"$ref":"#/components/responses/NotAuthenticated"},"403":{"$ref":"#/components/responses/NotAuthorized"},"404":{"$ref":"#/components/responses/NotFound"}}},"post":{"tags":["events"],"summary":"Create event","security":[{"oauth2":["write:events"]}],"operationId":"createEvent","requestBody":{"description":"The Event to create","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventCreateUpdate"}}},"required":false},"responses":{"201":{"description":"Returns the full serializer of the Event","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FullEventSerializer"}}}},"400":{"description":"Event unable to to be created due to missing parameters or another issue","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventUnableToCreate"}}}},"401":{"$ref":"#/components/responses/NotAuthenticated"},"403":{"$ref":"#/components/responses/NotAuthorized"},"404":{"$ref":"#/components/responses/NotFound"}},"x-codegen-request-body-name":"createEvent"}},"/events/{id}":{"get":{"tags":["events"],"summary":"Get event information","security":[{"oauth2":["read:events"]}],"operationId":"getEvent","parameters":[{"name":"id","in":"path","description":"The event's id","required":true,"schema":{"type":"integer"}},{"name":"occurrence","in":"query","description":"The date of the occurance, for example \"20201101\"","schema":{"pattern":"/\\d{8}/gm","type":"string"}},{"name":"attendance_info","in":"query","description":"Adds a \"attendance\" object with basic attendance info for the event","schema":{"type":"boolean"}}],"responses":{"200":{"description":"The event details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/FullEventSerializer"}}}},"401":{"$ref":"#/components/responses/NotAuthenticated"},"403":{"$ref":"#/components/responses/NotAuthorized"},"404":{"$ref":"#/components/responses/NotFound"}}},"put":{"tags":["events"],"summary":"Update event","security":[{"oauth2":["write:events"]}],"operationId":"updateEvent","parameters":[{"name":"id","in":"path","description":"The event's id","required":true,"schema":{"type":"integer"}}],"requestBody":{"description":"The Event to update","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventCreateUpdate"}}},"required":false},"responses":{"200":{"description":"Returns the full serializer of the Event","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FullEventSerializer"}}}},"400":{"description":"Event unable to update due to a conflict or issue","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventUnableToUpdate"}}}},"401":{"$ref":"#/components/responses/NotAuthenticated"},"403":{"$ref":"#/components/responses/NotAuthorized"},"404":{"$ref":"#/components/responses/NotFound"}},"x-codegen-request-body-name":"updateEvent"},"delete":{"tags":["events"],"summary":"Delete event","security":[{"oauth2":["write:events"]}],"operationId":"deleteEvent","parameters":[{"name":"id","in":"path","description":"The event's id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Empty response","content":{}}}}},"/events/{id}/invitation_settings":{"put":{"tags":["events"],"summary":"Get event information","security":[{"oauth2":["write:events"]}],"operationId":"updateEventInvitationSettings","parameters":[{"name":"id","in":"path","description":"The event's id","required":true,"schema":{"type":"integer"}}],"requestBody":{"description":"The new event invitation settings","content":{"application/json":{"schema":{"type":"object","properties":{"show_guest_list":{"type":"boolean"},"allow_additional_guests":{"type":"boolean"},"notify_owner_of_status_changes":{"type":"boolean"},"attend_max_quantity":{"type":"integer"}}}}},"required":false},"responses":{"200":{"description":"The event details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FullEventSerializer"}}}}},"x-codegen-request-body-name":"UpdateEventInvitationSettings"}},"/events/{id}/photo":{"post":{"tags":["events"],"summary":"Update the event photo","security":[{"oauth2":["write:events"]}],"operationId":"updateEventPhoto","parameters":[{"name":"id","in":"path","description":"The event's id","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"required":["uploaded_file"],"properties":{"uploaded_file":{"type":"string","description":"Event Photo (will crop to a square image)","format":"binary"}}}}},"required":true},"responses":{"200":{"description":"The event details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FullEventSerializer"}}}}}},"delete":{"tags":["events"],"summary":"Remove the event photo","security":[{"oauth2":["write:events"]}],"operationId":"deleteEventPhoto","parameters":[{"name":"id","in":"path","description":"The event's id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Empty response","content":{}}}}},"/events/{eventId}/occurrences/{occurrence}":{"get":{"tags":["events"],"summary":"Get a specific occurrence of an event","security":[{"oauth2":["read:events"]}],"operationId":"getEventOccurrence","parameters":[{"name":"eventId","in":"path","description":"The event's id","required":true,"schema":{"type":"integer"}},{"name":"occurrence","in":"path","required":true,"description":"the event's occurrence","schema":{"type":"string","format":"date"}}],"responses":{"200":{"description":"a specific event occurrence","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/FullEventOccurrenceType"}}}}},"401":{"$ref":"#/components/responses/NotAuthenticated"},"403":{"$ref":"#/components/responses/NotAuthorized"},"404":{"$ref":"#/components/responses/NotFound"}}}},"/events/{id}/calendar":{"get":{"tags":["events"],"summary":"Get the event calendar","security":[{"oauth2":["read:events"]}],"operationId":"getEventCalendar","parameters":[{"name":"id","in":"path","description":"The event's id","required":true,"schema":{"type":"integer"}},{"name":"start","in":"query","description":"YYYY-MM-DD ISO-8601","schema":{"type":"string","format":"date"}},{"name":"end","in":"query","description":"YYYY-MM-DD ISO-8601","schema":{"type":"string","format":"date"}}],"responses":{"200":{"description":"List of event occurrences","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BasicEventOccurrenceSerializer"}}}}},"401":{"$ref":"#/components/responses/NotAuthenticated"},"403":{"$ref":"#/components/responses/NotAuthorized"},"404":{"$ref":"#/components/responses/NotFound"}}}},"/events/{id}/guests":{"get":{"tags":["events"],"summary":"Get event guest list","security":[{"oauth2":["read:events"]}],"operationId":"getEventGuests","parameters":[{"name":"id","in":"path","description":"The event's id","required":true,"schema":{"type":"integer"}},{"name":"status","in":"query","schema":{"type":"string","enum":["REQUESTING","GOING","NOT_GOING","MAYBE","NOT_RESPONDED"]}},{"name":"name","in":"query","schema":{"type":"string"}},{"$ref":"#/components/parameters/PerPage"},{"$ref":"#/components/parameters/Page"}],"responses":{"200":{"description":"Get event guest list","headers":{"X-Offset":{"$ref":"#/components/headers/X-Offset"},"X-Per-Page":{"$ref":"#/components/headers/X-Per-Page"},"X-Total-Pages":{"$ref":"#/components/headers/X-Total-Pages"},"X-Page":{"$ref":"#/components/headers/X-Page"}},"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BasicIndividualEventsProfileWithIndividualSerializer"}}}}},"401":{"$ref":"#/components/responses/NotAuthenticated"},"403":{"$ref":"#/components/responses/NotAuthorized"},"404":{"$ref":"#/components/responses/NotFound"}}}},"/events/{id}/shared_campuses":{"get":{"tags":["events"],"summary":"Get an events's shared campuses","security":[{"oauth2":["read:events"]}],"operationId":"getEventSharedCampuses","parameters":[{"name":"id","in":"path","description":"The event's id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"List of event's shared campuses","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SharedEventSerializer"}}}}},"401":{"$ref":"#/components/responses/NotAuthenticated"},"403":{"$ref":"#/components/responses/NotAuthorized"},"404":{"$ref":"#/components/responses/NotFound"}}},"post":{"tags":["events"],"summary":"Share an event with other campuses","security":[{"oauth2":["write:events"]}],"operationId":"postEventSharedCampuses","parameters":[{"name":"id","in":"path","description":"The event's id","required":true,"schema":{"type":"integer"}}],"requestBody":{"description":"Array of campus ids","content":{"application/json":{"schema":{"type":"object","properties":{"campus_ids":{"type":"array","items":{"type":"integer"}}}}}}},"responses":{"200":{"description":"List of event's shared campuses","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SharedEventSerializer"}}}}},"401":{"$ref":"#/components/responses/NotAuthenticated"},"403":{"$ref":"#/components/responses/NotAuthorized"},"404":{"$ref":"#/components/responses/NotFound"}}}},"/events/{id}/shared_campuses/{campus_id}":{"get":{"tags":["events"],"summary":"Get a shared event","security":[{"oauth2":["read:events"]}],"operationId":"getSharedEvent","parameters":[{"name":"id","in":"path","description":"The event's id","required":true,"schema":{"type":"integer"}},{"name":"campus_id","in":"path","description":"The campus' id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"The shared event","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SharedEventSerializer"}}}}},"401":{"$ref":"#/components/responses/NotAuthenticated"},"403":{"$ref":"#/components/responses/NotAuthorized"},"404":{"$ref":"#/components/responses/NotFound"}}},"put":{"tags":["events"],"summary":"Update shared event invite for campus","security":[{"oauth2":["write:events"]}],"operationId":"putEventSharedCampus","parameters":[{"name":"id","in":"path","description":"The event's id","required":true,"schema":{"type":"integer"}},{"name":"campus_id","in":"path","description":"The campus' id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"update a specific campus shared event","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SharedEventSerializer"}}}}},"401":{"$ref":"#/components/responses/NotAuthenticated"},"403":{"$ref":"#/components/responses/NotAuthorized"},"404":{"$ref":"#/components/responses/NotFound"}}}},"/events/{id}/{occurrence}":{"delete":{"tags":["events"],"summary":"Delete event occurrence","security":[{"oauth2":["write:events"]}],"operationId":"deleteEventOccurrence","parameters":[{"name":"id","in":"path","description":"The event's id","required":true,"schema":{"type":"integer"}},{"name":"occurrence","in":"path","description":"The occurrence date (in YYYYMMDD format)","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Empty response","content":{}}}}},"/events/{id}/attendance/candidates":{"get":{"tags":["events"],"summary":"Get event candidate list","security":[{"oauth2":["read:event_attendance"]}],"operationId":"getEventCandidates","parameters":[{"name":"id","in":"path","description":"The event's id","required":true,"schema":{"type":"integer"}},{"name":"occurrence","in":"query","description":"YYYYMMDD ISO-8601","schema":{"type":"string","format":"date"}},{"$ref":"#/components/parameters/PerPage"},{"$ref":"#/components/parameters/Page"}],"responses":{"200":{"description":"Get event candidate list","headers":{"X-Offset":{"$ref":"#/components/headers/X-Offset"},"X-Per-Page":{"$ref":"#/components/headers/X-Per-Page"},"X-Total-Pages":{"$ref":"#/components/headers/X-Total-Pages"},"X-Page":{"$ref":"#/components/headers/X-Page"}},"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/EventCandidateIndividualSerializer"}}}}},"401":{"$ref":"#/components/responses/NotAuthenticated"},"403":{"$ref":"#/components/responses/NotAuthorized"},"404":{"$ref":"#/components/responses/NotFound"}}}},"/events/{id}/attendance/{occurrence}":{"get":{"tags":["events"],"summary":"Get event summary details","security":[{"oauth2":["read:event_attendance"]}],"operationId":"getEventSummary","parameters":[{"name":"id","in":"path","description":"The event's id","required":true,"schema":{"type":"integer"}},{"name":"occurrence","in":"path","description":"The occurrence date (in YYYYMMDD format)","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Get event summary details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BasicEventSummarySerializer"}}}},"401":{"$ref":"#/components/responses/NotAuthenticated"},"403":{"$ref":"#/components/responses/NotAuthorized"},"404":{"$ref":"#/components/responses/NotFound"}}},"post":{"tags":["events"],"summary":"Create/update event summary details","security":[{"oauth2":["write:event_attendance"]}],"operationId":"updateEventSummary","parameters":[{"name":"id","in":"path","description":"The event's id","required":true,"schema":{"type":"integer"}},{"name":"occurrence","in":"path","description":"The occurrence date (in YYYYMMDD format)","required":true,"schema":{"type":"integer"}}],"requestBody":{"description":"The new event summary","content":{"application/json":{"schema":{"type":"object","properties":{"topic":{"type":"string"},"notes":{"type":"string"},"prayer_requests":{"type":"string"},"people_information":{"type":"string"},"send_to":{"type":"string","enum":["LEADERS","MEMBERS","NONE"]},"status":{"type":"string","enum":["DID_NOT_MEET","MET"]},"visitors":{"type":"integer"}}}}},"required":false},"responses":{"200":{"description":"Event summary details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BasicEventSummarySerializer"}}}},"401":{"$ref":"#/components/responses/NotAuthenticated"},"403":{"$ref":"#/components/responses/NotAuthorized"},"404":{"$ref":"#/components/responses/NotFound"}},"x-codegen-request-body-name":"updateEventSummary"}},"/events/{id}/attendance/{occurrence}/attendees":{"get":{"tags":["events"],"summary":"Get event attendees list","security":[{"oauth2":["read:event_attendance"]}],"operationId":"getEventAttendees","parameters":[{"name":"id","in":"path","description":"The event's id","required":true,"schema":{"type":"integer"}},{"name":"occurrence","in":"path","description":"The occurrence date (in YYYYMMDD format)","required":true,"schema":{"type":"integer"}},{"$ref":"#/components/parameters/PerPage"},{"$ref":"#/components/parameters/Page"}],"responses":{"200":{"description":"Get event attendees list","headers":{"X-Offset":{"$ref":"#/components/headers/X-Offset"},"X-Per-Page":{"$ref":"#/components/headers/X-Per-Page"},"X-Total-Pages":{"$ref":"#/components/headers/X-Total-Pages"},"X-Page":{"$ref":"#/components/headers/X-Page"}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/EventAttendeesIndividualSerializer"}}}}},"401":{"$ref":"#/components/responses/NotAuthenticated"},"403":{"$ref":"#/components/responses/NotAuthorized"},"404":{"$ref":"#/components/responses/NotFound"}}},"post":{"tags":["events"],"summary":"Update event attendees","security":[{"oauth2":["write:event_attendance"]}],"operationId":"updateEventAttendees","parameters":[{"name":"id","in":"path","description":"The event's id","required":true,"schema":{"type":"integer"}},{"name":"occurrence","in":"path","description":"The occurrence date (in YYYYMMDD format)","required":true,"schema":{"type":"integer"}}],"requestBody":{"description":"The numeric, or numeric string, ids of the individuals that were in attendance","content":{"application/json":{"schema":{"type":"array","items":{"type":"string","example":""}}}},"required":true},"responses":{"200":{"description":"The event attendees list","headers":{"X-Offset":{"$ref":"#/components/headers/X-Offset"},"X-Per-Page":{"$ref":"#/components/headers/X-Per-Page"},"X-Total-Pages":{"$ref":"#/components/headers/X-Total-Pages"},"X-Page":{"$ref":"#/components/headers/X-Page"}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/EventAttendeesIndividualSerializer"}}}}},"401":{"$ref":"#/components/responses/NotAuthenticated"},"403":{"$ref":"#/components/responses/NotAuthorized"},"404":{"$ref":"#/components/responses/NotFound"}},"x-codegen-request-body-name":"individual_ids"}},"/events/{id}/resources":{"get":{"tags":["events","resources"],"summary":"Get event resource list","security":[{"oauth2":["read:event_resources"]}],"operationId":"getEventResources","parameters":[{"name":"id","in":"path","description":"The event's id","required":true,"schema":{"type":"integer"}},{"$ref":"#/components/parameters/PerPage"},{"$ref":"#/components/parameters/Page"},{"name":"status","in":"query","schema":{"type":"string","enum":["PENDING","APPROVED"]}},{"name":"exclude_child_resources","in":"query","schema":{"type":"boolean"}}],"responses":{"200":{"description":"Get event resources list","headers":{"X-Offset":{"$ref":"#/components/headers/X-Offset"},"X-Per-Page":{"$ref":"#/components/headers/X-Per-Page"},"X-Total-Pages":{"$ref":"#/components/headers/X-Total-Pages"},"X-Page":{"$ref":"#/components/headers/X-Page"}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/EventResourceSerializer"}}}}},"401":{"$ref":"#/components/responses/NotAuthenticated"},"403":{"$ref":"#/components/responses/NotAuthorized"},"404":{"$ref":"#/components/responses/NotFound"}}}},"/events/{id}/rooms":{"get":{"tags":["events","resources"],"summary":"Get event room list","security":[{"oauth2":["read:event_resources"]}],"operationId":"getEventRooms","parameters":[{"name":"id","in":"path","description":"The event's id","required":true,"schema":{"type":"integer"}},{"$ref":"#/components/parameters/PerPage"},{"$ref":"#/components/parameters/Page"},{"name":"status","in":"query","schema":{"type":"string","enum":["PENDING","APPROVED"]}}],"responses":{"200":{"description":"Get event room list","headers":{"X-Offset":{"$ref":"#/components/headers/X-Offset"},"X-Per-Page":{"$ref":"#/components/headers/X-Per-Page"},"X-Total-Pages":{"$ref":"#/components/headers/X-Total-Pages"},"X-Page":{"$ref":"#/components/headers/X-Page"}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/EventRoomSerializer"}}}}},"401":{"$ref":"#/components/responses/NotAuthenticated"},"403":{"$ref":"#/components/responses/NotAuthorized"},"404":{"$ref":"#/components/responses/NotFound"}}}},"/events/shared_campuses":{"get":{"tags":["events"],"summary":"Get list of shared events, campuses, statuses","security":[{"oauth2":["read:events"]}],"operationId":"getSharedEvents","parameters":[{"name":"event_ids","in":"query","description":"An array of event_ids to filter by","style":"form","explode":true,"schema":{"type":"array","items":{"type":"integer"}}},{"name":"campus_ids","in":"query","description":"An array of campus_ids to filter by","style":"form","explode":true,"schema":{"type":"array","items":{"type":"integer"}}},{"name":"status","in":"query","description":"An array of shared event statuses to filter by","style":"form","explode":true,"schema":{"type":"array","items":{"$ref":"#/components/schemas/SharedEventStatus"}}},{"name":"sort_by","in":"query","description":"An array of shared event statuses to sort by, in ascending order","style":"form","explode":true,"schema":{"type":"array","items":{"$ref":"#/components/schemas/SharedEventStatus"}}},{"name":"range_type","in":"query","schema":{"$ref":"#/components/schemas/EventRangeTypeFilter"}},{"$ref":"#/components/parameters/PerPage"},{"$ref":"#/components/parameters/Page"}],"responses":{"200":{"description":"List of shared events","headers":{"X-Offset":{"$ref":"#/components/headers/X-Offset"},"X-Per-Page":{"$ref":"#/components/headers/X-Per-Page"},"X-Total-Pages":{"$ref":"#/components/headers/X-Total-Pages"},"X-Page":{"$ref":"#/components/headers/X-Page"}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SharedEventSerializer"}}}}},"401":{"$ref":"#/components/responses/NotAuthenticated"},"403":{"$ref":"#/components/responses/NotAuthorized"},"404":{"$ref":"#/components/responses/NotFound"}}}},"/events/search":{"get":{"tags":["events"],"summary":"Search events","security":[{"oauth2":["read:events"]}],"operationId":"getEventsSearch","parameters":[{"name":"name","in":"query","schema":{"type":"string"}},{"name":"range_type","in":"query","schema":{"$ref":"#/components/schemas/EventRangeTypeFilter"}},{"name":"campus_ids","in":"query","style":"form","explode":true,"schema":{"type":"array","items":{"type":"integer"}}},{"name":"group_ids","in":"query","style":"form","explode":true,"schema":{"type":"array","items":{"type":"integer"}}},{"name":"group_type_ids","in":"query","style":"form","explode":true,"schema":{"type":"array","items":{"type":"integer"}}},{"name":"group_name","in":"query","schema":{"type":"string"}},{"name":"attendance_grouping_ids","in":"query","style":"form","explode":true,"schema":{"type":"array","items":{"type":"integer"}}},{"name":"department_ids","in":"query","style":"form","explode":true,"schema":{"type":"array","items":{"type":"integer"}}},{"name":"organizer_individual_id","in":"query","schema":{"type":"integer"}},{"name":"event_ids","in":"query","style":"form","explode":true,"description":"Filter results to specific event IDs","schema":{"type":"array","items":{"type":"integer"}}},{"$ref":"#/components/parameters/Page"},{"$ref":"#/components/parameters/PerPage"}],"responses":{"200":{"description":"Get event list","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/FullEventSerializer"}}}}}}}},"/calendar":{"get":{"tags":["events"],"summary":"Get event calendar","security":[{"oauth2":["read:events"]}],"operationId":"getCalendar","parameters":[{"name":"start","in":"query","schema":{"type":"string","format":"date"}},{"name":"end","in":"query","schema":{"type":"string","format":"date"}},{"name":"campus_ids","in":"query","style":"form","explode":true,"schema":{"type":"array","items":{"type":"integer"}}},{"name":"campus_id","deprecated":true,"in":"query","required":true,"schema":{"type":"integer"}},{"name":"type","in":"query","schema":{"type":"string","enum":["ALL_EVENTS_ADMIN","CAMPUS_WIDE","PUBLIC","FACILITIES"]}},{"name":"include_shared_events","in":"query","schema":{"type":"boolean"}},{"name":"group_type_ids","in":"query","style":"form","explode":true,"schema":{"type":"array","items":{"type":"integer"}}},{"name":"group_name","in":"query","schema":{"type":"string"}},{"name":"attendance_grouping_ids","in":"query","style":"form","explode":true,"schema":{"type":"array","items":{"type":"integer"}}},{"name":"department_ids","in":"query","style":"form","explode":true,"schema":{"type":"array","items":{"type":"integer"}}}],"responses":{"200":{"description":"Get event list","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BasicEventOccurrenceSerializer"}}}}}}}},"/individuals/{id}/calendar":{"get":{"tags":["events","individuals"],"summary":"Get event calendar for an individual","security":[{"oauth2":["read:events"]}],"operationId":"getIndividualCalendar","parameters":[{"name":"start","in":"query","schema":{"type":"string","format":"date"}},{"name":"end","in":"query","schema":{"type":"string","format":"date"}},{"name":"campus_ids","in":"query","style":"form","explode":true,"schema":{"type":"array","items":{"type":"integer"}}},{"name":"include_shared_events","in":"query","schema":{"type":"boolean"}},{"name":"group_type_ids","in":"query","style":"form","explode":true,"schema":{"type":"array","items":{"type":"integer"}}},{"name":"group_name","in":"query","schema":{"type":"string"}},{"name":"attendance_grouping_ids","in":"query","style":"form","explode":true,"schema":{"type":"array","items":{"type":"integer"}}},{"name":"id","in":"path","description":"The individual's id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Get event list","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BasicEventSerializer"}}}}}}}},"/groups/{id}/calendar":{"get":{"tags":["groups","events"],"summary":"Get the group events in the timeframe","security":[{"oauth2":["read:events"]}],"operationId":"getGroupCalendar","parameters":[{"name":"id","in":"path","description":"The group's id","required":true,"schema":{"type":"integer"}},{"name":"start","in":"query","description":"Start date","schema":{"type":"string","format":"date"}},{"name":"end","in":"query","description":"End date","schema":{"type":"string","format":"date"}}],"responses":{"200":{"description":"Get event list for a group","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BasicGroupEventOccurrenceSerializer"}}}}},"401":{"$ref":"#/components/responses/NotAuthenticated"},"403":{"$ref":"#/components/responses/NotAuthorized"},"404":{"$ref":"#/components/responses/NotFound"}}}},"/groups/{id}/attendance":{"get":{"tags":["groups","events"],"summary":"Get the group events in the timeframe","security":[{"oauth2":["read:events"]}],"operationId":"getGroupAttendance","parameters":[{"name":"id","in":"path","description":"The group's id","required":true,"schema":{"type":"integer"}},{"name":"start","in":"query","description":"Start date","schema":{"type":"string","format":"date"}},{"name":"end","in":"query","description":"End date","schema":{"type":"string","format":"date"}}],"responses":{"200":{"description":"List of event occurrences","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AttendanceSummarySerializer"}}}}},"401":{"$ref":"#/components/responses/NotAuthenticated"},"403":{"$ref":"#/components/responses/NotAuthorized"},"404":{"$ref":"#/components/responses/NotFound"}}}},"/groups/{id}/attendance/needed":{"get":{"tags":["groups","events"],"summary":"Get the group attendance needed count","security":[{"oauth2":["read:events"]}],"operationId":"getAttendanceNeededCount","parameters":[{"name":"id","in":"path","description":"The group's id","required":true,"schema":{"type":"integer"}},{"name":"start","in":"query","description":"the start date to filter by","schema":{"type":"string","format":"date"}},{"name":"end","in":"query","description":"the end date to filter by","schema":{"type":"string","format":"date"}}],"responses":{"200":{"description":"The count of events with attendance needed","content":{"*/*":{"schema":{"type":"integer"}}}},"401":{"$ref":"#/components/responses/NotAuthenticated"},"403":{"$ref":"#/components/responses/NotAuthorized"}}}},"/groups/{id}/events":{"get":{"tags":["groups","events"],"summary":"Get list of group events","security":[{"oauth2":["read:events"]}],"operationId":"getGroupEvents","parameters":[{"name":"id","in":"path","description":"The group's id","required":true,"schema":{"type":"integer"}},{"name":"name","in":"query","description":"event name","schema":{"type":"string"}}],"responses":{"200":{"description":"List of groups events","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BasicGroupEventOccurrenceSerializer"}}}}},"401":{"$ref":"#/components/responses/NotAuthenticated"},"403":{"$ref":"#/components/responses/NotAuthorized"},"404":{"$ref":"#/components/responses/NotFound"}}}},"/individuals/events/{event_id}":{"post":{"tags":["events","individuals"],"summary":"Create a batch of individual's event status","security":[{"oauth2":["write:events"]}],"operationId":"createIndividualEvents","parameters":[{"name":"event_id","in":"path","description":"The event's id","required":true,"schema":{"type":"integer"}}],"requestBody":{"description":"The event status and individuals to create","content":{"application/json":{"schema":{"type":"object","properties":{"individual_ids":{"type":"array","items":{"type":"integer"}},"status":{"type":"string","enum":["REQUESTING","GOING","NOT_GOING","MAYBE","NOT_RESPONDED"]}}}}},"required":false},"responses":{"200":{"description":"Update an individual's event status","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CreateIndividualEventsSerializer"}}}}},"400":{"description":"Invalid event status provided","content":{}},"403":{"description":"Insufficient permissions to update individual event","content":{}},"404":{"description":"The event does not exist","content":{}}},"x-codegen-request-body-name":"createIndividualEvents"}},"/individuals/{id}/events/{event_id}":{"get":{"tags":["events","individuals"],"summary":"Get an individual's event details","security":[{"oauth2":["read:individual_events"]}],"operationId":"getIndividualEvent","parameters":[{"name":"id","in":"path","description":"The individual's id","required":true,"schema":{"type":"integer"}},{"name":"event_id","in":"path","description":"The event's id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Get individual event details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BasicIndividualEventsProfileWithEventSerializer"}}}},"401":{"$ref":"#/components/responses/NotAuthenticated"},"403":{"$ref":"#/components/responses/NotAuthorized"},"404":{"$ref":"#/components/responses/NotFound"}}},"post":{"tags":["events","individuals"],"summary":"Update an individual's event status","security":[{"oauth2":["write:individual_events"]}],"operationId":"updateIndividualEvent","parameters":[{"name":"id","in":"path","description":"The individual's id","required":true,"schema":{"type":"integer"}},{"name":"event_id","in":"path","description":"The event's id","required":true,"schema":{"type":"integer"}}],"requestBody":{"description":"The new individual event status","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/BaseIndividualEventStatuses"},{"$ref":"#/components/schemas/BaseIndividualEvent"}]}}},"required":false},"responses":{"200":{"description":"Update an individual's event status","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BasicIndividualEventsProfileWithEventSerializer"}}}},"201":{"description":"Create an individual's event status","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BasicIndividualEventsProfileWithEventSerializer"}}}},"400":{"description":"Invalid event status provided","content":{}},"403":{"description":"Insufficient permissions to update individual event","content":{}},"404":{"description":"The event does not exist","content":{}}},"x-codegen-request-body-name":"updateIndividualEvent"}},"/individuals/{id}/admin/events":{"get":{"tags":["events"],"summary":"Get individual events they organize","security":[{"oauth2":["read:events"]}],"operationId":"getIndividualAdminEvents","parameters":[{"name":"id","in":"path","description":"The individual's id","required":true,"schema":{"type":"integer"}},{"$ref":"#/components/parameters/PerPage"},{"$ref":"#/components/parameters/Page"},{"name":"name","in":"query","schema":{"type":"string"}},{"name":"range_type","in":"query","schema":{"$ref":"#/components/schemas/EventRangeTypeFilter"}}],"responses":{"200":{"description":"Get event list","headers":{"X-Offset":{"$ref":"#/components/headers/X-Offset"},"X-Per-Page":{"$ref":"#/components/headers/X-Per-Page"},"X-Total-Pages":{"$ref":"#/components/headers/X-Total-Pages"},"X-Page":{"$ref":"#/components/headers/X-Page"}},"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BasicEventSerializer"}}}}}}}},"/files":{"post":{"tags":["files"],"summary":"Upload a file","description":"This endpoint creates a temporary file that can be associated to a type of file upload. Currently supports form response attachments.","security":[{"oauth2":["write:files"]}],"operationId":"uploadFile","requestBody":{"content":{"multipart/form-data":{"schema":{"required":["file"],"properties":{"file":{"type":"string","description":"File to upload","format":"binary"},"label":{"type":"string","description":"Label for file"},"description":{"type":"string","description":"Description of file"},"private":{"type":"boolean","description":"Make file private"}}}}},"required":true},"responses":{"200":{"description":"Returns a file serializer","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FileSerializer"}}}},"400":{"$ref":"#/components/responses/NotValid"}}}},"/files/{id}":{"get":{"tags":["files"],"summary":"Get a file","security":[{"oauth2":["read:files"]}],"operationId":"getFile","parameters":[{"name":"id","in":"path","description":"The file id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Returns a file serializer","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FileSerializer"}}}},"400":{"$ref":"#/components/responses/NotValid"},"404":{"$ref":"#/components/responses/NotFound"}}}},"/individuals/{id}/files":{"get":{"tags":["files","individuals"],"summary":"Get an individual's profile files","security":[{"oauth2":["read:individual_files"]}],"operationId":"getIndividualFiles","parameters":[{"name":"id","in":"path","description":"The individual's id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"The individual's profile files","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/IndividualFileSerializer"}}}}},"401":{"$ref":"#/components/responses/NotAuthenticated"},"403":{"$ref":"#/components/responses/NotAuthorized"},"404":{"$ref":"#/components/responses/NotFound"}}},"post":{"tags":["files","individuals"],"summary":"Upload a file to an individual's profile","security":[{"oauth2":["write:individual_files"]}],"operationId":"uploadIndividualFile","parameters":[{"name":"id","in":"path","description":"The individual's id","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"required":["file"],"properties":{"file":{"type":"string","description":"File to upload","format":"binary"},"label":{"type":"string","description":"Label for file"},"description":{"type":"string","description":"Description of file"},"private":{"type":"boolean","description":"Make file private"}}}}},"required":true},"responses":{"200":{"description":"The files added to the individual's profile","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/IndividualFileSerializer"}}}}},"400":{"description":"Invalid file or file type provided","content":{}},"401":{"$ref":"#/components/responses/NotAuthenticated"},"403":{"$ref":"#/components/responses/NotAuthorized"}}}},"/individuals/{id}/files/{file_id}":{"post":{"tags":["files","individuals"],"summary":"Updates file","security":[{"oauth2":["write:individual_files"]}],"operationId":"updateIndividualFile","parameters":[{"name":"id","in":"path","description":"The individual's id","required":true,"schema":{"type":"integer"}},{"name":"file_id","in":"path","description":"The file's id","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"properties":{"file":{"type":"string","description":"File to upload","format":"binary"},"label":{"type":"string","description":"Label for file"},"description":{"type":"string","description":"Description of file"},"private":{"type":"boolean","description":"Make file private"}}}}}},"responses":{"200":{"description":"Returns the individual file serializer","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/IndividualFileSerializer"}}}}},"401":{"$ref":"#/components/responses/NotAuthenticated"},"403":{"$ref":"#/components/responses/NotAuthorized"},"404":{"$ref":"#/components/responses/NotFound"}}},"delete":{"tags":["files","individuals"],"summary":"Deletes file","security":[{"oauth2":["write:individual_files"]}],"operationId":"deleteIndividualFile","parameters":[{"name":"id","in":"path","description":"The individual's id","required":true,"schema":{"type":"integer"}},{"name":"file_id","in":"path","description":"The file's id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Empty response","content":{}},"401":{"$ref":"#/components/responses/NotAuthenticated"},"403":{"$ref":"#/components/responses/NotAuthorized"},"404":{"$ref":"#/components/responses/NotFound"}}}},"/individuals/{id}/scheduled_gifts":{"get":{"tags":["individuals"],"summary":"Get an individual's scheduled gifts","security":[{"oauth2":["read:individual_scheduled_gifts"]}],"operationId":"getIndividualScheduledGifts","parameters":[{"name":"id","in":"path","description":"The individual's id","required":true,"schema":{"type":"integer"}},{"$ref":"#/components/parameters/PerPage"},{"$ref":"#/components/parameters/Page"},{"name":"status","in":"query","description":"Filter repeating gifts by active status","schema":{"type":"string","default":"ALL","enum":["ACTIVE","INACTIVE","ALL"]}}],"responses":{"200":{"description":"The individual's scheduled gifts","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BasicScheduledGiftSerializer"}}}}},"401":{"$ref":"#/components/responses/NotAuthenticated"},"403":{"$ref":"#/components/responses/NotAuthorized"}}}},"/individuals/{id}/scheduled_gifts/{gift_id}":{"put":{"tags":["individuals"],"summary":"Update an individual's scheduled gift","security":[{"oauth2":["write:individual_scheduled_gifts"]}],"operationId":"updateIndividualScheduledGift","parameters":[{"name":"id","in":"path","description":"The individual's id","required":true,"schema":{"type":"integer"}},{"name":"gift_id","in":"path","description":"The scheduled gift's id","required":true,"schema":{"type":"integer"}}],"requestBody":{"description":"The updated scheduled gift","content":{"application/json":{"schema":{"type":"object","properties":{"merchant_status":{"type":"string","enum":["CANCELLED"]}}}}},"required":false},"responses":{"200":{"description":"The scheduled gift details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BasicScheduledGiftSerializer"}}}},"401":{"$ref":"#/components/responses/NotAuthenticated"},"403":{"$ref":"#/components/responses/NotAuthorized"},"404":{"$ref":"#/components/responses/NotFound"}},"x-codegen-request-body-name":"updateScheduledGift"}},"/individuals/{id}/pledges":{"get":{"tags":["individuals"],"summary":"Get an individual's pledges","security":[{"oauth2":["read:individual_pledges"]}],"operationId":"getIndividualPledges","parameters":[{"name":"id","in":"path","description":"The individual's id","required":true,"schema":{"type":"integer"}},{"$ref":"#/components/parameters/PerPage"},{"$ref":"#/components/parameters/Page"}],"responses":{"200":{"description":"The individual's pledges","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BasicPledgeSerializer"}}}}},"401":{"$ref":"#/components/responses/NotAuthenticated"},"403":{"$ref":"#/components/responses/NotAuthorized"}}}},"/forms":{"get":{"tags":["forms"],"summary":"Get list of forms","security":[{"oauth2":["read:forms"]}],"operationId":"getForms","parameters":[{"$ref":"#/components/parameters/PerPage"},{"$ref":"#/components/parameters/Page"},{"name":"campus_id","in":"query","description":"Campus ID to match","schema":{"type":"integer"}},{"name":"form_must_have_questions","in":"query","description":"Restricts return to forms with questions","schema":{"type":"boolean"}},{"name":"managed_by","in":"query","description":"Returns forms managed by this user id","schema":{"type":"integer"}},{"name":"title","in":"query","description":"Partial title search","schema":{"type":"string"}},{"name":"publicly_listed","in":"query","description":"Restricts return to forms that are publicaly listed","schema":{"type":"boolean"}},{"name":"sort_by","in":"query","description":"Sort form list response","schema":{"$ref":"#/components/schemas/FormSortBy"}},{"name":"sort_direction","in":"query","description":"Sort form list direction","schema":{"type":"string"}},{"name":"status","in":"query","description":"Form status to match","schema":{"$ref":"#/components/schemas/FormStatus"}},{"name":"with_metrics","in":"query","description":"Returns the form metrics","schema":{"type":"boolean"}}],"responses":{"200":{"description":"Get available forms","headers":{"X-Offset":{"$ref":"#/components/headers/X-Offset"},"X-Per-Page":{"$ref":"#/components/headers/X-Per-Page"},"X-Total-Pages":{"$ref":"#/components/headers/X-Total-Pages"},"X-Page":{"$ref":"#/components/headers/X-Page"}},"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","allOf":[{"$ref":"#/components/schemas/BasicFormSerializer"},{"type":"object","properties":{"actions":{"type":"object","properties":{"canRespondToForm":{"$ref":"#/components/schemas/Action"}}}}}]}}}}},"412":{"$ref":"#/components/responses/NotValid"}}}},"/forms/{id}":{"get":{"tags":["forms"],"summary":"Get a specific form","security":[{"oauth2":["read:forms"]}],"operationId":"getForm","parameters":[{"name":"id","in":"path","description":"The form id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Form data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FullFormSerializer"}}}},"401":{"$ref":"#/components/responses/NotAuthenticated"},"403":{"$ref":"#/components/responses/NotAuthorized"},"404":{"$ref":"#/components/responses/NotFound"}}}},"/forms/{id}/responses":{"get":{"tags":["forms"],"summary":"Get a list of form responses","security":[{"oauth2":["read:forms"]}],"operationId":"getFormResponses","parameters":[{"name":"id","in":"path","description":"The form id","required":true,"schema":{"type":"integer"}},{"$ref":"#/components/parameters/PerPage"},{"$ref":"#/components/parameters/Page"},{"name":"payment_id","in":"query","description":"The payment id used when making a payment","schema":{"type":"integer"}}],"responses":{"200":{"description":"Returns the list of form responses","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/FullFormResponseSerializer"}}}}},"401":{"$ref":"#/components/responses/NotAuthenticated"},"403":{"$ref":"#/components/responses/NotAuthorized"},"404":{"$ref":"#/components/responses/NotFound"}}},"post":{"tags":["forms"],"summary":"Create a new form response","security":[{"oauth2":["write:form_responses"]}],"operationId":"createFormResponse","parameters":[{"name":"id","in":"path","description":"The form id","required":true,"schema":{"type":"integer"}}],"requestBody":{"description":"the form response to create / edit","content":{"*/*":{"schema":{"$ref":"#/components/schemas/FormResponseRequest"}}},"required":false},"responses":{"201":{"description":"Returns the full new form response","content":{"application/json":{"schema":{"type":"object","oneOf":[{"$ref":"#/components/schemas/FormPaymentNeededSerializer"},{"$ref":"#/components/schemas/FullFormResponseSerializer"}]}}}},"400":{"$ref":"#/components/responses/NotValid"},"401":{"$ref":"#/components/responses/NotAuthenticated"},"403":{"$ref":"#/components/responses/NotAuthorized"}},"x-codegen-request-body-name":"form response"}},"/forms/{id}/questions":{"get":{"tags":["forms"],"summary":"get a list of questions for a specific form","security":[{"oauth2":["read:forms"]}],"operationId":"getFormQuestions","parameters":[{"name":"id","in":"path","description":"The form id","required":true,"schema":{"type":"integer"}},{"$ref":"#/components/parameters/PerPage"},{"$ref":"#/components/parameters/Page"},{"name":"form_page","in":"query","description":"Return questions that are on a specific form page (think page breaks)","schema":{"type":"integer"}}],"responses":{"200":{"description":"List of form questions","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/FormQuestionSerializer"}}}}},"401":{"$ref":"#/components/responses/NotAuthenticated"},"403":{"$ref":"#/components/responses/NotAuthorized"},"404":{"$ref":"#/components/responses/NotFound"}}}},"/form_responses/{id}":{"get":{"tags":["forms"],"summary":"get a form response","security":[{"oauth2":["read:form_responses"]}],"operationId":"getFormResponse","parameters":[{"name":"id","in":"path","description":"The response id","required":true,"schema":{"type":"integer"}},{"name":"confirmation_code","in":"query","description":"The confirmation_code for the form response. (required if logged out)","schema":{"type":"string"}}],"responses":{"200":{"description":"Returns the full form response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FullFormResponseSerializer"}}}},"401":{"$ref":"#/components/responses/NotAuthenticated"},"403":{"$ref":"#/components/responses/NotAuthorized"},"404":{"$ref":"#/components/responses/NotFound"}}}},"/individuals/{id}/form_responses":{"get":{"tags":["forms"],"summary":"Get an individual's form responses","security":[{"oauth2":["read:form_responses"]}],"operationId":"getIndividualFormResponses","parameters":[{"name":"id","in":"path","description":"The individual's id","required":true,"schema":{"type":"integer"}},{"name":"include_administrated_forms","in":"query","description":"Include forms that the user is a form administrator","schema":{"type":"boolean"}},{"$ref":"#/components/parameters/PerPage"},{"$ref":"#/components/parameters/Page"},{"name":"order","in":"query","description":"Order results are returned, created%20desc, created%20asc, title%20desc, title%20asc","schema":{"type":"string"}}],"responses":{"200":{"description":"List of form responses","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BasicFormResponseSerializer"}}}}},"401":{"$ref":"#/components/responses/NotAuthenticated"},"403":{"$ref":"#/components/responses/NotAuthorized"},"404":{"$ref":"#/components/responses/NotFound"}}}},"/individuals/{id}/forms":{"get":{"tags":["forms"],"summary":"Get list of forms individual manages","security":[{"oauth2":["read:individual_forms"]}],"operationId":"getIndividualForms","parameters":[{"name":"id","in":"path","description":"The individuals id","required":true,"schema":{"type":"integer"}},{"$ref":"#/components/parameters/PerPage"},{"$ref":"#/components/parameters/Page"},{"name":"status","in":"query","description":"Filter forms by active status","schema":{"type":"string","default":"ALL","enum":["ACTIVE","INACTIVE","ALL"]}},{"name":"name","in":"query","description":"Partial name search","schema":{"type":"string"}},{"name":"include_administrated_forms","in":"query","description":"Include forms that the user is a form administrator","schema":{"type":"boolean"}}],"responses":{"200":{"description":"List of forms individual manages","content":{"*/*":{"schema":{"$ref":"#/components/schemas/BasicFormSerializer"}}}},"401":{"$ref":"#/components/responses/NotAuthenticated"},"403":{"$ref":"#/components/responses/NotAuthorized"},"404":{"$ref":"#/components/responses/NotFound"}}}},"/forms/{id}/automation":{"post":{"tags":["forms"],"summary":"Create form automation","security":[{"oauth2":["write:forms"]}],"operationId":"createFormAutomation","parameters":[{"name":"id","in":"path","description":"The form id","required":true,"schema":{"type":"integer"}}],"requestBody":{"description":"the form automation to create","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormAutomationRequest"}}},"required":false},"responses":{"200":{"description":"Returns Form Automation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormAutomationSerializer"}}}},"400":{"$ref":"#/components/responses/NotValid"},"401":{"$ref":"#/components/responses/NotAuthenticated"},"403":{"$ref":"#/components/responses/NotAuthorized"},"404":{"$ref":"#/components/responses/NotFound"}},"x-codegen-request-body-name":"CreateFormAutomationRequest"}},"/forms/{id}/respondents":{"get":{"tags":["forms"],"summary":"Get the list of individuals you can make responses for","security":[{"oauth2":["read:forms"]}],"operationId":"getFormRespondents","parameters":[{"name":"id","in":"path","description":"The form id","required":true,"schema":{"type":"integer"}},{"$ref":"#/components/parameters/PerPage"},{"$ref":"#/components/parameters/Page"},{"name":"family_id","in":"query","description":"filters the results by the family_id","schema":{"type":"integer"}},{"name":"individual_id","in":"query","description":"filters the results by the family_id of the individual","schema":{"type":"integer"}}],"responses":{"200":{"description":"List of individuals","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/FormRespondentSerializer"}}}}},"401":{"$ref":"#/components/responses/NotAuthenticated"},"403":{"$ref":"#/components/responses/NotAuthorized"},"404":{"$ref":"#/components/responses/NotFound"}}}},"/forms/{id}/managers":{"post":{"tags":["forms"],"summary":"Add form manager","security":[{"oauth2":["write:forms"]}],"operationId":"addFormManager","parameters":[{"name":"id","in":"path","description":"The form's id","required":true,"schema":{"type":"integer"}}],"requestBody":{"description":"The new form manager details","content":{"application/json":{"schema":{"type":"object","properties":{"individual_id":{"type":"integer"}}}}},"required":false},"responses":{"200":{"description":"Returns Form Manager","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BasicFormManagerSerializer"}}}},"401":{"$ref":"#/components/responses/NotAuthenticated"},"403":{"$ref":"#/components/responses/NotAuthorized"},"404":{"$ref":"#/components/responses/NotFound"}},"x-codegen-request-body-name":"addFormManagerRequest"}},"/forms/{id}/managers/{manager_id}":{"delete":{"tags":["forms"],"summary":"Remove form manager","security":[{"oauth2":["delete:forms"]}],"operationId":"deleteFormManager","parameters":[{"name":"id","in":"path","description":"The form's id","required":true,"schema":{"type":"integer"}},{"name":"manager_id","in":"path","description":"The form manager id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Empty response","content":{}},"401":{"$ref":"#/components/responses/NotAuthenticated"},"403":{"$ref":"#/components/responses/NotAuthorized"},"404":{"$ref":"#/components/responses/NotFound"}}}},"/groups":{"get":{"tags":["groups"],"summary":"Get groups","security":[{"oauth2":["read:groups"]}],"operationId":"getGroups","parameters":[{"name":"name","in":"query","description":"Partial name search","schema":{"type":"string"}},{"name":"campus_ids","in":"query","description":"An array of campus_ids to filter by","style":"form","explode":true,"schema":{"type":"array","items":{"type":"integer"}}},{"name":"show_suggestions","in":"query","description":"Show suggested groups (only works for logged in users)","schema":{"type":"boolean"}},{"name":"context_individual_id","in":"query","description":"An individual id to check if can individual join/leave group","schema":{"type":"integer"}},{"$ref":"#/components/parameters/PerPage"},{"$ref":"#/components/parameters/Page"}],"responses":{"200":{"description":"List of Groups (only public groups if not authenticated)","headers":{"X-Offset":{"$ref":"#/components/headers/X-Offset"},"X-Per-Page":{"$ref":"#/components/headers/X-Per-Page"},"X-Total-Pages":{"$ref":"#/components/headers/X-Total-Pages"},"X-Page":{"$ref":"#/components/headers/X-Page"}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BasicGroupSerializer"}}}}}}}},"/groups/admin":{"get":{"tags":["groups"],"summary":"Get groups","security":[{"oauth2":["read:groups"]}],"operationId":"getGroupsAdmin","parameters":[{"name":"name","in":"query","description":"Partial name search","schema":{"type":"string"}},{"name":"action","in":"query","description":"The action that will be performed on the groups","schema":{"type":"string","enum":["CREATE_EVENT","EDIT_EVENT","FULL_GROUP"]}},{"name":"campus_id","in":"query","description":"The campus id of the groups","schema":{"type":"integer"}},{"name":"show_suggestions","in":"query","description":"Show suggested groups (only works for logged in users)","schema":{"type":"boolean"}},{"$ref":"#/components/parameters/PerPage"},{"$ref":"#/components/parameters/Page"}],"responses":{"200":{"description":"List of groups for admin actions","headers":{"X-Offset":{"$ref":"#/components/headers/X-Offset"},"X-Per-Page":{"$ref":"#/components/headers/X-Per-Page"},"X-Total-Pages":{"$ref":"#/components/headers/X-Total-Pages"},"X-Page":{"$ref":"#/components/headers/X-Page"}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BasicGroupSerializer"}}}}}}}},"/groups/{id}":{"get":{"tags":["groups"],"summary":"Get group","security":[{"oauth2":["read:groups"]}],"operationId":"getGroup","parameters":[{"name":"id","in":"path","description":"The group's id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Group Details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FullGroupSerializer"}}}}}},"put":{"tags":["groups"],"summary":"Update group (currently only main leader is implemented)","security":[{"oauth2":["write:groups"]}],"operationId":"updateGroup","parameters":[{"name":"id","in":"path","description":"The group's id","required":true,"schema":{"type":"integer"}}],"requestBody":{"description":"The updated group properties","content":{"application/json":{"schema":{"type":"object","properties":{"main_leader_id":{"type":"integer"}}}}},"required":false},"responses":{"200":{"description":"Returns the full group serializer","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FullGroupSerializer"}}}}},"x-codegen-request-body-name":"updateGroupRequest"}},"/groups/{group_id}/settings":{"get":{"tags":["groups"],"summary":"Get the consolidated settings payload for the modernized Edit Group Settings page","description":"Returns meeting, location, notifications, leader-privilege, organization, and attendance-grouping\ninformation for a single group in one round-trip.\n\nGated by the `edit_group_settings` feature flag — returns 405 when the flag is off.\nCaller must have `canEditGroup` permission on the target group.\n","security":[{"oauth2":["read:groups"]}],"operationId":"getGroupSettings","parameters":[{"name":"group_id","in":"path","description":"The group's id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Group settings payload","content":{"application/json":{"schema":{"type":"object","required":["meeting","location","notifications","privileges","organization","attendance_groupings"],"properties":{"meeting":{"type":"object","properties":{"meeting_day_id":{"type":"integer","nullable":true},"meeting_day_name":{"type":"string","nullable":true},"meeting_time_id":{"type":"integer","nullable":true},"meeting_time_name":{"type":"string","nullable":true},"childcare_available":{"type":"boolean"}}},"location":{"type":"object","properties":{"area_id":{"type":"integer","nullable":true},"area_name":{"type":"string","nullable":true},"street":{"type":"string","nullable":true},"city":{"type":"string","nullable":true},"state":{"type":"string","nullable":true},"postal_code":{"type":"string","nullable":true},"country_iso":{"type":"string","nullable":true},"country_name":{"type":"string","nullable":true}}},"notifications":{"type":"object","properties":{"notify_leaders_on_join_or_leave":{"type":"boolean"},"member_default_emails":{"type":"boolean"},"member_default_comments":{"type":"boolean"},"member_default_weekly_digest":{"type":"boolean"},"member_default_texts":{"type":"boolean"}}},"privileges":{"type":"object","properties":{"can_edit_group_settings":{"type":"boolean"},"can_add_or_remove_participants":{"type":"boolean"},"can_update_participant_contact":{"type":"boolean"},"can_upload_files":{"type":"boolean"},"can_auto_generate_logins":{"type":"boolean"},"can_publish_events_to_campus_calendar":{"type":"boolean"},"can_request_rooms_and_resources":{"type":"boolean"},"can_access_family_info_in_reports":{"type":"boolean"}}},"organization":{"type":"object","properties":{"group_type_id":{"type":"integer","nullable":true},"group_type_name":{"type":"string","nullable":true},"department_id":{"type":"integer","nullable":true},"department_name":{"type":"string","nullable":true},"cross_reference_search_id":{"type":"integer","nullable":true},"is_approval_group":{"type":"boolean"}}},"attendance_groupings":{"type":"array","items":{"type":"object","required":["id","name","is_selected"],"properties":{"id":{"type":"integer"},"name":{"type":"string"},"is_selected":{"type":"boolean"}}}}}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Caller lacks canEditGroup on this group"},"404":{"description":"Group not found"},"405":{"description":"Endpoint disabled (edit_group_settings flag is off)"}}},"put":{"tags":["groups"],"summary":"Update a partial subset of group settings","description":"Accepts any subset of the sections returned by `GET /groups/{group_id}/settings`.\nEach section is independently optional — sending only `meeting` updates only\nmeeting fields. Within a section, only properties that are explicitly set are\npersisted. Returns the full updated settings shape on success.\n\nConcurrency model: last-write-wins (no optimistic-locking version field).\n\nAuthorization: caller must have `canEditGroup`. Group Leaders are blocked\n(403) from writing the `privileges`, `organization`, or `attendance_grouping_ids`\nsections — those require admin / department-admin / master-admin rights.\n\nGated by the `edit_group_settings` feature flag — returns 405 when the flag is off.\n","security":[{"oauth2":["write:groups"]}],"operationId":"updateGroupSettings","parameters":[{"name":"group_id","in":"path","description":"The group's id","required":true,"schema":{"type":"integer"}}],"requestBody":{"description":"Partial settings payload — any subset of fields.","required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"meeting":{"type":"object","properties":{"meeting_day_id":{"type":"integer","nullable":true},"meeting_time_id":{"type":"integer","nullable":true},"childcare_available":{"type":"boolean","nullable":true}}},"location":{"type":"object","properties":{"area_id":{"type":"integer","nullable":true},"street":{"type":"string","nullable":true},"city":{"type":"string","nullable":true},"state":{"type":"string","nullable":true},"postal_code":{"type":"string","nullable":true},"country_iso":{"type":"string","nullable":true}}},"notifications":{"type":"object","properties":{"notify_leaders_on_join_or_leave":{"type":"boolean","nullable":true},"member_default_emails":{"type":"boolean","nullable":true},"member_default_comments":{"type":"boolean","nullable":true},"member_default_weekly_digest":{"type":"boolean","nullable":true},"member_default_texts":{"type":"boolean","nullable":true}}},"privileges":{"type":"object","description":"Admin-only — Group Leaders are rejected with 403 if they include this section.","properties":{"can_edit_group_settings":{"type":"boolean","nullable":true},"can_add_or_remove_participants":{"type":"boolean","nullable":true},"can_update_participant_contact":{"type":"boolean","nullable":true},"can_upload_files":{"type":"boolean","nullable":true},"can_auto_generate_logins":{"type":"boolean","nullable":true},"can_publish_events_to_campus_calendar":{"type":"boolean","nullable":true},"can_request_rooms_and_resources":{"type":"boolean","nullable":true},"can_access_family_info_in_reports":{"type":"boolean","nullable":true}}},"organization":{"type":"object","description":"Admin-only — Group Leaders are rejected with 403 if they include this section.","properties":{"group_type_id":{"type":"integer","nullable":true},"department_id":{"type":"integer","nullable":true},"cross_reference_search_id":{"type":"integer","nullable":true},"is_approval_group":{"type":"boolean","nullable":true}}},"attendance_grouping_ids":{"type":"array","description":"Replace-all selection of event_grouping ids. Send `null` (or omit) for\nno change; send `[]` to clear all selections. Admin-only — Group Leaders\nare rejected with 403 if they include this field.\n","nullable":true,"items":{"type":"integer"}}}}}}},"responses":{"200":{"description":"Returns the full updated settings payload — same shape as\n`GET /groups/{group_id}/settings`.\n"},"401":{"description":"Not authenticated"},"403":{"description":"Caller lacks canEditGroup, or Group Leader attempted to write a privileged section"},"404":{"description":"Group not found"},"405":{"description":"Endpoint disabled (edit_group_settings flag is off)"}}}},"/groups/{id}/event_owner_candidates":{"get":{"tags":["groups"],"summary":"Get group event owner candidates list","security":[{"oauth2":["read:groups"]}],"operationId":"getGroupEventOwnerCandidates","parameters":[{"name":"id","in":"path","description":"The group's id","required":true,"schema":{"type":"integer"}},{"name":"name","in":"query","description":"Partial name search","schema":{"type":"string"}},{"$ref":"#/components/parameters/PerPage"},{"$ref":"#/components/parameters/Page"}],"responses":{"200":{"description":"Group event owner candidates list","headers":{"X-Offset":{"$ref":"#/components/headers/X-Offset"},"X-Per-Page":{"$ref":"#/components/headers/X-Per-Page"},"X-Total-Pages":{"$ref":"#/components/headers/X-Total-Pages"},"X-Page":{"$ref":"#/components/headers/X-Page"}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BasicIndividualProfileSerializer"}}}}}}}},"/groups/{id}/leaders":{"get":{"tags":["groups"],"summary":"Get group leaders list","security":[{"oauth2":["read:groups"]}],"operationId":"getGroupLeaders","parameters":[{"name":"id","in":"path","description":"The group's id","required":true,"schema":{"type":"integer"}},{"name":"name","in":"query","description":"Partial name search","schema":{"type":"string"}},{"$ref":"#/components/parameters/PerPage"},{"$ref":"#/components/parameters/Page"}],"responses":{"200":{"description":"Group leaders list","headers":{"X-Offset":{"$ref":"#/components/headers/X-Offset"},"X-Per-Page":{"$ref":"#/components/headers/X-Per-Page"},"X-Total-Pages":{"$ref":"#/components/headers/X-Total-Pages"},"X-Page":{"$ref":"#/components/headers/X-Page"}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BasicIndividualGroupsProfileSerializer"}}}}}}}},"/groups/{id}/members":{"get":{"tags":["groups"],"summary":"Get group members list","security":[{"oauth2":["read:group_members"]}],"operationId":"getGroupMembers","parameters":[{"name":"id","in":"path","description":"The group's id","required":true,"schema":{"type":"integer"}},{"name":"name","in":"query","description":"Partial name search","schema":{"type":"string"}},{"name":"status","in":"query","description":"Status of members","schema":{"type":"string","default":"all","enum":["all","leader","member"]}},{"name":"exclude_lau","in":"query","description":"Exclude limited access users","schema":{"type":"boolean"}},{"name":"added_before","in":"query","description":"Include group members who were added to the group before this date","schema":{"type":"string","format":"date-time"}},{"name":"added_after","in":"query","description":"Include group members who were added to the group after this date","schema":{"type":"string","format":"date-time"}},{"$ref":"#/components/parameters/PerPage"},{"$ref":"#/components/parameters/Page"}],"responses":{"200":{"description":"Group members list","headers":{"X-Offset":{"$ref":"#/components/headers/X-Offset"},"X-Per-Page":{"$ref":"#/components/headers/X-Per-Page"},"X-Total-Pages":{"$ref":"#/components/headers/X-Total-Pages"},"X-Page":{"$ref":"#/components/headers/X-Page"}},"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","allOf":[{"$ref":"#/components/schemas/BasicIndividualGroupsProfileSerializer"},{"type":"object","properties":{"actions":{"type":"object","properties":{"can_view_individual":{"$ref":"#/components/schemas/Action"}}}}}]}}}}}}},"put":{"tags":["groups"],"summary":"Update individuals status in a group","security":[{"oauth2":["write:group_members"]}],"operationId":"updateGroupMembers","parameters":[{"name":"id","in":"path","description":"The group's id","required":true,"schema":{"type":"integer"}},{"name":"name","in":"query","description":"Partial name search","schema":{"type":"string"}},{"name":"status","in":"query","description":"Status of members","schema":{"type":"string","default":"all","enum":["all","leader","member"]}},{"name":"exclude_lau","in":"query","description":"Exclude limited access users","schema":{"type":"boolean"}}],"requestBody":{"description":"The individual ids and status to update","content":{"application/json":{"schema":{"type":"object","properties":{"individual_ids":{"type":"array","items":{"type":"integer"}},"status":{"type":"string","enum":["INVITED","REQUESTING","MEMBER","LEADER"]}}}}},"required":false},"responses":{"200":{"description":"The individuals added to the group","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BasicIndividualGroupsProfileSerializer"}}}}}},"x-codegen-request-body-name":"update group member status"},"post":{"tags":["groups"],"summary":"Add individuals to a group","security":[{"oauth2":["write:group_members"]}],"operationId":"addGroupMembers","parameters":[{"name":"id","in":"path","description":"The group's id","required":true,"schema":{"type":"integer"}},{"name":"name","in":"query","description":"Partial name search","schema":{"type":"string"}},{"name":"status","in":"query","description":"Status of members","schema":{"type":"string","default":"all","enum":["all","leader","member"]}},{"name":"exclude_lau","in":"query","description":"Exclude limited access users","schema":{"type":"boolean"}},{"$ref":"#/components/parameters/IndividualIds"}],"responses":{"200":{"description":"The individuals added to the group","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BasicIndividualGroupsProfileSerializer"}}}}}}},"delete":{"tags":["groups"],"summary":"Remove individuals from a group","security":[{"oauth2":["write:group_members"]}],"operationId":"deleteGroupMembers","parameters":[{"name":"id","in":"path","description":"The group's id","required":true,"schema":{"type":"integer"}},{"name":"name","in":"query","description":"Partial name search","schema":{"type":"string"}},{"name":"status","in":"query","description":"Status of members","schema":{"type":"string","default":"all","enum":["all","leader","member"]}},{"name":"exclude_lau","in":"query","description":"Exclude limited access users","schema":{"type":"boolean"}}],"requestBody":{"description":"The individual ids and status to update","content":{"application/json":{"schema":{"type":"object","properties":{"ids":{"type":"array","items":{"type":"integer"}}}}}},"required":false},"responses":{"200":{"description":"The individuals added to the group","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/RemoveBasicIndividualGroupsProfileSerializer"}}}}}},"x-codegen-request-body-name":"update group member status"}},"/groups/{group_id}/members/roles":{"put":{"tags":["groups"],"summary":"Update a group member's primary role and/or coach/director flags atomically","description":"Single endpoint for the \"Change Roles\" modal. Applies a primary role change (LEADER, MEMBER, MAIN_LEADER, or NONE for removal) and/or coach/director column toggles in one transaction, recording `history_groups` rows for every transition (status_id 110 for coach, 120 for director). At least one of `primary_role`, `is_coach`, or `is_director` must be provided. `is_coach`/`is_director` are single-individual only.\n\nAdministrative-DB groups (`interaction_type='d'`) skip `history_groups` writes for coach/director column changes — these synthetic groups don't keep individual involvement timelines, matching the legacy `remove_director` behavior in `group_manage_list.php`.\n","security":[{"oauth2":["write:group_members"]}],"operationId":"updateGroupMemberRoles","parameters":[{"name":"group_id","in":"path","description":"The group's id","required":true,"schema":{"type":"integer"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["individual_ids"],"properties":{"individual_ids":{"type":"array","items":{"type":"integer"},"minItems":1},"primary_role":{"type":"string","enum":["LEADER","MEMBER","MAIN_LEADER","NONE"],"description":"LEADER/MEMBER update individual_groups.status_id; MAIN_LEADER promotes the individual to group owner; NONE removes the individual from individual_groups while leaving any coach_id/director_id column pointing at them intact (use with `is_coach=false`/`is_director=false` to clear those too).\n"},"is_coach":{"type":"boolean","description":"Set or clear groups.coach_id (single-individual only)"},"is_director":{"type":"boolean","description":"Set or clear groups.director_id (single-individual only)"}}}}}},"responses":{"200":{"description":"Roles updated successfully"},"400":{"description":"Validation error (e.g. multi-individual leadership flag, no fields provided)"},"403":{"description":"Caller lacks permission for the requested change"},"404":{"description":"Group not found, or operation not valid for this group (e.g. system group removal)"}},"x-codegen-request-body-name":"update group member roles"}},"/groups/{id}/requesting":{"get":{"tags":["groups"],"summary":"Get individual's requesting to join the group","security":[{"oauth2":["read:group_members"]}],"operationId":"getIndividualsRequestingToJoinGroup","parameters":[{"name":"id","in":"path","description":"The group's id","required":true,"schema":{"type":"integer"}},{"$ref":"#/components/parameters/PerPage"},{"$ref":"#/components/parameters/Page"}],"responses":{"200":{"description":"Individuals requesting to join the group","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BasicIndividualGroupsProfileSerializer"}}}}}}}},"/groups/{id}/photo":{"post":{"tags":["groups"],"summary":"Update group's photo","security":[{"oauth2":["write:groups"]}],"operationId":"updateGroupPhoto","parameters":[{"name":"id","in":"path","description":"The group's id","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"required":["photo"],"properties":{"photo":{"type":"string","description":"Group Photo (will crop to a 16:9 image)","format":"binary"}}}}},"required":true},"responses":{"200":{"description":"Returns the full group serializer","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FullGroupSerializer"}}}}}},"delete":{"tags":["groups"],"summary":"Remove group's photo","security":[{"oauth2":["write:groups"]}],"operationId":"deleteGroupPhoto","parameters":[{"name":"id","in":"path","description":"The group's id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Empty response","content":{}}}}},"/groups/{id}/messages":{"get":{"tags":["groups"],"summary":"Get group messages","security":[{"oauth2":["read:messages"]}],"operationId":"getGroupMessages","parameters":[{"name":"id","in":"path","description":"The group's id","required":true,"schema":{"type":"integer"}},{"name":"leaders_only","in":"query","description":"Type of messages to get","schema":{"type":"boolean"}},{"$ref":"#/components/parameters/PerPage"},{"$ref":"#/components/parameters/Page"}],"responses":{"200":{"description":"List of Group Messages","headers":{"X-Offset":{"$ref":"#/components/headers/X-Offset"},"X-Per-Page":{"$ref":"#/components/headers/X-Per-Page"},"X-Total-Pages":{"$ref":"#/components/headers/X-Total-Pages"},"X-Page":{"$ref":"#/components/headers/X-Page"}},"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/GroupMessageSerializer"}}}}},"401":{"$ref":"#/components/responses/NotAuthenticated"},"403":{"$ref":"#/components/responses/NotAuthorized"}}}},"/groups/{id}/special_days":{"get":{"tags":["groups"],"summary":"Get the group special days","security":[{"oauth2":["read:group_members"]}],"operationId":"getGroupSpecialDays","parameters":[{"name":"id","in":"path","description":"The group's id","required":true,"schema":{"type":"integer"}},{"$ref":"#/components/parameters/PerPage"},{"$ref":"#/components/parameters/Page"}],"responses":{"200":{"description":"List of group special days","headers":{"X-Offset":{"$ref":"#/components/headers/X-Offset"},"X-Per-Page":{"$ref":"#/components/headers/X-Per-Page"},"X-Total-Pages":{"$ref":"#/components/headers/X-Total-Pages"},"X-Page":{"$ref":"#/components/headers/X-Page"}},"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/GroupSpecialDaysSerializer"}}}}},"401":{"$ref":"#/components/responses/NotAuthenticated"},"403":{"$ref":"#/components/responses/NotAuthorized"},"404":{"$ref":"#/components/responses/NotFound"}}}},"/individuals/{id}/groups":{"get":{"tags":["groups"],"summary":"Get individuals groups","security":[{"oauth2":["read:individual_groups"]}],"operationId":"getIndividualsGroups","parameters":[{"name":"id","in":"path","description":"The individual's id","required":true,"schema":{"type":"integer"}},{"name":"interaction_type","in":"query","description":"groups with a specific interaction type","style":"form","explode":true,"schema":{"type":"array","items":{"$ref":"#/components/schemas/GroupInteractionType"}}},{"name":"status","in":"query","description":"individual status in groups, defaults to MEMBER and LEADER","style":"form","explode":true,"schema":{"type":"array","items":{"$ref":"#/components/schemas/IndividualGroupStatus"}}},{"name":"ids","in":"query","description":"restrict group list to only those in the provided ids","style":"form","explode":true,"schema":{"type":"array","items":{"type":"integer"}}},{"name":"inactive","in":"query","description":"get inactive groups or not","schema":{"type":"boolean"}},{"name":"with_leaders","in":"query","description":"When `true`, each item's `group` object includes a `leaders`\narray resolving the group's owner / coach / director ids to\nfull individual references (deduped, missing roles omitted).\nUsed by the Groups List \"My Group Leaders\" sidebar so the\nroster is available without N+1 calls to `/groups/{id}/leaders`.\nDefault `false` — existing consumers see no shape change.\n","schema":{"type":"boolean"}},{"$ref":"#/components/parameters/PerPage"},{"$ref":"#/components/parameters/Page"}],"responses":{"200":{"description":"List of Groups","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BasicIndividualGroupsProfileWithGroupSerializer"}}}}},"401":{"$ref":"#/components/responses/NotAuthenticated"},"403":{"$ref":"#/components/responses/NotAuthorized"},"404":{"$ref":"#/components/responses/NotFound"}}}},"/individuals/{id}/groups/{group_id}":{"get":{"tags":["groups","individuals"],"summary":"Get individual's group membership details","security":[{"oauth2":["read:individual_groups"]}],"operationId":"getIndividualsGroup","parameters":[{"name":"id","in":"path","description":"The individual's id","required":true,"schema":{"type":"integer"}},{"name":"group_id","in":"path","description":"The group's id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"The group","content":{"*/*":{"schema":{"$ref":"#/components/schemas/BasicIndividualGroupsProfileWithGroupSerializer"}}}},"401":{"$ref":"#/components/responses/NotAuthenticated"},"403":{"$ref":"#/components/responses/NotAuthorized"},"404":{"$ref":"#/components/responses/NotFound"}}},"put":{"tags":["groups","individuals"],"summary":"Update individual's group membership details","security":[{"oauth2":["write:individual_groups"]}],"operationId":"updateIndividualsGroup","parameters":[{"name":"id","in":"path","description":"The individual's id","required":true,"schema":{"type":"integer"}},{"name":"group_id","in":"path","description":"The group's id","required":true,"schema":{"type":"integer"}}],"requestBody":{"description":"The individuals communication preferences","content":{"*/*":{"schema":{"type":"object","properties":{"receive_sms":{"type":"boolean"}}}}},"required":false},"responses":{"200":{"description":"The group","content":{"*/*":{"schema":{"$ref":"#/components/schemas/BasicIndividualGroupsProfileWithGroupSerializer"}}}},"401":{"$ref":"#/components/responses/NotAuthenticated"},"403":{"$ref":"#/components/responses/NotAuthorized"},"404":{"$ref":"#/components/responses/NotFound"}},"x-codegen-request-body-name":"update individuals group request"},"post":{"tags":["groups","individuals"],"summary":"Join a group","security":[{"oauth2":["write:individual_groups"]}],"operationId":"joinGroup","parameters":[{"name":"id","in":"path","description":"The individual's id","required":true,"schema":{"type":"integer"}},{"name":"group_id","in":"path","description":"The group's id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"The group","content":{"*/*":{"schema":{"$ref":"#/components/schemas/BasicIndividualGroupsProfileWithGroupSerializer"}}}},"401":{"$ref":"#/components/responses/NotAuthenticated"},"403":{"$ref":"#/components/responses/NotAuthorized"},"404":{"$ref":"#/components/responses/NotFound"}}},"delete":{"tags":["groups","individuals"],"summary":"Leave a group","security":[{"oauth2":["write:individual_groups"]}],"description":"If you need to remove an individual from multiple groups at once, use the [`/individuals/{id}/groups/bulk`](#/groups/updateIndividualGroups) API instead.\n","operationId":"leaveGroup","parameters":[{"name":"id","in":"path","description":"The individual's id","required":true,"schema":{"type":"integer"}},{"name":"group_id","in":"path","description":"The group's id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Empty response","content":{}},"401":{"$ref":"#/components/responses/NotAuthenticated"},"403":{"$ref":"#/components/responses/NotAuthorized"},"404":{"$ref":"#/components/responses/NotFound"}}}},"/individuals/{id}/groups/bulk":{"put":{"tags":["groups","individuals"],"summary":"Mass remove individual from multiple groups","security":[{"oauth2":["write:individual_groups"]}],"operationId":"updateIndividualGroups","parameters":[{"name":"id","in":"path","description":"The individual's id","example":8,"required":true,"schema":{"type":"integer"}}],"requestBody":{"$ref":"#/components/requestBodies/UpdateIndividualGroupsRequest","required":true},"responses":{"200":{"description":"The results of the remove action. The response contains the result for every requested `groupId`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateIndividualGroupsOutputSerializer"}}}},"400":{"description":"Validation of the input data has failed, for example an invalid `action` or a non-existent `groupId` is provided","content":{}},"404":{"description":"The individual is not found","content":{}}}}},"/individuals/{id}/history/groups":{"get":{"tags":["groups"],"summary":"Get individuals groups history","security":[{"oauth2":["read:individual_groups"]}],"operationId":"getIndividualsGroupsHistory","parameters":[{"name":"id","in":"path","description":"The individual's id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"List of Groups","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/IndividualGroupsHistorySerializer"}}}}},"401":{"$ref":"#/components/responses/NotAuthenticated"},"403":{"$ref":"#/components/responses/NotAuthorized"},"404":{"$ref":"#/components/responses/NotFound"}}}},"/messages/{id}":{"get":{"tags":["groups","messages"],"summary":"Get the group message details","security":[{"oauth2":["read:messages"]}],"operationId":"getMessage","parameters":[{"name":"id","in":"path","description":"The message id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"The message details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/GroupMessageSerializer"}}}},"401":{"$ref":"#/components/responses/NotAuthenticated"},"403":{"$ref":"#/components/responses/NotAuthorized"},"404":{"$ref":"#/components/responses/NotFound"}}},"put":{"tags":["groups","messages"],"summary":"Update group message","security":[{"oauth2":["write:messages"]}],"operationId":"updateMessage","parameters":[{"name":"id","in":"path","description":"The message id","required":true,"schema":{"type":"integer"}}],"requestBody":{"description":"The group message details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/UpdateGroupMessageRequest"}}},"required":false},"responses":{"200":{"description":"The message details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/GroupMessageSerializer"}}}},"401":{"$ref":"#/components/responses/NotAuthenticated"},"403":{"$ref":"#/components/responses/NotAuthorized"},"404":{"$ref":"#/components/responses/NotFound"}},"x-codegen-request-body-name":"updateGroupMessageRequest"},"delete":{"tags":["groups","messages"],"summary":"Remove group message","security":[{"oauth2":["delete:messages"]}],"operationId":"deleteMessage","parameters":[{"name":"id","in":"path","description":"The message id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Empty response","content":{}},"401":{"$ref":"#/components/responses/NotAuthenticated"},"403":{"$ref":"#/components/responses/NotAuthorized"},"404":{"$ref":"#/components/responses/NotFound"}}}},"/messages/{id}/comments":{"get":{"tags":["groups","messages"],"summary":"Get the group message comments","security":[{"oauth2":["read:messages"]}],"operationId":"getMessageComments","parameters":[{"name":"id","in":"path","description":"The message id","required":true,"schema":{"type":"integer"}},{"name":"sort_by","in":"query","description":"The sort direction","schema":{"type":"string","default":"OLDEST","enum":["NEWEST","OLDEST"]}}],"responses":{"200":{"description":"The message comments list","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/GroupMessageCommentSerializer"}}}}},"401":{"$ref":"#/components/responses/NotAuthenticated"},"403":{"$ref":"#/components/responses/NotAuthorized"},"404":{"$ref":"#/components/responses/NotFound"}}},"post":{"tags":["groups","messages"],"summary":"Create group message comment","security":[{"oauth2":["write:messages"]}],"operationId":"createMessageComment","parameters":[{"name":"id","in":"path","description":"The message id","required":true,"schema":{"type":"integer"}},{"name":"sort_by","in":"query","description":"The sort direction","schema":{"type":"string","default":"OLDEST","enum":["NEWEST","OLDEST"]}}],"requestBody":{"description":"The group message comment details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/CreateGroupMessageCommentRequest"}}},"required":false},"responses":{"200":{"description":"The message comment details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/GroupMessageCommentSerializer"}}}},"401":{"$ref":"#/components/responses/NotAuthenticated"},"403":{"$ref":"#/components/responses/NotAuthorized"},"404":{"$ref":"#/components/responses/NotFound"}},"x-codegen-request-body-name":"createGroupMessageCommentRequest"}},"/messages/{id}/comments/{comment_id}":{"put":{"tags":["groups","messages"],"summary":"Update group message comment","security":[{"oauth2":["write:messages"]}],"operationId":"updateMessageComment","parameters":[{"name":"id","in":"path","description":"The message id","required":true,"schema":{"type":"integer"}},{"name":"comment_id","in":"path","description":"The comment id","required":true,"schema":{"type":"integer"}}],"requestBody":{"description":"The group message comment details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/UpdateGroupMessageCommentRequest"}}},"required":false},"responses":{"200":{"description":"The message comment details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/GroupMessageCommentSerializer"}}}},"401":{"$ref":"#/components/responses/NotAuthenticated"},"403":{"$ref":"#/components/responses/NotAuthorized"},"404":{"$ref":"#/components/responses/NotFound"}},"x-codegen-request-body-name":"updateGroupMessageCommentRequest"},"delete":{"tags":["groups","messages"],"summary":"Remove group message comment","security":[{"oauth2":["delete:messages"]}],"operationId":"deleteMessageComment","parameters":[{"name":"id","in":"path","description":"The message id","required":true,"schema":{"type":"integer"}},{"name":"comment_id","in":"path","description":"The comment id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Empty response","content":{}},"401":{"$ref":"#/components/responses/NotAuthenticated"},"403":{"$ref":"#/components/responses/NotAuthorized"},"404":{"$ref":"#/components/responses/NotFound"}}}},"/group_types":{"get":{"tags":["groups"],"summary":"Get Group Types","security":[{"oauth2":["read:groups"]}],"operationId":"getGroupTypes","parameters":[{"$ref":"#/components/parameters/PerPage"},{"$ref":"#/components/parameters/Page"},{"$ref":"#/components/parameters/UsedByGroupsFilter"}],"responses":{"200":{"description":"List of Group Types","headers":{"X-Offset":{"$ref":"#/components/headers/X-Offset"},"X-Per-Page":{"$ref":"#/components/headers/X-Per-Page"},"X-Total-Pages":{"$ref":"#/components/headers/X-Total-Pages"},"X-Page":{"$ref":"#/components/headers/X-Page"}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/IdName"}}}}}}}},"/group_areas":{"get":{"tags":["groups"],"summary":"Get Group Areas of Town","security":[{"oauth2":["read:groups"]}],"operationId":"getGroupAreas","parameters":[{"$ref":"#/components/parameters/PerPage"},{"$ref":"#/components/parameters/Page"},{"$ref":"#/components/parameters/UsedByGroupsFilter"}],"responses":{"200":{"description":"List of Group Areas of Town","headers":{"X-Offset":{"$ref":"#/components/headers/X-Offset"},"X-Per-Page":{"$ref":"#/components/headers/X-Per-Page"},"X-Total-Pages":{"$ref":"#/components/headers/X-Total-Pages"},"X-Page":{"$ref":"#/components/headers/X-Page"}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/IdName"}}}}}}}},"/group_meet_days":{"get":{"tags":["groups"],"summary":"Get Group Meet Days","security":[{"oauth2":["read:groups"]}],"operationId":"getGroupMeetDays","parameters":[{"$ref":"#/components/parameters/PerPage"},{"$ref":"#/components/parameters/Page"},{"$ref":"#/components/parameters/UsedByGroupsFilter"}],"responses":{"200":{"description":"List of Group Meet Days","headers":{"X-Offset":{"$ref":"#/components/headers/X-Offset"},"X-Per-Page":{"$ref":"#/components/headers/X-Per-Page"},"X-Total-Pages":{"$ref":"#/components/headers/X-Total-Pages"},"X-Page":{"$ref":"#/components/headers/X-Page"}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/IdName"}}}}}}}},"/group_meet_times":{"get":{"tags":["groups"],"summary":"Get Group Meet Times","security":[{"oauth2":["read:groups"]}],"operationId":"getGroupMeetTimes","parameters":[{"$ref":"#/components/parameters/PerPage"},{"$ref":"#/components/parameters/Page"},{"$ref":"#/components/parameters/UsedByGroupsFilter"}],"responses":{"200":{"description":"List of Meet Times","headers":{"X-Offset":{"$ref":"#/components/headers/X-Offset"},"X-Per-Page":{"$ref":"#/components/headers/X-Per-Page"},"X-Total-Pages":{"$ref":"#/components/headers/X-Total-Pages"},"X-Page":{"$ref":"#/components/headers/X-Page"}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/IdName"}}}}}}}},"/groups/{id}/attendance_groupings":{"get":{"tags":["groups"],"summary":"Get group's attendance groupings","security":[{"oauth2":["write:groups"]}],"operationId":"getGroupAttendanceGroupings","parameters":[{"name":"id","in":"path","description":"The group's id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"List of group's attendance groupings","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/GroupAttendanceGroupingsSerializer"}}}}}}}},"/groups/{id}/attendance_groupings/sync":{"post":{"tags":["groups"],"summary":"Sync group's attendance groupings","security":[{"oauth2":["write:groups"]}],"operationId":"syncGroupAttendanceGroupings","parameters":[{"name":"id","in":"path","description":"The group's id","required":true,"schema":{"type":"integer"}}],"requestBody":{"description":"Attendance Groupings to add/remove","content":{"application/json":{"schema":{"type":"object","properties":{"adds":{"type":"array","items":{"type":"integer","example":123}},"removes":{"type":"array","items":{"type":"integer","example":321}}}}}},"required":false},"responses":{"201":{"description":"List of group's attendance groupings","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/GroupAttendanceGroupingsSerializer"}}}}}},"x-codegen-request-body-name":"syncGroupAttendanceGroupingRequest"}},"/individuals/{id}/history":{"get":{"tags":["individuals"],"summary":"Gets recent edits associated with the individual","security":[{"oauth2":["read:individuals"]}],"operationId":"getIndividualHistory","parameters":[{"name":"id","in":"path","description":"The individual's id","required":true,"schema":{"type":"integer"}},{"$ref":"#/components/parameters/PerPage"},{"$ref":"#/components/parameters/Page"}],"responses":{"200":{"description":"Returns an array of individual history serializers","headers":{"X-Offset":{"$ref":"#/components/headers/X-Offset"},"X-Per-Page":{"$ref":"#/components/headers/X-Per-Page"},"X-Total-Pages":{"$ref":"#/components/headers/X-Total-Pages"},"X-Page":{"$ref":"#/components/headers/X-Page"}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/IndividualHistorySerializer"}}}}},"401":{"$ref":"#/components/responses/NotAuthenticated"},"403":{"$ref":"#/components/responses/NotAuthorized"},"404":{"$ref":"#/components/responses/NotFound"}}}},"/individuals/{id}/messages":{"get":{"tags":["individuals"],"summary":"Gets messages sent or received by an individual","security":[{"oauth2":["read:individual_messages"]}],"operationId":"getIndividualMessages","parameters":[{"name":"id","in":"path","description":"The individual's id","required":true,"schema":{"type":"integer"}},{"$ref":"#/components/parameters/PerPage"},{"$ref":"#/components/parameters/Page"}],"responses":{"200":{"description":"Returns an array of individual message serializers","headers":{"X-Offset":{"$ref":"#/components/headers/X-Offset"},"X-Per-Page":{"$ref":"#/components/headers/X-Per-Page"},"X-Total-Pages":{"$ref":"#/components/headers/X-Total-Pages"},"X-Page":{"$ref":"#/components/headers/X-Page"}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/IndividualMessageWithRecentRepliesSerializer"}}}}},"401":{"$ref":"#/components/responses/NotAuthenticated"},"403":{"$ref":"#/components/responses/NotAuthorized"},"404":{"$ref":"#/components/responses/NotFound"}}},"post":{"tags":["individuals"],"summary":"Sends an individual a message","security":[{"oauth2":["write:individual_messages"]}],"operationId":"sendIndividualMessage","parameters":[{"name":"id","in":"path","description":"The individual's id","required":true,"schema":{"type":"integer"}}],"requestBody":{"description":"The message to send an individual","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IndividualMessageRequestSerializer"}}},"required":false},"responses":{"201":{"description":"Returns the individual message serializer","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IndividualMessageSerializer"}}}}},"x-codegen-request-body-name":"individualMessage"}},"/individual_messages/{id}":{"put":{"tags":["individuals"],"summary":"Edit an individual a message","security":[{"oauth2":["write:individual_messages"]}],"operationId":"updateIndividualMessage","parameters":[{"name":"id","in":"path","description":"The individual message id","required":true,"schema":{"type":"integer"}}],"requestBody":{"description":"The message to send an individual","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IndividualMessageRequestSerializer"}}},"required":false},"responses":{"201":{"description":"Returns the individual message serializer","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IndividualMessageSerializer"}}}}},"x-codegen-request-body-name":"individualMessage"},"delete":{"tags":["individuals"],"summary":"Deletes a message","security":[{"oauth2":["write:individual_messages"]}],"operationId":"deleteIndividualMessage","parameters":[{"name":"id","in":"path","description":"The individual message id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Empty response","content":{}},"401":{"$ref":"#/components/responses/NotAuthenticated"},"403":{"$ref":"#/components/responses/NotAuthorized"},"404":{"$ref":"#/components/responses/NotFound"}}}},"/individual_message_replies/{id}":{"put":{"tags":["individuals"],"summary":"Edit an individual a message reply","security":[{"oauth2":["write:individual_messages"]}],"operationId":"updateIndividualMessageReply","parameters":[{"name":"id","in":"path","description":"The individual message reply id","required":true,"schema":{"type":"integer"}}],"requestBody":{"description":"The reply to send to an individual","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IndividualMessageReplyRequestSerializer"}}},"required":false},"responses":{"201":{"description":"Returns the individual message reply serializer","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IndividualMessageReplySerializer"}}}}},"x-codegen-request-body-name":"individualMessageReply"},"delete":{"tags":["individuals"],"summary":"Deletes a message reply","security":[{"oauth2":["write:individual_messages"]}],"operationId":"deleteIndividualMessageReply","parameters":[{"name":"id","in":"path","description":"The individual message reply id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Empty response","content":{}},"401":{"$ref":"#/components/responses/NotAuthenticated"},"403":{"$ref":"#/components/responses/NotAuthorized"},"404":{"$ref":"#/components/responses/NotFound"}}}},"/individual_messages/{id}/replies":{"get":{"tags":["individuals"],"summary":"Gets messages replies for an individual message","security":[{"oauth2":["read:individual_messages"]}],"operationId":"getIndividualMessageReplies","parameters":[{"name":"id","in":"path","description":"The individual message id","required":true,"schema":{"type":"integer"}},{"$ref":"#/components/parameters/PerPage"},{"$ref":"#/components/parameters/Page"}],"responses":{"200":{"description":"Returns an array of individual message reply serializers","headers":{"X-Offset":{"$ref":"#/components/headers/X-Offset"},"X-Per-Page":{"$ref":"#/components/headers/X-Per-Page"},"X-Total-Pages":{"$ref":"#/components/headers/X-Total-Pages"},"X-Page":{"$ref":"#/components/headers/X-Page"}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/IndividualMessageReplySerializer"}}}}},"401":{"$ref":"#/components/responses/NotAuthenticated"},"403":{"$ref":"#/components/responses/NotAuthorized"},"404":{"$ref":"#/components/responses/NotFound"}}},"post":{"tags":["individuals"],"summary":"Sends a reply to an individual message","security":[{"oauth2":["write:individual_messages"]}],"operationId":"sendIndividualMessageReply","parameters":[{"name":"id","in":"path","description":"The individual message id","required":true,"schema":{"type":"integer"}}],"requestBody":{"description":"The reply to send to an individual","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IndividualMessageReplyRequestSerializer"}}},"required":false},"responses":{"201":{"description":"Returns the individual message reply serializer","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IndividualMessageReplySerializer"}}}}},"x-codegen-request-body-name":"individualMessageReply"}},"/individuals/metrics/duplicates":{"get":{"tags":["individuals","metrics"],"summary":"Get individual duplicate metrics","security":[{"oauth2":["read:individuals_metrics"]}],"operationId":"getIndividualMetricsDuplicates","responses":{"200":{"description":"Count of individuals who are possible duplicates","content":{"application/json":{"schema":{"type":"object","properties":{"possible":{"type":"integer","description":"The total number of profiles that have a possible duplicate"}}}}}},"401":{"$ref":"#/components/responses/NotAuthenticated"},"403":{"$ref":"#/components/responses/NotAuthorized"}}}},"/individuals/{id}/metrics/serving":{"get":{"tags":["individuals","metrics"],"summary":"Get individual serving metrics","security":[{"oauth2":["read:individuals_metrics"]}],"operationId":"getIndividualMetricsServing","parameters":[{"name":"id","in":"path","description":"The individual's id","required":true,"schema":{"type":"integer"}},{"name":"start","in":"query","description":"Starting date for data (max range to end date is 12 months)","schema":{"type":"string","format":"date"}},{"name":"end","in":"query","description":"Ending date for data (max range from start date is 12 months)","schema":{"type":"string","format":"date"}}],"responses":{"200":{"description":"List of Serving Metrics grouped into month intervals","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BasicIndividualMetricSerializer"}}}}},"400":{"$ref":"#/components/responses/NotValid"},"401":{"$ref":"#/components/responses/NotAuthenticated"},"403":{"$ref":"#/components/responses/NotAuthorized"}}}},"/individuals/{id}/metrics/serving/summary":{"get":{"tags":["individuals","metrics"],"summary":"Get occurrence of first and latest individual serving metrics","security":[{"oauth2":["read:individuals_metrics"]}],"operationId":"getIndividualMetricsServingRange","parameters":[{"name":"id","in":"path","description":"The individual's id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Details of individual's first and latest serving metrics","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BasicIndividualMetricSummarySerializer"}}}}},"400":{"$ref":"#/components/responses/NotValid"},"401":{"$ref":"#/components/responses/NotAuthenticated"},"403":{"$ref":"#/components/responses/NotAuthorized"}}}},"/individuals/{id}/metrics/attendance":{"get":{"tags":["individuals","metrics"],"summary":"Get individual attendance metrics","security":[{"oauth2":["read:individuals_metrics"]}],"operationId":"getIndividualMetricsAttendance","parameters":[{"name":"id","in":"path","description":"The individual's id","required":true,"schema":{"type":"integer"}},{"name":"start","in":"query","description":"Starting date for data (max range to end date is 12 months)","schema":{"type":"string","format":"date"}},{"name":"end","in":"query","description":"Ending date for data (max range from start date is 12 months)","schema":{"type":"string","format":"date"}}],"responses":{"200":{"description":"List of Attendance Metrics grouped into month intervals","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BasicIndividualMetricSerializer"}}}}},"400":{"$ref":"#/components/responses/NotValid"},"401":{"$ref":"#/components/responses/NotAuthenticated"},"403":{"$ref":"#/components/responses/NotAuthorized"}}}},"/individuals/{id}/metrics/attendance/summary":{"get":{"tags":["individuals","metrics"],"summary":"Get occurrence of first and latest individual attendance metrics","security":[{"oauth2":["read:individuals_metrics"]}],"operationId":"getIndividualMetricsAttendanceRange","parameters":[{"name":"id","in":"path","description":"The individual's id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Details of individual's first and latest attendance metrics","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BasicIndividualMetricSummarySerializer"}}}}},"400":{"$ref":"#/components/responses/NotValid"},"401":{"$ref":"#/components/responses/NotAuthenticated"},"403":{"$ref":"#/components/responses/NotAuthorized"}}}},"/individuals/{id}/metrics/giving":{"get":{"tags":["individuals","metrics"],"summary":"Get individual giving metrics","security":[{"oauth2":["read:individuals_metrics"]}],"operationId":"getIndividualMetricsGiving","parameters":[{"name":"id","in":"path","description":"The individual's id","required":true,"schema":{"type":"integer"}},{"name":"start","in":"query","description":"Starting date for data (max range to end date is 12 months)","schema":{"type":"string","format":"date"}},{"name":"end","in":"query","description":"Ending date for data (max range from start date is 12 months)","schema":{"type":"string","format":"date"}}],"responses":{"200":{"description":"List of Giving Metrics grouped into month intervals","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BasicIndividualMetricSerializer"}}}}},"400":{"$ref":"#/components/responses/NotValid"},"401":{"$ref":"#/components/responses/NotAuthenticated"},"403":{"$ref":"#/components/responses/NotAuthorized"}}}},"/individuals/{id}/metrics/giving/summary":{"get":{"tags":["individuals","metrics"],"summary":"Get occurrence of first and latest individual giving metrics","security":[{"oauth2":["read:individuals_metrics"]}],"operationId":"getIndividualMetricsGivingRange","parameters":[{"name":"id","in":"path","description":"The individual's id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Details of individual's first and latest giving metrics","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BasicIndividualMetricSummarySerializer"}}}}},"400":{"$ref":"#/components/responses/NotValid"},"401":{"$ref":"#/components/responses/NotAuthenticated"},"403":{"$ref":"#/components/responses/NotAuthorized"}}}},"/families/{id}/metrics/giving":{"get":{"tags":["families","individuals","metrics"],"summary":"Get family giving metrics","security":[{"oauth2":["read:individuals_metrics"]}],"operationId":"getFamilyMetricsGiving","parameters":[{"name":"id","in":"path","description":"The family's id","required":true,"schema":{"type":"integer"}},{"name":"start","in":"query","description":"Starting date for data (max range to end date is 12 months)","schema":{"type":"string","format":"date"}},{"name":"end","in":"query","description":"Ending date for data (max range from start date is 12 months)","schema":{"type":"string","format":"date"}}],"responses":{"200":{"description":"List of Giving Metrics grouped into month intervals","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/FamilyGivingMetricSerializer"}}}}},"400":{"$ref":"#/components/responses/NotValid"},"401":{"$ref":"#/components/responses/NotAuthenticated"},"403":{"$ref":"#/components/responses/NotAuthorized"}}}},"/individuals/{id}/metrics/groups":{"get":{"tags":["individuals","metrics","groups"],"summary":"Get statistics about the individual's groups","security":[{"oauth2":["read:individuals_metrics"]}],"operationId":"getIndividualMetricsGroups","parameters":[{"name":"id","in":"path","description":"The individual's id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Details of individual's group statistics","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GroupMetricSerializer"}}}},"400":{"$ref":"#/components/responses/NotValid"},"401":{"$ref":"#/components/responses/NotAuthenticated"},"403":{"$ref":"#/components/responses/NotAuthorized"}}}},"/individuals/{id}/metrics/groups_history":{"get":{"tags":["individuals","metrics","groups"],"summary":"Get the individual's group totals for the past X months","security":[{"oauth2":["read:individuals_metrics"]}],"operationId":"getIndividualMetricsGroupsHistory","parameters":[{"name":"id","in":"path","description":"The individual's id","required":true,"schema":{"type":"integer"}},{"name":"months_ago","in":"query","description":"The number of months to return. Always includes the current month.","schema":{"type":"integer","default":12}}],"responses":{"200":{"description":"List of individual's group statistics by month for the past X months","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/GroupsHistoryMetricSerializer"}}}}},"400":{"$ref":"#/components/responses/NotValid"},"401":{"$ref":"#/components/responses/NotAuthenticated"},"403":{"$ref":"#/components/responses/NotAuthorized"}}}},"/individuals/{id}/metrics/form_responses":{"get":{"tags":["individuals","metrics","forms"],"summary":"Get aggregate information about an individual's form response history","security":[{"oauth2":["read:individuals_metrics"]}],"operationId":"getIndividualMetricsFormResponses","parameters":[{"name":"id","in":"path","description":"The individual's id","required":true,"schema":{"type":"integer"}},{"name":"recent_range","in":"query","description":"Form responses are considered \"recent\" if they were created within this many days of the current date","schema":{"type":"integer","default":90}}],"responses":{"200":{"description":"Individual's form metrics","content":{"application/json":{"schema":{"type":"object","properties":{"total":{"type":"integer","description":"The total form responses for the individual"},"unpaid":{"type":"integer","description":"The number of unpaid form responses for the individual"},"recent":{"type":"integer","description":"The number of recent form responses"},"recent_range":{"type":"integer","description":"The recent responses are those created within this many days of the current date"}}}}}},"400":{"$ref":"#/components/responses/NotValid"},"401":{"$ref":"#/components/responses/NotAuthenticated"},"403":{"$ref":"#/components/responses/NotAuthorized"}}}},"/individuals/{id}/metrics/process_queues":{"get":{"tags":["individuals","metrics","process queues"],"summary":"Get information about the individual's process queue activity","security":[{"oauth2":["read:individuals_metrics"]}],"operationId":"getIndividualMetricsProcessQueues","parameters":[{"name":"id","in":"path","description":"The individual's id","required":true,"schema":{"type":"integer"}},{"name":"queue_ids","in":"query","description":"The queue ids to filter for metrics","style":"form","explode":false,"schema":{"type":"array","items":{"type":"integer"}}}],"responses":{"200":{"description":"Details of individual's process queue activity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProcessQueueMetricSerializer"}}}},"400":{"$ref":"#/components/responses/NotValid"},"401":{"$ref":"#/components/responses/NotAuthenticated"},"403":{"$ref":"#/components/responses/NotAuthorized"}}}},"/individuals":{"get":{"tags":["individuals"],"summary":"Get individuals","security":[{"oauth2":["read:individuals"]}],"operationId":"getIndividuals","parameters":[{"name":"name","in":"query","description":"Partial search of names, phone numbers, and email addresses","schema":{"type":"string"}},{"name":"include_inactive","in":"query","description":"Include inactive individuals in the results","schema":{"type":"boolean"}},{"name":"exclude_limited_access_user","in":"query","description":"Exclude limited access users in the results","schema":{"type":"boolean","default":false}},{"name":"include_deceased","in":"query","description":"Include deceased individuals in the results. When true, the response will include a `deceased` date field for matching individuals.","schema":{"type":"boolean","default":false}},{"name":"include_unlisted","in":"query","description":"Whether or not to include unlisted individuals in the results. Not available to all users.","schema":{"type":"boolean","default":false}},{"name":"campus_scope","in":"query","description":"Filter individuals by campus scope. `all` returns individuals from all campuses, `current` returns only individuals at the caller's campus, `other` returns individuals at campuses other than the caller's.","schema":{"type":"string","enum":["all","current","other"],"default":"all"}},{"$ref":"#/components/parameters/PerPage"},{"$ref":"#/components/parameters/Page"}],"responses":{"200":{"description":"List of Individuals","headers":{"X-Offset":{"$ref":"#/components/headers/X-Offset"},"X-Per-Page":{"$ref":"#/components/headers/X-Per-Page"},"X-Total-Pages":{"$ref":"#/components/headers/X-Total-Pages"},"X-Page":{"$ref":"#/components/headers/X-Page"}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BasicIndividualProfileSerializer"}}}}},"401":{"$ref":"#/components/responses/NotAuthenticated"},"403":{"$ref":"#/components/responses/NotAuthorized"},"412":{"$ref":"#/components/responses/NotValid"}}},"post":{"tags":["individuals"],"summary":"Creates an individual","security":[{"oauth2":["write:individuals"]}],"operationId":"createIndividual","requestBody":{"description":"The individual to create/edit","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IndividualDetailsRequestSerializer"}}},"required":false},"responses":{"201":{"description":"Returns the full profile serializer of the individual","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IndividualDetailsWithCustomFieldsSerializer"}}}}},"x-codegen-request-body-name":"individual"}},"/individuals/duplicates":{"get":{"tags":["individuals"],"summary":"Get potential duplicates matching the giving query parameters","security":[{"oauth2":["read:individuals"]}],"description":"Matching Scores\n\nThe following table shows how parameters are compared to individual fields, and what the resulting score is when they are considered a match.\n\nThe soundex comparison is run on the first 4 characters of the two values.\n\nparameter   | individual field | comparison   | score\n---------   | ---------------- | ------------ | -----\nlast name   | last name        | exact match  | 10\nlast name   | last name        | soundex      | 7\nfirst name  | legal name       | exact match  | 5\nfirst name  | legal name       | soundex      | 4\nfirst name  | middle name      | exact match  | 5\nfirst name  | middle name      | soudex       | 4\nfirst name  | first name       | exact match  | 8\nfirst name  | first name       | sondex       | 5\nemail       | primary email    | exact match  | 16\nphone       | mobile phone     | exact match  | 15\nphone       | mobile phone     | last 7 match | 10\nphone       | home phone       | exact match  | 9\nphone       | home phone       | last 7 match | 6\nphone       | work phone       | exact match  | 9\nphone       | work phone       | last 7 match | 6\nstreet      | mailing street   | exact match  | 9\nstreet      | home street      | exact match  | 9\nstreet      | work street      | exact match  | 9\n","operationId":"getDuplicateIndividuals","parameters":[{"name":"last_name","in":"query","description":"Match the last name","schema":{"type":"string"}},{"name":"first_name","in":"query","description":"Match the first name","schema":{"type":"string"}},{"name":"family_id","in":"query","description":"Exclude family members in family","schema":{"type":"integer"}},{"name":"email","in":"query","description":"Match the email address","schema":{"type":"string"}},{"name":"emails","in":"query","description":"Match the primary email address","style":"form","explode":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"phone","in":"query","description":"Match the phone number","schema":{"type":"string"}},{"name":"phones","in":"query","description":"Match the phone numbers","style":"form","explode":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"streets","in":"query","description":"Match the mailing street","style":"form","explode":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"min_match_score","in":"query","description":"minimum score that will return a matching individual (min is 4, default is 16)","schema":{"type":"integer"}}],"responses":{"200":{"description":"List of Individuals","headers":{"X-Offset":{"$ref":"#/components/headers/X-Offset"},"X-Per-Page":{"$ref":"#/components/headers/X-Per-Page"},"X-Total-Pages":{"$ref":"#/components/headers/X-Total-Pages"},"X-Page":{"$ref":"#/components/headers/X-Page"}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DuplicateIndividualProfileSerializer"}}}}},"401":{"$ref":"#/components/responses/NotAuthenticated"},"403":{"$ref":"#/components/responses/NotAuthorized"},"412":{"$ref":"#/components/responses/NotValid"}}}},"/merge/individuals":{"get":{"tags":["individuals"],"summary":"Find profiles to merge with another profile","security":[{"oauth2":["read:individuals"]}],"operationId":"getMergeIndividuals","parameters":[{"name":"name","in":"query","description":"Partial first and last name search","schema":{"type":"string"}},{"$ref":"#/components/parameters/PerPage"},{"$ref":"#/components/parameters/Page"}],"responses":{"200":{"description":"List of Individuals","headers":{"X-Offset":{"$ref":"#/components/headers/X-Offset"},"X-Per-Page":{"$ref":"#/components/headers/X-Per-Page"},"X-Total-Pages":{"$ref":"#/components/headers/X-Total-Pages"},"X-Page":{"$ref":"#/components/headers/X-Page"}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/IndividualDetailsSerializer"}}}}},"401":{"$ref":"#/components/responses/NotAuthenticated"},"403":{"$ref":"#/components/responses/NotAuthorized"}}}},"/individuals/{id}":{"get":{"tags":["individuals"],"summary":"Get details about an individual","security":[{"oauth2":["read:individuals"]}],"operationId":"getIndividual","parameters":[{"name":"id","in":"path","description":"The individual's id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Individual Details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IndividualDetailsWithCustomFieldsSerializer"}}}}}},"put":{"tags":["individuals"],"summary":"Updates individual","security":[{"oauth2":["write:individuals"]}],"operationId":"updateIndividual","parameters":[{"name":"id","in":"path","description":"The individual's id","required":true,"schema":{"type":"integer"}}],"requestBody":{"description":"The individual to create/edit","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IndividualDetailsRequestSerializer"}}},"required":false},"responses":{"200":{"description":"Returns the full profile serializer of the individual","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IndividualDetailsWithCustomFieldsSerializer"}}}}},"x-codegen-request-body-name":"individual"}},"/individuals/{id}/duplicates":{"get":{"tags":["individuals"],"summary":"Get potential duplicates matching the giving query parameters","security":[{"oauth2":["read:individuals"]}],"operationId":"getDuplicateIndividualsForIndividual","parameters":[{"name":"id","in":"path","description":"The individual's id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Individual Details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DuplicateIndividualProfileSerializer"}}}}}}},"/individuals/{id}/ignored":{"get":{"tags":["individuals"],"summary":"Get profiles ingnored by an individual","security":[{"oauth2":["read:individuals"]}],"operationId":"getIgnoredIndividualsForIndividual","parameters":[{"name":"id","in":"path","description":"The individual's id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Individual ignored profile","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DuplicateIndividualProfileSerializer"}}}}}}},"/individuals/{id}/photo":{"post":{"tags":["individuals"],"summary":"Update individual's photo","security":[{"oauth2":["write:individuals"]}],"operationId":"updateIndividualPhoto","parameters":[{"name":"id","in":"path","description":"The individual's id","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"required":["photo"],"properties":{"photo":{"type":"string","description":"Profile Photo (will crop to a square image)","format":"binary"}}}}},"required":true},"responses":{"200":{"description":"Returns the full profile serializer of the individual","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IndividualDetailsSerializer"}}}}}},"delete":{"tags":["individuals"],"summary":"Remove individual's photo","security":[{"oauth2":["write:individuals"]}],"operationId":"deleteIndividualPhoto","parameters":[{"name":"id","in":"path","description":"The individual's id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Empty response","content":{}}}}},"/individuals/{winner_id}/merge":{"post":{"tags":["individuals"],"summary":"Merge the loser individual profile into the winner's","security":[{"oauth2":["write:individuals"]}],"operationId":"mergeIndividuals","parameters":[{"name":"winner_id","in":"path","description":"The winner individual's id","required":true,"schema":{"type":"integer"}}],"requestBody":{"description":"The losers and override params for the merge","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MergeMultipleIndividualsRequestSerializer"}}},"required":false},"responses":{"200":{"description":"Returns the full profile serializer of the individual","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IndividualDetailsSerializer"}}}}},"x-codegen-request-body-name":"merge"}},"/individuals/{id}/social_networks":{"get":{"tags":["individuals"],"summary":"Get an individual's social networks","security":[{"oauth2":["read:individuals"]}],"operationId":"getIndividualSocialNetworks","parameters":[{"name":"id","in":"path","description":"The individual's id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"The individual's social networks","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/IndividualsSocialNetworkSerializer"}}}}},"401":{"$ref":"#/components/responses/NotAuthenticated"},"403":{"$ref":"#/components/responses/NotAuthorized"}}},"post":{"tags":["individuals"],"summary":"Update an individual's social networks","security":[{"oauth2":["write:individuals"]}],"operationId":"updateIndividualSocialNetworks","parameters":[{"name":"id","in":"path","description":"The individual's id","required":true,"schema":{"type":"integer"}}],"requestBody":{"description":"Update an individuals social networks","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IndividualsSocialNetworkRequest"}}},"required":false},"responses":{"200":{"description":"The individual's social networks","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/IndividualsSocialNetworkSerializer"}}}}},"401":{"$ref":"#/components/responses/NotAuthenticated"},"403":{"$ref":"#/components/responses/NotAuthorized"}},"x-codegen-request-body-name":"updateIndividualsSocialNetworks"}},"/individuals/{id}/timelines":{"get":{"tags":["individuals"],"summary":"Get an individual's timeline","security":[{"oauth2":["read:individuals"]}],"operationId":"getIndividualsTimeline","parameters":[{"name":"id","in":"path","description":"The individual's id","required":true,"schema":{"type":"integer"}},{"$ref":"#/components/parameters/PerPage"},{"$ref":"#/components/parameters/Page"},{"name":"types","in":"query","description":"Types of items to return","style":"form","explode":true,"schema":{"type":"array","items":{"$ref":"#/components/schemas/TimelineTypes"}}},{"name":"latest_peer_only","in":"query","description":"when an item has peers, only return it if it is the latest peer","schema":{"type":"boolean","default":false}},{"name":"include_family","in":"query","description":"include family members in timeline entries","schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"Items on an individual's timeline","headers":{"X-Offset":{"$ref":"#/components/headers/X-Offset"},"X-Per-Page":{"$ref":"#/components/headers/X-Per-Page"},"X-Total-Pages":{"$ref":"#/components/headers/X-Total-Pages"},"X-Page":{"$ref":"#/components/headers/X-Page"}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/IndividualTimelineSerializer"}}}}},"401":{"$ref":"#/components/responses/NotAuthenticated"},"403":{"$ref":"#/components/responses/NotAuthorized"}}}},"/individuals/{id}/categorized_timelines":{"get":{"tags":["individuals"],"summary":"Get an individual's timeline by categories.","security":[{"oauth2":["read:individuals"]}],"operationId":"getIndividualsCategorizedTimelines","parameters":[{"$ref":"#/components/parameters/PerPage"},{"$ref":"#/components/parameters/Page"},{"name":"categories","in":"query","description":"Categories of items to return","style":"form","explode":true,"schema":{"type":"array","items":{"$ref":"#/components/schemas/TimelineCategories"}}},{"name":"id","in":"path","description":"The individual's id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Items on an individual's timeline","headers":{"X-Offset":{"$ref":"#/components/headers/X-Offset"},"X-Per-Page":{"$ref":"#/components/headers/X-Per-Page"},"X-Total-Pages":{"$ref":"#/components/headers/X-Total-Pages"},"X-Page":{"$ref":"#/components/headers/X-Page"}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/IndividualTimelineSerializer"}}}}},"401":{"$ref":"#/components/responses/NotAuthenticated"},"403":{"$ref":"#/components/responses/NotAuthorized"}}}},"/individuals/{id}/timelines/{context_type}/{context_id}":{"get":{"tags":["individuals"],"summary":"Get an individual's timeline by context","security":[{"oauth2":["read:individuals"]}],"operationId":"getIndividualsContextualTimelines","parameters":[{"name":"id","in":"path","description":"The individual's id","required":true,"schema":{"type":"integer"}},{"name":"context_type","in":"path","required":true,"schema":{"$ref":"#/components/schemas/TimelineTypes"}},{"name":"context_id","in":"path","description":"The context's id","required":true,"schema":{"type":"integer"}},{"$ref":"#/components/parameters/PerPage"},{"$ref":"#/components/parameters/Page"}],"responses":{"200":{"description":"Items on an individual's timeline","headers":{"X-Offset":{"$ref":"#/components/headers/X-Offset"},"X-Per-Page":{"$ref":"#/components/headers/X-Per-Page"},"X-Total-Pages":{"$ref":"#/components/headers/X-Total-Pages"},"X-Page":{"$ref":"#/components/headers/X-Page"}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/IndividualTimelineSerializer"}}}}},"401":{"$ref":"#/components/responses/NotAuthenticated"},"403":{"$ref":"#/components/responses/NotAuthorized"}}}},"/individuals/{id}/gifts":{"get":{"tags":["individuals"],"summary":"Get an individual's my fit gifts","security":[{"oauth2":["read:individuals"]}],"operationId":"getIndividualGifts","parameters":[{"name":"id","in":"path","description":"The individual's id","required":true,"schema":{"type":"integer"}},{"$ref":"#/components/parameters/PerPage"},{"$ref":"#/components/parameters/Page"}],"responses":{"200":{"description":"The individual's my fit gifts","headers":{"X-Offset":{"$ref":"#/components/headers/X-Offset"},"X-Per-Page":{"$ref":"#/components/headers/X-Per-Page"},"X-Total-Pages":{"$ref":"#/components/headers/X-Total-Pages"},"X-Page":{"$ref":"#/components/headers/X-Page"}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/IdName"}}}}},"401":{"$ref":"#/components/responses/NotAuthenticated"},"403":{"$ref":"#/components/responses/NotAuthorized"}}}},"/individuals/{id}/abilities":{"get":{"tags":["individuals"],"summary":"Get an individual's my fit abilities","security":[{"oauth2":["read:individuals"]}],"operationId":"getIndividualAbilities","parameters":[{"name":"id","in":"path","description":"The individual's id","required":true,"schema":{"type":"integer"}},{"$ref":"#/components/parameters/PerPage"},{"$ref":"#/components/parameters/Page"}],"responses":{"200":{"description":"The individual's my fit abilities","headers":{"X-Offset":{"$ref":"#/components/headers/X-Offset"},"X-Per-Page":{"$ref":"#/components/headers/X-Per-Page"},"X-Total-Pages":{"$ref":"#/components/headers/X-Total-Pages"},"X-Page":{"$ref":"#/components/headers/X-Page"}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/IdName"}}}}},"401":{"$ref":"#/components/responses/NotAuthenticated"},"403":{"$ref":"#/components/responses/NotAuthorized"}}}},"/individuals/{id}/passions":{"get":{"tags":["individuals"],"summary":"Get an individual's my fit passions","security":[{"oauth2":["read:individuals"]}],"operationId":"getIndividualPassions","parameters":[{"name":"id","in":"path","description":"The individual's id","required":true,"schema":{"type":"integer"}},{"$ref":"#/components/parameters/PerPage"},{"$ref":"#/components/parameters/Page"}],"responses":{"200":{"description":"The individual's my fit passions","headers":{"X-Offset":{"$ref":"#/components/headers/X-Offset"},"X-Per-Page":{"$ref":"#/components/headers/X-Per-Page"},"X-Total-Pages":{"$ref":"#/components/headers/X-Total-Pages"},"X-Page":{"$ref":"#/components/headers/X-Page"}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/IdName"}}}}},"401":{"$ref":"#/components/responses/NotAuthenticated"},"403":{"$ref":"#/components/responses/NotAuthorized"}}}},"/individuals/{id}/privacy_settings":{"get":{"tags":["individuals"],"summary":"Get an individual's privacy settings","security":[{"oauth2":["read:individuals_privacy_settings"]}],"operationId":"getIndividualPrivacySettings","parameters":[{"name":"id","in":"path","description":"The individual's id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"The individual's privacy settings","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IndividualPrivacySettingsSerializer"}}}},"401":{"$ref":"#/components/responses/NotAuthenticated"},"403":{"$ref":"#/components/responses/NotAuthorized"}}},"put":{"tags":["individuals"],"summary":"Update an individual's privacy settings","security":[{"oauth2":["write:individuals_privacy_settings"]}],"operationId":"updateIndividualPrivacySettings","parameters":[{"name":"id","in":"path","description":"The individual's id","required":true,"schema":{"type":"integer"}}],"requestBody":{"description":"The individual's privacy settings","content":{"*/*":{"schema":{"type":"object","properties":{"listed":{"type":"boolean"},"address_privacy_level":{"type":"string","enum":["LEADERSHIP_ONLY","GROUP_MEMBERS","EVERYONE"]},"anniversary_privacy_level":{"type":"string","enum":["LEADERSHIP_ONLY","GROUP_MEMBERS","EVERYONE"]},"birthday_privacy_level":{"type":"string","enum":["LEADERSHIP_ONLY","GROUP_MEMBERS","EVERYONE"]},"email_privacy_level":{"type":"string","enum":["LEADERSHIP_ONLY","GROUP_MEMBERS","EVERYONE"]},"phone_privacy_level":{"type":"string","enum":["LEADERSHIP_ONLY","GROUP_MEMBERS","EVERYONE"]}}}}},"required":false},"responses":{"200":{"description":"The individual's privacy settings","content":{"*/*":{"schema":{"$ref":"#/components/schemas/IndividualPrivacySettingsSerializer"}}}}},"x-codegen-request-body-name":"privacy_settings"}},"/families":{"get":{"tags":["families","individuals"],"summary":"Get families","security":[{"oauth2":["read:individuals"]}],"operationId":"getFamilies","parameters":[{"name":"last_name","in":"query","description":"Partial last name search","schema":{"type":"string"}},{"name":"email","in":"query","description":"Partial email search","schema":{"type":"string"}},{"name":"phone","in":"query","description":"Partial mobile phone search","schema":{"type":"string"}},{"$ref":"#/components/parameters/PerPage"},{"$ref":"#/components/parameters/Page"}],"responses":{"200":{"description":"List of Families","headers":{"X-Offset":{"$ref":"#/components/headers/X-Offset"},"X-Per-Page":{"$ref":"#/components/headers/X-Per-Page"},"X-Total-Pages":{"$ref":"#/components/headers/X-Total-Pages"},"X-Page":{"$ref":"#/components/headers/X-Page"}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BasicFamilyProfileSerializer"}}}}}}},"post":{"tags":["families","individuals"],"summary":"Create family","security":[{"oauth2":["write:individuals"]}],"operationId":"createFamily","requestBody":{"description":"The family to create","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateFamilyRequest"}}},"required":false},"responses":{"201":{"description":"The family","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FamilyProfileSerializer"}}}},"401":{"$ref":"#/components/responses/NotAuthenticated"},"403":{"$ref":"#/components/responses/NotAuthorized"},"404":{"$ref":"#/components/responses/NotFound"}},"x-codegen-request-body-name":"createFamilyRequest"}},"/families/{id}":{"get":{"tags":["families","individuals"],"summary":"Get family","security":[{"oauth2":["read:individuals"]}],"operationId":"getFamily","parameters":[{"name":"id","in":"path","description":"The family id","required":true,"schema":{"type":"integer"}},{"name":"include_deceased","in":"query","description":"Include deceased family members","schema":{"type":"boolean","default":false}},{"name":"include_inactive","in":"query","description":"Include inactive family members. Defaults to the value of include_deceased if not specified.","schema":{"type":"boolean"}}],"responses":{"200":{"description":"Family","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/FamilyProfileSerializer"}}}},"403":{"$ref":"#/components/responses/NotAuthorized"},"404":{"$ref":"#/components/responses/NotFound"}}},"put":{"tags":["families","individuals"],"summary":"Update family","security":[{"oauth2":["write:individuals"]}],"operationId":"updateFamily","parameters":[{"name":"id","in":"path","description":"The family id","required":true,"schema":{"type":"integer"}}],"requestBody":{"description":"The family details to update","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateFamilyRequest"}}},"required":false},"responses":{"200":{"description":"Family","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/FamilyProfileSerializer"}}}}},"x-codegen-request-body-name":"updateFamilyRequest"}},"/families/{id}/photo":{"post":{"tags":["families","individuals"],"summary":"Update family photo","security":[{"oauth2":["write:individuals"]}],"operationId":"updateFamilyPhoto","parameters":[{"name":"id","in":"path","description":"The family id","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"required":["photo"],"properties":{"photo":{"type":"string","description":"Family Photo (will crop to a 16:9 image)","format":"binary"}}}}},"required":true},"responses":{"200":{"description":"The family details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FamilyProfileSerializer"}}}}}},"delete":{"tags":["families","individuals"],"summary":"Remove family photo","security":[{"oauth2":["write:individuals"]}],"operationId":"deleteFamilyPhoto","parameters":[{"name":"id","in":"path","description":"The family id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Empty response","content":{}}}}},"/individuals/{id}/contact_info":{"put":{"tags":["individuals"],"summary":"Updates individual's contact info","security":[{"oauth2":["write:individuals"]}],"operationId":"updateIndividualContactInfo","parameters":[{"name":"id","in":"path","description":"The individual's id","required":true,"schema":{"type":"integer"}}],"requestBody":{"description":"The individual contact info to edit","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IndividualContactInfoRequestSerializer"}}},"required":false},"responses":{"200":{"description":"Returns the full profile serializer of the individual","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BasicIndividualProfileSerializer"}}}}},"x-codegen-request-body-name":"individual"}},"/individuals/background_checks":{"get":{"tags":["individuals","background checks"],"summary":"Get all background checks uploaded the vendor associated with that access token","security":[{"oauth2":["read:background_checks"]}],"operationId":"getBackgroundChecks","responses":{"200":{"description":"List of background checks","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BackgroundCheckSerializer"}}}}}}}},"/individuals/{id}/background_checks":{"get":{"tags":["individuals","background checks"],"summary":"Get all background checks for an individual by the vendor associated with the access token","security":[{"oauth2":["read:background_checks"]}],"operationId":"getIndividualBackgroundChecks","parameters":[{"name":"id","in":"path","description":"The individual's id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"List of background checks","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BackgroundCheckSerializer"}}}}}}},"post":{"tags":["individuals","background checks"],"summary":"Create a background check for an individual","security":[{"oauth2":["write:background_checks"]}],"operationId":"createBackgroundCheck","parameters":[{"name":"id","in":"path","description":"The individual's id","required":true,"schema":{"type":"integer"}}],"requestBody":{"description":"A background check object or array of background check objects","content":{"application/json":{"schema":{"type":"object","properties":{"package_name":{"type":"string"},"package_slug":{"type":"string"},"completed_date":{"type":"string","format":"date-time"},"report_status":{"type":"string","enum":["CLEAR","CONSIDER","DISPUTED","DISPUTED_CONSIDER","ENGAGED","SUSPENDED"]}}}}},"required":false},"responses":{"200":{"description":"Upload a background check","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BackgroundCheckSerializer"}}}}},"x-codegen-request-body-name":"createEditBackgroundCheck"}},"/individuals/background_checks/{id}":{"put":{"tags":["individuals","background checks"],"summary":"Update an existing background check","security":[{"oauth2":["write:background_checks"]}],"operationId":"updateBackgroundCheck","parameters":[{"name":"id","in":"path","description":"The background check id","required":true,"schema":{"type":"integer"}}],"requestBody":{"description":"A background check object or array of background check objects","content":{"application/json":{"schema":{"type":"object","properties":{"package_name":{"type":"string"},"package_slug":{"type":"string"},"completed_date":{"type":"string","format":"date-time"},"report_status":{"type":"string","enum":["CLEAR","CONSIDER","DISPUTED","DISPUTED_CONSIDER","ENGAGED","SUSPENDED"]}}}}},"required":false},"responses":{"200":{"description":"The background check with updated values","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BackgroundCheckSerializer"}}}}},"x-codegen-request-body-name":"createEditBackgroundCheck"},"delete":{"tags":["individuals","background checks"],"summary":"Remove background check","security":[{"oauth2":["write:background_checks"]}],"operationId":"deleteBackgroundCheck","parameters":[{"name":"id","in":"path","description":"The background check id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Empty response","content":{}}}}},"/individuals/merge_history":{"get":{"tags":["individuals"],"summary":"Get merged individual history","description":"Returns a paginated list of merged individual records.\n","security":[{"oauth2":["read:individuals"]}],"operationId":"getMergedIndividualHistory","parameters":[{"name":"since","in":"query","description":"Return records created since this ISO8601 date (inclusive)","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"page","in":"query","description":"The page number to return","required":false,"schema":{"type":"integer","default":1,"minimum":1}},{"name":"perPage","in":"query","description":"The number of records per page","required":false,"schema":{"type":"integer","default":25,"minimum":1,"maximum":100}}],"responses":{"200":{"description":"Paginated list of merged individuals","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/MergedIndividualOutputType"}},"total":{"type":"integer"}}}}}},"401":{"$ref":"#/components/responses/NotAuthenticated"},"403":{"$ref":"#/components/responses/NotAuthorized"}}}},"/integrations/checkr":{"get":{"tags":["integrations"],"summary":"Get all Checkr integrations for all campuses in an organization","security":[{"oauth2":["read:integrations"]}],"operationId":"getCheckrIntegrations","responses":{"200":{"description":"List of Third-Party Integrations","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CheckrOrganizationSerializer"}}}}},"401":{"$ref":"#/components/responses/NotAuthenticated"},"403":{"$ref":"#/components/responses/NotAuthorized"}}}},"/needs":{"post":{"tags":["needs"],"summary":"Create need","security":[{"oauth2":["write:needs"]}],"operationId":"createNeed","requestBody":{"description":"The new need details","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/UpdateNeedRequestProperties"},{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"date":{"type":"string","format":"date"}}}}}}]}}},"required":false},"responses":{"201":{"description":"The need","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NeedDetailsSerializer"}}}},"401":{"$ref":"#/components/responses/NotAuthenticated"},"403":{"$ref":"#/components/responses/NotAuthorized"}},"x-codegen-request-body-name":"createNeedRequest"}},"/needs/{id}":{"put":{"tags":["needs"],"summary":"Update a need","security":[{"oauth2":["write:needs"]}],"operationId":"updateNeed","parameters":[{"name":"id","in":"path","description":"The need's id","required":true,"schema":{"type":"integer"}}],"requestBody":{"description":"The updated need details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateNeedRequestProperties"}}},"required":false},"responses":{"200":{"description":"The need","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BasicNeedDetailsSerializer"}}}},"401":{"$ref":"#/components/responses/NotAuthenticated"},"403":{"$ref":"#/components/responses/NotAuthorized"},"404":{"$ref":"#/components/responses/NotFound"}},"x-codegen-request-body-name":"updateNeedRequest"},"delete":{"tags":["needs"],"summary":"Remove a need","security":[{"oauth2":["delete:needs"]}],"operationId":"deleteNeed","parameters":[{"name":"id","in":"path","description":"The need's id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Empty response","content":{}},"401":{"$ref":"#/components/responses/NotAuthenticated"},"403":{"$ref":"#/components/responses/NotAuthorized"},"404":{"$ref":"#/components/responses/NotFound"}}}},"/needs/{id}/coordinator":{"put":{"tags":["needs"],"summary":"Reassign need coordinator","security":[{"oauth2":["write:needs"]}],"operationId":"reassignNeedCoordinator","parameters":[{"name":"id","in":"path","description":"The need's id","required":true,"schema":{"type":"integer"}}],"requestBody":{"description":"The new need coordinator","content":{"application/json":{"schema":{"type":"object","properties":{"coordinator_id":{"type":"integer"}}}}},"required":false},"responses":{"200":{"description":"The need","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BasicNeedDetailsSerializer"}}}},"401":{"$ref":"#/components/responses/NotAuthenticated"},"403":{"$ref":"#/components/responses/NotAuthorized"},"404":{"$ref":"#/components/responses/NotFound"}},"x-codegen-request-body-name":"reassignNeedCoordinatorRequest"}},"/needs/{id}/inform":{"post":{"tags":["needs"],"summary":"Send need inform emails","security":[{"oauth2":["write:needs"]}],"operationId":"sendNeedInformEmail","parameters":[{"name":"id","in":"path","description":"The need's id","required":true,"schema":{"type":"integer"}}],"requestBody":{"description":"The need inform message","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"send_to":{"type":"array","description":"Individual ids to send the email to","items":{"type":"integer"}}}}}},"required":false},"responses":{"200":{"description":"Empty response","content":{}},"401":{"$ref":"#/components/responses/NotAuthenticated"},"403":{"$ref":"#/components/responses/NotAuthorized"},"404":{"$ref":"#/components/responses/NotFound"}},"x-codegen-request-body-name":"informNeedRequest"}},"/needs/{id}/items":{"get":{"tags":["needs"],"summary":"Get need items","security":[{"oauth2":["read:needs"]}],"operationId":"getNeedItems","parameters":[{"name":"id","in":"path","description":"The need's id","required":true,"schema":{"type":"integer"}},{"$ref":"#/components/parameters/PerPage"},{"$ref":"#/components/parameters/Page"}],"responses":{"200":{"description":"List of need items","headers":{"X-Offset":{"$ref":"#/components/headers/X-Offset"},"X-Per-Page":{"$ref":"#/components/headers/X-Per-Page"},"X-Total-Pages":{"$ref":"#/components/headers/X-Total-Pages"},"X-Page":{"$ref":"#/components/headers/X-Page"}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/NeedItemDetailsSerializer"}}}}},"401":{"$ref":"#/components/responses/NotAuthenticated"},"403":{"$ref":"#/components/responses/NotAuthorized"},"404":{"$ref":"#/components/responses/NotFound"}}},"post":{"tags":["needs"],"summary":"Create need item","security":[{"oauth2":["write:needs"]}],"operationId":"createNeedItem","parameters":[{"name":"id","in":"path","description":"The need's id","required":true,"schema":{"type":"integer"}}],"requestBody":{"description":"The need item details","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"date":{"type":"string","format":"date"}}}}},"required":false},"responses":{"200":{"description":"The need item","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NeedItemDetailsSerializer"}}}},"401":{"$ref":"#/components/responses/NotAuthenticated"},"403":{"$ref":"#/components/responses/NotAuthorized"},"404":{"$ref":"#/components/responses/NotFound"}},"x-codegen-request-body-name":"createNeedItemRequest"}},"/needs/{id}/items/{item_id}":{"put":{"tags":["needs"],"summary":"Update need item","security":[{"oauth2":["write:needs"]}],"operationId":"updateNeedItem","parameters":[{"name":"id","in":"path","description":"The need's id","required":true,"schema":{"type":"integer"}},{"name":"item_id","in":"path","description":"The need item's id","required":true,"schema":{"type":"integer"}}],"requestBody":{"description":"The need item details","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"date":{"type":"string","format":"date"},"order_by":{"type":"integer"},"assignee_id":{"type":"integer"}}}}},"required":false},"responses":{"200":{"description":"The need item","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NeedItemDetailsSerializer"}}}},"401":{"$ref":"#/components/responses/NotAuthenticated"},"403":{"$ref":"#/components/responses/NotAuthorized"},"404":{"$ref":"#/components/responses/NotFound"}},"x-codegen-request-body-name":"updateNeedItemRequest"},"delete":{"tags":["needs"],"summary":"Remove need item","security":[{"oauth2":["delete:needs"]}],"operationId":"deleteNeedItem","parameters":[{"name":"id","in":"path","description":"The need's id","required":true,"schema":{"type":"integer"}},{"name":"item_id","in":"path","description":"The need item's id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Empty response","content":{}},"401":{"$ref":"#/components/responses/NotAuthenticated"},"403":{"$ref":"#/components/responses/NotAuthorized"},"404":{"$ref":"#/components/responses/NotFound"}}}},"/need_items/{id}/assigned_to":{"put":{"tags":["needs"],"summary":"Update need item's assignee","security":[{"oauth2":["write:needs"]}],"operationId":"updateNeedItemAssignee","parameters":[{"name":"id","in":"path","description":"The need item's id","required":true,"schema":{"type":"integer"}}],"requestBody":{"description":"The need item's new assignee","content":{"application/json":{"schema":{"type":"object","properties":{"individual_id":{"type":"integer"}}}}},"required":false},"responses":{"200":{"description":"The need item","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NeedItemDetailsSerializer"}}}},"401":{"$ref":"#/components/responses/NotAuthenticated"},"403":{"$ref":"#/components/responses/NotAuthorized"},"404":{"$ref":"#/components/responses/NotFound"}},"x-codegen-request-body-name":"updateNeedItemAssigneeRequest"},"delete":{"tags":["needs"],"summary":"Remove need item's assignee","security":[{"oauth2":["write:needs"]}],"operationId":"deleteNeedItemAssignee","parameters":[{"name":"id","in":"path","description":"The need item's id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Empty response","content":{}},"401":{"$ref":"#/components/responses/NotAuthenticated"},"403":{"$ref":"#/components/responses/NotAuthorized"},"404":{"$ref":"#/components/responses/NotFound"}}}},"/groups/{id}/needs":{"get":{"tags":["needs","groups"],"summary":"Get group needs","security":[{"oauth2":["read:needs"]}],"operationId":"getGroupNeeds","parameters":[{"name":"id","in":"path","description":"The group's id","required":true,"schema":{"type":"integer"}},{"$ref":"#/components/parameters/PerPage"},{"$ref":"#/components/parameters/Page"}],"responses":{"200":{"description":"List of group needs","headers":{"X-Offset":{"$ref":"#/components/headers/X-Offset"},"X-Per-Page":{"$ref":"#/components/headers/X-Per-Page"},"X-Total-Pages":{"$ref":"#/components/headers/X-Total-Pages"},"X-Page":{"$ref":"#/components/headers/X-Page"}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BasicNeedDetailsSerializer"}}}}},"401":{"$ref":"#/components/responses/NotAuthenticated"},"403":{"$ref":"#/components/responses/NotAuthorized"},"404":{"$ref":"#/components/responses/NotFound"}}}},"/individuals/{id}/needs":{"get":{"tags":["needs","individuals"],"summary":"Get list of needs an individual coordinates","security":[{"oauth2":["read:individual_needs"]}],"operationId":"getIndividualNeeds","parameters":[{"name":"id","in":"path","description":"The individual's id","required":true,"schema":{"type":"integer"}},{"$ref":"#/components/parameters/PerPage"},{"$ref":"#/components/parameters/Page"},{"name":"range_type","in":"query","description":"Filter by time range","schema":{"type":"string","enum":["ALL","FUTURE","PAST"]}}],"responses":{"200":{"description":"List of needs an individual coordinates","headers":{"X-Offset":{"$ref":"#/components/headers/X-Offset"},"X-Per-Page":{"$ref":"#/components/headers/X-Per-Page"},"X-Total-Pages":{"$ref":"#/components/headers/X-Total-Pages"},"X-Page":{"$ref":"#/components/headers/X-Page"}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BasicNeedSerializer"}}}}},"401":{"$ref":"#/components/responses/NotAuthenticated"},"403":{"$ref":"#/components/responses/NotAuthorized"},"404":{"$ref":"#/components/responses/NotFound"}}}},"/notes":{"get":{"tags":["notes"],"summary":"Get notes","security":[{"oauth2":["read:notes"]}],"operationId":"getNotes","parameters":[{"$ref":"#/components/parameters/PerPage"},{"$ref":"#/components/parameters/Page"},{"name":"context","in":"query","description":"The contexts to get notes for","style":"form","explode":true,"schema":{"type":"array","items":{"type":"string","enum":["GROUP","DEPARTMENT","PROCESS_QUEUE","GENERAL"]}}},{"name":"sharing_level","in":"query","description":"The sharing level to get notes for","style":"form","explode":true,"schema":{"type":"array","items":{"type":"string","enum":["PRIVATE","CONTEXT_LEADERS","ALL_LEADERS"]}}},{"name":"show","in":"query","description":"Only show notes I have created OR shared with me","schema":{"type":"string","enum":["CREATED_BY_ME","SHARED_WITH_ME"]}}],"responses":{"200":{"description":"List of Notes","headers":{"X-Offset":{"$ref":"#/components/headers/X-Offset"},"X-Per-Page":{"$ref":"#/components/headers/X-Per-Page"},"X-Total-Pages":{"$ref":"#/components/headers/X-Total-Pages"},"X-Page":{"$ref":"#/components/headers/X-Page"}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BasicNoteWithIndividualSerializer"}}}}},"401":{"$ref":"#/components/responses/NotAuthenticated"},"403":{"$ref":"#/components/responses/NotAuthorized"}}}},"/notes/{id}":{"get":{"tags":["notes"],"summary":"Get note","security":[{"oauth2":["read:notes"]}],"operationId":"getNote","parameters":[{"name":"id","in":"path","description":"The note's id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Note Details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BasicNoteWithIndividualSerializer"}}}},"401":{"$ref":"#/components/responses/NotAuthenticated"},"403":{"$ref":"#/components/responses/NotAuthorized"}}},"put":{"tags":["notes"],"summary":"Updates note","security":[{"oauth2":["write:notes"]}],"operationId":"updateNote","parameters":[{"name":"id","in":"path","description":"The note's id","required":true,"schema":{"type":"integer"}}],"requestBody":{"description":"The updated note","content":{"application/json":{"schema":{"type":"object","properties":{"note":{"type":"string"},"sharing_level":{"type":"string","enum":["PRIVATE","CONTEXT_LEADERS","ALL_LEADERS"]}}}}},"required":false},"responses":{"200":{"description":"Note Details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BasicNoteWithIndividualSerializer"}}}}},"x-codegen-request-body-name":"note"},"delete":{"tags":["notes"],"summary":"Delete note","security":[{"oauth2":["delete:notes"]}],"operationId":"deleteNote","parameters":[{"name":"id","in":"path","description":"The note's id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Empty response","content":{}},"401":{"$ref":"#/components/responses/NotAuthenticated"},"403":{"$ref":"#/components/responses/NotAuthorized"}}}},"/individuals/{id}/notes":{"get":{"tags":["individuals"],"summary":"Get notes for an individual","security":[{"oauth2":["read:individual_notes"]}],"operationId":"getIndividualNotes","parameters":[{"name":"id","in":"path","description":"The individual's id","required":true,"schema":{"type":"integer"}},{"$ref":"#/components/parameters/PerPage"},{"$ref":"#/components/parameters/Page"},{"name":"context","in":"query","description":"The contexts to get notes for","style":"form","explode":true,"schema":{"type":"array","items":{"type":"string","enum":["GROUP","DEPARTMENT","PROCESS_QUEUE","GENERAL"]}}},{"name":"context_id","in":"query","description":"The context ids to filte notes for","schema":{"type":"integer"}},{"name":"sharing_level","in":"query","description":"The sharing level to get notes for","style":"form","explode":true,"schema":{"type":"array","items":{"type":"string","enum":["PRIVATE","CONTEXT_LEADERS","ALL_LEADERS"]}}},{"name":"include_context","in":"query","description":"Include the context","schema":{"type":"boolean"}},{"name":"include_creator","in":"query","description":"Include the creator","schema":{"type":"boolean"}}],"responses":{"200":{"description":"Individual note details","headers":{"X-Offset":{"$ref":"#/components/headers/X-Offset"},"X-Per-Page":{"$ref":"#/components/headers/X-Per-Page"},"X-Total-Pages":{"$ref":"#/components/headers/X-Total-Pages"},"X-Page":{"$ref":"#/components/headers/X-Page"}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BasicNoteSerializer"}}}}},"401":{"$ref":"#/components/responses/NotAuthenticated"},"403":{"$ref":"#/components/responses/NotAuthorized"}}},"post":{"tags":["individuals"],"summary":"Create note","security":[{"oauth2":["write:individual_notes"]}],"operationId":"createIndividualNote","parameters":[{"name":"id","in":"path","description":"The individual's id","required":true,"schema":{"type":"integer"}}],"requestBody":{"description":"The new note","content":{"application/json":{"schema":{"type":"object","properties":{"note":{"type":"string"},"context":{"type":"string","enum":["GROUP","DEPARTMENT","PROCESS_QUEUE","GENERAL"]},"context_id":{"type":"integer"},"sharing_level":{"type":"string","enum":["PRIVATE","CONTEXT_LEADERS","ALL_LEADERS"]}}}}},"required":false},"responses":{"201":{"description":"Returns the new note","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BasicNoteWithIndividualSerializer"}}}},"401":{"$ref":"#/components/responses/NotAuthenticated"},"403":{"$ref":"#/components/responses/NotAuthorized"}},"x-codegen-request-body-name":"note"}},"/families/{id}/notes":{"get":{"tags":["families","individuals","notes"],"summary":"Get notes for all family members","security":[{"oauth2":["read:individual_notes"]}],"operationId":"getFamilyNotes","parameters":[{"name":"id","in":"path","description":"The family's id","required":true,"schema":{"type":"integer"}},{"$ref":"#/components/parameters/PerPage"},{"$ref":"#/components/parameters/Page"},{"name":"context","in":"query","description":"The contexts to get notes for","style":"form","explode":true,"schema":{"type":"array","items":{"type":"string","enum":["GROUP","DEPARTMENT","PROCESS_QUEUE","GENERAL"]}}},{"name":"sharing_level","in":"query","description":"The sharing level to get notes for","style":"form","explode":true,"schema":{"type":"array","items":{"type":"string","enum":["PRIVATE","CONTEXT_LEADERS","ALL_LEADERS"]}}},{"name":"include_context","in":"query","description":"Include the context","schema":{"type":"boolean"}},{"name":"include_creator","in":"query","description":"Include the creator","schema":{"type":"boolean"}}],"responses":{"200":{"description":"List of individual notes","headers":{"X-Offset":{"$ref":"#/components/headers/X-Offset"},"X-Per-Page":{"$ref":"#/components/headers/X-Per-Page"},"X-Total-Pages":{"$ref":"#/components/headers/X-Total-Pages"},"X-Page":{"$ref":"#/components/headers/X-Page"}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BasicNoteWithIndividualSerializer"}}}}},"401":{"$ref":"#/components/responses/NotAuthenticated"}}}},"/individuals/{id}/notes/leaders":{"get":{"tags":["notes"],"summary":"Get the sharing level leaders associated to an individual's notes","security":[{"oauth2":["read:individual_notes"]}],"operationId":"getIndividualNoteLeaders","parameters":[{"name":"id","in":"path","description":"The individual's id","required":true,"schema":{"type":"integer"}},{"$ref":"#/components/parameters/PerPage"},{"$ref":"#/components/parameters/Page"},{"name":"context","in":"query","description":"The contexts to get notes for","style":"form","explode":true,"schema":{"type":"array","items":{"type":"string","enum":["GROUP","DEPARTMENT","PROCESS_QUEUE","GENERAL"]}}},{"name":"sharing_level","in":"query","description":"The sharing level to get notes for","style":"form","explode":true,"schema":{"type":"array","items":{"type":"string","enum":["PRIVATE","CONTEXT_LEADERS","ALL_LEADERS"]}}}],"responses":{"200":{"description":"List of Note Leaders","headers":{"X-Offset":{"$ref":"#/components/headers/X-Offset"},"X-Per-Page":{"$ref":"#/components/headers/X-Per-Page"},"X-Total-Pages":{"$ref":"#/components/headers/X-Total-Pages"},"X-Page":{"$ref":"#/components/headers/X-Page"}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BasicIndividualProfileSerializer"}}}}},"401":{"$ref":"#/components/responses/NotAuthenticated"},"403":{"$ref":"#/components/responses/NotAuthorized"}}}},"/individuals/{individual_id}/admin/processes":{"get":{"tags":["process queues"],"summary":"Get a list of a processes the individual manages","security":[{"oauth2":["read:process_queues"]}],"operationId":"getIndividualAdminProcesses","parameters":[{"name":"individual_id","in":"path","description":"The individual id","required":true,"schema":{"type":"integer"}},{"$ref":"#/components/parameters/PerPage"},{"$ref":"#/components/parameters/Page"},{"name":"active","in":"query","description":"Filter processes on active or archived","schema":{"type":"boolean"}},{"name":"process_ids","in":"query","description":"Filter to specific processes","style":"form","explode":true,"schema":{"type":"array","items":{"type":"integer"}}}],"responses":{"200":{"description":"Managed Processes list","headers":{"X-Offset":{"$ref":"#/components/headers/X-Offset"},"X-Per-Page":{"$ref":"#/components/headers/X-Per-Page"},"X-Total-Pages":{"$ref":"#/components/headers/X-Total-Pages"},"X-Page":{"$ref":"#/components/headers/X-Page"}},"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","allOf":[{"$ref":"#/components/schemas/BasicProcessSerializer"},{"type":"object","properties":{"actions":{"type":"object","properties":{"can_remove_process_manager":{"$ref":"#/components/schemas/Action"},"can_view_process":{"$ref":"#/components/schemas/Action"}}}}}]}}}}},"401":{"$ref":"#/components/responses/NotAuthenticated"},"403":{"$ref":"#/components/responses/NotAuthorized"}}}},"/individuals/{individual_id}/admin/queues":{"get":{"tags":["process queues"],"summary":"Get a list of a queues the individual manages","security":[{"oauth2":["read:process_queues"]}],"operationId":"getIndividualAdminProcessQueues","parameters":[{"name":"individual_id","in":"path","description":"The individual id","required":true,"schema":{"type":"integer"}},{"$ref":"#/components/parameters/PerPage"},{"$ref":"#/components/parameters/Page"},{"name":"active","in":"query","description":"Filter queues on the parent process being active or archived","schema":{"type":"boolean"}},{"name":"process_id","in":"query","description":"Allows a process manager to request this data","schema":{"type":"integer"}}],"responses":{"200":{"description":"Managed Queues list","headers":{"X-Offset":{"$ref":"#/components/headers/X-Offset"},"X-Per-Page":{"$ref":"#/components/headers/X-Per-Page"},"X-Total-Pages":{"$ref":"#/components/headers/X-Total-Pages"},"X-Page":{"$ref":"#/components/headers/X-Page"}},"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","allOf":[{"$ref":"#/components/schemas/BasicQueueSerializer"},{"type":"object","properties":{"assigned_count":{"type":"integer"},"actions":{"type":"object","properties":{"can_remove_queue_manager":{"$ref":"#/components/schemas/Action"},"can_view_process_queue":{"$ref":"#/components/schemas/Action"}}}}}]}}}}},"401":{"$ref":"#/components/responses/NotAuthenticated"},"403":{"$ref":"#/components/responses/NotAuthorized"}}}},"/processes":{"get":{"tags":["process queues"],"summary":"Get a list of processes","security":[{"oauth2":["read:process_queues"]}],"operationId":"getProcesses","parameters":[{"$ref":"#/components/parameters/PerPage"},{"$ref":"#/components/parameters/Page"},{"name":"name","in":"query","description":"Process name to search by","schema":{"type":"string"}},{"name":"exclude_empty","in":"query","description":"Include processes with no queues (default is false)","schema":{"type":"boolean","default":false}},{"name":"campus_ids","in":"query","description":"Campus ids to filter processes","style":"form","explode":true,"schema":{"type":"array","items":{"type":"integer"}}},{"name":"managed_by_me","in":"query","description":"Only return processes managed by the requesting user","schema":{"type":"boolean","default":null}},{"name":"restricted_mode","in":"query","description":"When true, limits results to only processes the requesting user manages, ignoring campus-level admin permissions that would otherwise expose hidden processes.","schema":{"type":"boolean","default":null}},{"name":"statuses","in":"query","description":"Status to filter processes","schema":{"$ref":"#/components/schemas/ProcessStatusType"}},{"name":"sort_by","in":"query","description":"Sort process list response","schema":{"$ref":"#/components/schemas/ProcessSortBy"}},{"name":"sort_direction","in":"query","description":"Sort process list direction","schema":{"type":"string"}}],"responses":{"200":{"description":"Processes list","headers":{"X-Offset":{"$ref":"#/components/headers/X-Offset"},"X-Per-Page":{"$ref":"#/components/headers/X-Per-Page"},"X-Total-Pages":{"$ref":"#/components/headers/X-Total-Pages"},"X-Page":{"$ref":"#/components/headers/X-Page"}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BasicProcessSerializer"}}}}},"401":{"$ref":"#/components/responses/NotAuthenticated"},"403":{"$ref":"#/components/responses/NotAuthorized"}}},"post":{"tags":["process queues"],"summary":"Create a new process","security":[{"oauth2":["write:processes"]}],"operationId":"createProcess","requestBody":{"description":"The details of the process to create","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateProcessRequest"}}}},"responses":{"201":{"description":"The created process","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProcessDetail"}}}},"400":{"$ref":"#/components/responses/NotValid"},"401":{"$ref":"#/components/responses/NotAuthenticated"},"403":{"$ref":"#/components/responses/NotAuthorized"}}}},"/processes/{process_id}":{"get":{"tags":["process queues"],"summary":"Get a specific process","security":[{"oauth2":["read:processes"]}],"operationId":"getProcess","parameters":[{"name":"process_id","in":"path","description":"The process ID","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"The process details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProcessDetail"}}}},"401":{"$ref":"#/components/responses/NotAuthenticated"},"403":{"$ref":"#/components/responses/NotAuthorized"},"404":{"$ref":"#/components/responses/NotFound"}}},"put":{"tags":["process queues"],"summary":"Update an existing process","security":[{"oauth2":["write:processes"]}],"operationId":"updateProcess","parameters":[{"name":"process_id","in":"path","description":"The process ID","required":true,"schema":{"type":"integer"}}],"requestBody":{"description":"The details of the process to update","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateProcessRequest"}}}},"responses":{"200":{"description":"The updated process","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProcessDetail"}}}},"400":{"$ref":"#/components/responses/NotValid"},"401":{"$ref":"#/components/responses/NotAuthenticated"},"403":{"$ref":"#/components/responses/NotAuthorized"},"404":{"$ref":"#/components/responses/NotFound"}}},"delete":{"tags":["process queues"],"summary":"Delete a specific process","security":[{"oauth2":["delete:processes"]}],"operationId":"deleteProcess","parameters":[{"name":"process_id","in":"path","description":"The process ID","required":true,"schema":{"type":"integer"}}],"responses":{"204":{"description":"Process deleted successfully"},"401":{"$ref":"#/components/responses/NotAuthenticated"},"403":{"$ref":"#/components/responses/NotAuthorized"},"404":{"$ref":"#/components/responses/NotFound"}}}},"/processes/{process_id}/duplicate":{"post":{"tags":["process queues"],"summary":"Duplicate an existing process","security":[{"oauth2":["write:processes"]}],"operationId":"duplicateProcess","parameters":[{"name":"process_id","in":"path","description":"The process ID to duplicate","required":true,"schema":{"type":"integer"}}],"requestBody":{"description":"The details of the process to update","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateProcessRequest"}}}},"responses":{"200":{"description":"The updated process","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProcessDetail"}}}},"400":{"$ref":"#/components/responses/NotValid"},"401":{"$ref":"#/components/responses/NotAuthenticated"},"403":{"$ref":"#/components/responses/NotAuthorized"},"404":{"$ref":"#/components/responses/NotFound"}}}},"/processes/{process_id}/manager":{"post":{"tags":["process queues"],"summary":"Add a single manager to a process","description":"Add an individual as a manager to a specific process.\n","security":[{"oauth2":["write:process_managers"]}],"operationId":"addProcessManager","parameters":[{"name":"process_id","in":"path","description":"The ID of the process","required":true,"schema":{"type":"integer"}}],"requestBody":{"description":"The individual to add as a process manager","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddProcessManager"}}}},"responses":{"201":{"description":"The added process manager","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProcessManagerDetail"}}}},"400":{"$ref":"#/components/responses/NotValid"},"401":{"$ref":"#/components/responses/NotAuthenticated"},"403":{"$ref":"#/components/responses/NotAuthorized"},"404":{"$ref":"#/components/responses/NotFound"}}}},"/processes/{process_id}/managers":{"get":{"tags":["process queues"],"summary":"Get the managers of a specific process","security":[{"oauth2":["read:process_managers"]}],"operationId":"getProcessManagers","parameters":[{"name":"process_id","in":"path","description":"The ID of the process","required":true,"schema":{"type":"integer"}},{"$ref":"#/components/parameters/PerPage"},{"$ref":"#/components/parameters/Page"}],"responses":{"200":{"description":"List of process managers","headers":{"X-Offset":{"$ref":"#/components/headers/X-Offset"},"X-Per-Page":{"$ref":"#/components/headers/X-Per-Page"},"X-Total-Pages":{"$ref":"#/components/headers/X-Total-Pages"},"X-Page":{"$ref":"#/components/headers/X-Page"}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ProcessManagerDetail"}}}}},"401":{"$ref":"#/components/responses/NotAuthenticated"},"403":{"$ref":"#/components/responses/NotAuthorized"},"404":{"$ref":"#/components/responses/NotFound"}}}},"/processes/{process_id}/managers/{manager_id}":{"delete":{"tags":["process queues"],"summary":"Remove a process manager","security":[{"oauth2":["write:process_queues"]}],"operationId":"deleteProcessManager","parameters":[{"name":"process_id","in":"path","description":"The process id","required":true,"schema":{"type":"integer"}},{"name":"manager_id","in":"path","description":"The id of the process manager","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Empty response","content":{}},"401":{"$ref":"#/components/responses/NotAuthenticated"},"403":{"$ref":"#/components/responses/NotAuthorized"},"404":{"$ref":"#/components/responses/NotFound"}}}},"/processes/{process_id}/queue":{"post":{"tags":["process queues"],"summary":"Create a new queue in a process","security":[{"oauth2":["write:process_queues"]}],"operationId":"createProcessQueue","parameters":[{"name":"process_id","in":"path","description":"The process ID","required":true,"schema":{"type":"integer"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateQueueInput"}}}},"responses":{"201":{"description":"The created queue","content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueueDetailsOutput"}}}},"400":{"$ref":"#/components/responses/NotValid"},"401":{"$ref":"#/components/responses/NotAuthenticated"},"403":{"$ref":"#/components/responses/NotAuthorized"},"404":{"$ref":"#/components/responses/NotFound"}}}},"/processes/{process_id}/queue-details":{"get":{"tags":["process queues"],"summary":"Get a list of queues in a process","security":[{"oauth2":["read:process_queues"]}],"operationId":"getProcessQueueDetails","parameters":[{"name":"process_id","in":"path","description":"The process ID","required":true,"schema":{"type":"integer"}},{"$ref":"#/components/parameters/PerPage"},{"$ref":"#/components/parameters/Page"}],"responses":{"200":{"description":"Process queue details list","headers":{"X-Offset":{"$ref":"#/components/headers/X-Offset"},"X-Per-Page":{"$ref":"#/components/headers/X-Per-Page"},"X-Total-Pages":{"$ref":"#/components/headers/X-Total-Pages"},"X-Page":{"$ref":"#/components/headers/X-Page"}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/QueueDetailsOutput"}}}}},"401":{"$ref":"#/components/responses/NotAuthenticated"},"403":{"$ref":"#/components/responses/NotAuthorized"},"404":{"$ref":"#/components/responses/NotFound"}}}},"/processes/{process_id}/queues":{"get":{"tags":["process queues"],"summary":"Get a list of a queues in a process","description":"Deprecated endpoint. Use GET /processes/{process_id:[0-9]+}/queue-details instead.","security":[{"oauth2":["read:process_queues"]}],"operationId":"getProcessQueues","parameters":[{"name":"process_id","in":"path","description":"The process id","required":true,"schema":{"type":"integer"}},{"$ref":"#/components/parameters/PerPage"},{"$ref":"#/components/parameters/Page"},{"name":"name","in":"query","description":"Queue name to search by","schema":{"type":"string"}}],"responses":{"200":{"description":"Process queues list","headers":{"X-Offset":{"$ref":"#/components/headers/X-Offset"},"X-Per-Page":{"$ref":"#/components/headers/X-Per-Page"},"X-Total-Pages":{"$ref":"#/components/headers/X-Total-Pages"},"X-Page":{"$ref":"#/components/headers/X-Page"}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BasicQueueSerializer"}}}}},"401":{"$ref":"#/components/responses/NotAuthenticated"},"403":{"$ref":"#/components/responses/NotAuthorized"}},"deprecated":true},"post":{"tags":["process queues"],"summary":"Create a new queue","description":"Deprecated endpoint. Use POST /processes/{process_id:[0-9]+}/queue instead.","security":[{"oauth2":["write:process_queues"]}],"operationId":"createQueue","parameters":[{"name":"process_id","in":"path","description":"The process id","required":true,"schema":{"type":"integer"}}],"requestBody":{"description":"The details of the queue to create","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateQueueRequest"}}}},"responses":{"201":{"description":"The created queue","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StepDetail"}}}},"400":{"$ref":"#/components/responses/NotValid"},"401":{"$ref":"#/components/responses/NotAuthenticated"},"403":{"$ref":"#/components/responses/NotAuthorized"}},"deprecated":true}},"/processes/{process_id}/reorder":{"put":{"tags":["process queues"],"summary":"Reorder queues within a process","description":"Update the order of queues within a process. The queue IDs provided\ndetermine the new ordering.\n","security":[{"oauth2":["write:process_queues"]}],"operationId":"reorderProcessQueues","parameters":[{"name":"process_id","in":"path","description":"The ID of the process","required":true,"schema":{"type":"integer"}}],"requestBody":{"description":"The new order of queue IDs","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateQueueOrderRequest"}}}},"responses":{"200":{"description":"The result of the reorder operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateQueueOrderResponse"}}}},"400":{"$ref":"#/components/responses/NotValid"},"401":{"$ref":"#/components/responses/NotAuthenticated"},"403":{"$ref":"#/components/responses/NotAuthorized"},"404":{"$ref":"#/components/responses/NotFound"}}}},"/queue_individuals":{"get":{"tags":["process queues"],"summary":"Get a list of queue individuals","security":[{"oauth2":["read:queue_individuals"]}],"operationId":"listQueueIndividuals","parameters":[{"$ref":"#/components/parameters/PerPage"},{"$ref":"#/components/parameters/Page"},{"name":"name","in":"query","description":"Filter by individual name","schema":{"type":"string"}},{"name":"queue_ids","in":"query","description":"Filter by queue IDs","style":"form","explode":true,"schema":{"type":"array","items":{"type":"integer"}}},{"name":"process_ids","in":"query","description":"Filter by process IDs","style":"form","explode":true,"schema":{"type":"array","items":{"type":"integer"}}},{"name":"individual_ids","in":"query","description":"Filter by individual IDs","style":"form","explode":true,"schema":{"type":"array","items":{"type":"integer"}}},{"name":"manager_ids","in":"query","description":"Filter by manager IDs","style":"form","explode":true,"schema":{"type":"array","items":{"type":"integer"}}},{"name":"statuses","in":"query","description":"Filter by queue individual statuses","style":"form","explode":true,"schema":{"type":"array","items":{"type":"string","enum":["NOT_STARTED","WAITING","IN_PROCESS","DONE"]}}},{"name":"assignment_filter","in":"query","description":"Filter by assignment","schema":{"type":"string","enum":["ASSIGNED_TO_ME","UNASSIGNED","ANY"],"default":"ANY"}},{"name":"sort","in":"query","description":"Sort field","schema":{"type":"string","enum":["name","status","date_added","time_in_queue","date_due","assigned_to","last_activity"],"default":"name"}},{"name":"direction","in":"query","description":"Sort direction","schema":{"type":"string","enum":["ASC","DESC"],"default":"ASC"}},{"name":"date_added_start","in":"query","description":"Filter by date added (start, inclusive)","schema":{"type":"string","format":"date"}},{"name":"date_added_end","in":"query","description":"Filter by date added (end, inclusive)","schema":{"type":"string","format":"date"}}],"responses":{"200":{"description":"List of queue individuals","headers":{"X-Offset":{"$ref":"#/components/headers/X-Offset"},"X-Per-Page":{"$ref":"#/components/headers/X-Per-Page"},"X-Total-Pages":{"$ref":"#/components/headers/X-Total-Pages"},"X-Page":{"$ref":"#/components/headers/X-Page"}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/QueueIndividualDetail"}}}}},"401":{"$ref":"#/components/responses/NotAuthenticated"},"403":{"$ref":"#/components/responses/NotAuthorized"}}}},"/queue_individuals/{queue_individual_id}":{"get":{"tags":["process queues"],"summary":"Get details of a queue individual","security":[{"oauth2":["read:queue_individuals"]}],"operationId":"getQueueIndividual","parameters":[{"name":"queue_individual_id","in":"path","description":"The queue individual id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Queue individual details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueueIndividualDetail"}}}},"401":{"$ref":"#/components/responses/NotAuthenticated"},"403":{"$ref":"#/components/responses/NotAuthorized"},"404":{"$ref":"#/components/responses/NotFound"}}},"put":{"tags":["process queues"],"summary":"Update a queue individual","security":[{"oauth2":["write:queue_individuals"]}],"operationId":"updateQueueIndividual","parameters":[{"name":"queue_individual_id","in":"path","description":"The queue individual id","required":true,"schema":{"type":"integer"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateQueueIndividualInput"}}}},"responses":{"200":{"description":"The updated queue individual","content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueueIndividualDetail"}}}},"400":{"$ref":"#/components/responses/NotValid"},"401":{"$ref":"#/components/responses/NotAuthenticated"},"403":{"$ref":"#/components/responses/NotAuthorized"},"404":{"$ref":"#/components/responses/NotFound"}}},"delete":{"tags":["process queues"],"summary":"Remove an individual from a queue","security":[{"oauth2":["delete:queue_individuals"]}],"operationId":"deleteQueueIndividual","parameters":[{"name":"queue_individual_id","in":"path","description":"The queue individual id","required":true,"schema":{"type":"integer"}}],"responses":{"204":{"description":"Queue individual deleted successfully"},"401":{"$ref":"#/components/responses/NotAuthenticated"},"403":{"$ref":"#/components/responses/NotAuthorized"},"404":{"$ref":"#/components/responses/NotFound"}}}},"/queue_list":{"get":{"tags":["process queues"],"summary":"Get a list of queues","security":[{"oauth2":["read:process_queues"]}],"operationId":"getQueueList","parameters":[{"$ref":"#/components/parameters/PerPage"},{"$ref":"#/components/parameters/Page"},{"name":"campus_ids","in":"query","description":"Filter by campus IDs","style":"form","explode":true,"schema":{"type":"array","items":{"type":"integer"}}},{"name":"process_ids","in":"query","description":"Filter by process IDs","style":"form","explode":true,"schema":{"type":"array","items":{"type":"integer"}}},{"name":"managed_by_me","in":"query","description":"Only return queues in processes managed by the requesting user","schema":{"type":"boolean"}},{"name":"has_unassigned","in":"query","description":"Only return queues with unassigned individuals","schema":{"type":"boolean"}},{"name":"search_term","in":"query","description":"Filter queues by name","schema":{"type":"string"}},{"name":"sort_by","in":"query","description":"Sort field","schema":{"type":"string","enum":["NAME","PROCESS","CAMPUS"]}},{"name":"sort_direction","in":"query","description":"Sort direction","schema":{"type":"string","enum":["ASC","DESC"]}}],"responses":{"200":{"description":"Queue list","headers":{"X-Offset":{"$ref":"#/components/headers/X-Offset"},"X-Per-Page":{"$ref":"#/components/headers/X-Per-Page"},"X-Total-Pages":{"$ref":"#/components/headers/X-Total-Pages"},"X-Page":{"$ref":"#/components/headers/X-Page"}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/QueueDetailsOutput"}}}}},"401":{"$ref":"#/components/responses/NotAuthenticated"},"403":{"$ref":"#/components/responses/NotAuthorized"}}}},"/queues":{"get":{"tags":["process queues"],"summary":"Get a list of queues","description":"Deprecated endpoint. Use GET /queue_list instead.","security":[{"oauth2":["read:process_queues"]}],"operationId":"listQueues","parameters":[{"$ref":"#/components/parameters/PerPage"},{"$ref":"#/components/parameters/Page"},{"name":"campus_ids","in":"query","description":"Filter by campus IDs","style":"form","explode":true,"schema":{"type":"array","items":{"type":"integer"}}},{"name":"process_ids","in":"query","description":"Filter by process IDs","style":"form","explode":true,"schema":{"type":"array","items":{"type":"integer"}}},{"name":"managed_by_me","in":"query","description":"Only return queues in processes managed by the requesting user","schema":{"type":"boolean"}},{"name":"search_term","in":"query","description":"Filter queues by name","schema":{"type":"string"}}],"responses":{"200":{"description":"Queue list","headers":{"X-Offset":{"$ref":"#/components/headers/X-Offset"},"X-Per-Page":{"$ref":"#/components/headers/X-Per-Page"},"X-Total-Pages":{"$ref":"#/components/headers/X-Total-Pages"},"X-Page":{"$ref":"#/components/headers/X-Page"}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BasicQueueSerializer"}}}}},"401":{"$ref":"#/components/responses/NotAuthenticated"},"403":{"$ref":"#/components/responses/NotAuthorized"}},"deprecated":true}},"/queues/action-types":{"get":{"tags":["process queues"],"summary":"Get available queue action types","security":[{"oauth2":["read:queue_action_types"]}],"operationId":"getQueueActionTypes","responses":{"200":{"description":"List of queue action types","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/QueueActionTypeOutput"}}}}},"401":{"$ref":"#/components/responses/NotAuthenticated"},"403":{"$ref":"#/components/responses/NotAuthorized"}}}},"/queues/{queue_id}":{"get":{"tags":["process queues"],"summary":"Get queue details","security":[{"oauth2":["read:process_queues"]}],"operationId":"getQueue","parameters":[{"name":"queue_id","in":"path","description":"The queue's id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"The queue details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueueDetail"}}}},"401":{"$ref":"#/components/responses/NotAuthenticated"},"403":{"$ref":"#/components/responses/NotAuthorized"},"404":{"$ref":"#/components/responses/NotFound"}}},"put":{"tags":["process queues"],"summary":"Update a queue","security":[{"oauth2":["write:process_queues"]}],"operationId":"updateQueue","parameters":[{"name":"queue_id","in":"path","description":"The queue id","required":true,"schema":{"type":"integer"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateQueueRequest"}}}},"responses":{"200":{"description":"The updated queue","content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueueDetailsOutput"}}}},"400":{"$ref":"#/components/responses/NotValid"},"401":{"$ref":"#/components/responses/NotAuthenticated"},"403":{"$ref":"#/components/responses/NotAuthorized"},"404":{"$ref":"#/components/responses/NotFound"}}},"delete":{"summary":"Delete a process queue","security":[{"oauth2":["delete:process_queues"]}],"tags":["process queues"],"operationId":"deleteProcessQueue","parameters":[{"name":"queue_id","in":"path","description":"The queue id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Empty response","content":{}},"401":{"$ref":"#/components/responses/NotAuthenticated"},"403":{"$ref":"#/components/responses/NotAuthorized"},"404":{"$ref":"#/components/responses/NotFound"}}}},"/queues/{queue_id}/action":{"post":{"tags":["process queues"],"summary":"Create a queue action","security":[{"oauth2":["write:process_queues"]}],"operationId":"createQueueAction","parameters":[{"name":"queue_id","in":"path","description":"The queue id","required":true,"schema":{"type":"integer"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateQueueActionRequest"}}}},"responses":{"201":{"description":"The created queue action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueueActionOutput"}}}},"400":{"$ref":"#/components/responses/NotValid"},"401":{"$ref":"#/components/responses/NotAuthenticated"},"403":{"$ref":"#/components/responses/NotAuthorized"},"404":{"$ref":"#/components/responses/NotFound"}}}},"/queues/{queue_id}/actions":{"put":{"tags":["process queues"],"summary":"Replace all actions on a queue","security":[{"oauth2":["write:process_queues"]}],"operationId":"updateQueueActions","parameters":[{"name":"queue_id","in":"path","description":"The queue id","required":true,"schema":{"type":"integer"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateQueueActionsRequest"}}}},"responses":{"200":{"description":"The updated queue actions","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/QueueActionOutput"}}}}},"400":{"$ref":"#/components/responses/NotValid"},"401":{"$ref":"#/components/responses/NotAuthenticated"},"403":{"$ref":"#/components/responses/NotAuthorized"},"404":{"$ref":"#/components/responses/NotFound"}}}},"/queues/{queue_id}/individual":{"post":{"tags":["process queues"],"summary":"Add an individual to a queue","security":[{"oauth2":["write:queue_individuals"]}],"operationId":"addIndividualToQueue","parameters":[{"name":"queue_id","in":"path","description":"The queue id","required":true,"schema":{"type":"integer"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddQueueIndividualRequest"}}}},"responses":{"201":{"description":"The created queue individual","content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueueIndividualDetail"}}}},"400":{"$ref":"#/components/responses/NotValid"},"401":{"$ref":"#/components/responses/NotAuthenticated"},"403":{"$ref":"#/components/responses/NotAuthorized"},"404":{"$ref":"#/components/responses/NotFound"}}}},"/queues/{queue_id}/individuals":{"get":{"tags":["process queues"],"summary":"Get individuals in a queue","security":[{"oauth2":["read:queue_individuals"]}],"operationId":"getQueueIndividuals","parameters":[{"name":"queue_id","in":"path","description":"The queue id","required":true,"schema":{"type":"integer"}},{"$ref":"#/components/parameters/PerPage"},{"$ref":"#/components/parameters/Page"},{"name":"name","in":"query","description":"Filter by individual name","schema":{"type":"string"}},{"name":"manager_ids","in":"query","description":"Filter by manager IDs","style":"form","explode":true,"schema":{"type":"array","items":{"type":"integer"}}},{"name":"statuses","in":"query","description":"Filter by queue individual statuses","style":"form","explode":true,"schema":{"type":"array","items":{"type":"string","enum":["NOT_STARTED","WAITING","IN_PROCESS","DONE"]}}},{"name":"assignment_filter","in":"query","description":"Filter by assignment","schema":{"type":"string","enum":["ASSIGNED_TO_ME","UNASSIGNED","ANY"],"default":"ANY"}},{"name":"sort","in":"query","description":"Sort field","schema":{"type":"string","enum":["name","status","date_added","time_in_queue","date_due","assigned_to","last_activity"],"default":"name"}},{"name":"direction","in":"query","description":"Sort direction","schema":{"type":"string","enum":["ASC","DESC"],"default":"ASC"}},{"name":"date_added_start","in":"query","description":"Filter by date added (start, inclusive)","schema":{"type":"string","format":"date"}},{"name":"date_added_end","in":"query","description":"Filter by date added (end, inclusive)","schema":{"type":"string","format":"date"}}],"responses":{"200":{"description":"List of queue individuals","headers":{"X-Offset":{"$ref":"#/components/headers/X-Offset"},"X-Per-Page":{"$ref":"#/components/headers/X-Per-Page"},"X-Total-Pages":{"$ref":"#/components/headers/X-Total-Pages"},"X-Page":{"$ref":"#/components/headers/X-Page"}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/QueueIndividualDetail"}}}}},"401":{"$ref":"#/components/responses/NotAuthenticated"},"403":{"$ref":"#/components/responses/NotAuthorized"},"404":{"$ref":"#/components/responses/NotFound"}}},"post":{"tags":["process queues"],"summary":"Add an individual to a process queue","description":"Deprecated endpoint. Use GET /queues/{queue_id:[0-9]+}/individual instead.","security":[{"oauth2":["write:queue_individuals"]}],"operationId":"addQueueIndividual","parameters":[{"name":"queue_id","in":"path","description":"The queue's id","required":true,"schema":{"type":"integer"}}],"requestBody":{"description":"The individual queue","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateQueueIndividualRequest"}}},"required":false},"responses":{"200":{"description":"The individuals in the queue","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProcessQueueIndividualDetail"}}}},"401":{"$ref":"#/components/responses/NotAuthenticated"},"403":{"$ref":"#/components/responses/NotAuthorized"}},"x-codegen-request-body-name":"createQueueIndividualRequest","deprecated":true}},"/queues/{queue_id}/individuals/done":{"get":{"tags":["process queues"],"summary":"Get completed individuals in a queue","security":[{"oauth2":["read:queue_individuals"]}],"operationId":"getDoneQueueIndividuals","parameters":[{"name":"queue_id","in":"path","description":"The queue id","required":true,"schema":{"type":"integer"}},{"$ref":"#/components/parameters/PerPage"},{"$ref":"#/components/parameters/Page"},{"name":"name","in":"query","description":"Filter by individual name","schema":{"type":"string"}},{"name":"manager_ids","in":"query","description":"Filter by manager IDs","style":"form","explode":true,"schema":{"type":"array","items":{"type":"integer"}}},{"name":"sort","in":"query","description":"Sort field","schema":{"type":"string","enum":["name","status","date_added","time_in_queue","date_due","assigned_to","last_activity"],"default":"name"}},{"name":"direction","in":"query","description":"Sort direction","schema":{"type":"string","enum":["ASC","DESC"],"default":"ASC"}},{"name":"date_added_start","in":"query","description":"Filter by date added (start, inclusive)","schema":{"type":"string","format":"date"}},{"name":"date_added_end","in":"query","description":"Filter by date added (end, inclusive)","schema":{"type":"string","format":"date"}}],"responses":{"200":{"description":"List of completed queue individuals","headers":{"X-Offset":{"$ref":"#/components/headers/X-Offset"},"X-Per-Page":{"$ref":"#/components/headers/X-Per-Page"},"X-Total-Pages":{"$ref":"#/components/headers/X-Total-Pages"},"X-Page":{"$ref":"#/components/headers/X-Page"}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/QueueIndividualDetail"}}}}},"401":{"$ref":"#/components/responses/NotAuthenticated"},"403":{"$ref":"#/components/responses/NotAuthorized"},"404":{"$ref":"#/components/responses/NotFound"}}}},"/queues/{queue_id}/individuals/{individual_id}":{"get":{"tags":["process queues"],"summary":"View queue individual details by queue and individual ids","security":[{"oauth2":["read:queue_individuals"]}],"operationId":"getQueueIndividualByQueueId","parameters":[{"name":"queue_id","in":"path","description":"The queue's id","required":true,"schema":{"type":"integer"}},{"name":"individual_id","in":"path","description":"The individuals's id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"The queue individual","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProcessQueueIndividualDetail"}}}},"401":{"$ref":"#/components/responses/NotAuthenticated"},"403":{"$ref":"#/components/responses/NotAuthorized"},"404":{"$ref":"#/components/responses/NotFound"}}}},"/queues/{queue_id}/manager":{"post":{"summary":"Add manager to a queue","security":[{"oauth2":["write:queue_managers"]}],"tags":["process queues"],"operationId":"addQueueManager","parameters":[{"name":"queue_id","in":"path","description":"The queue id","required":true,"schema":{"type":"integer"}}],"requestBody":{"description":"The individual ID to add as a manager","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddQueueManager"}}}},"responses":{"201":{"description":"The added queue managers","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ProcessQueueManagerDetail"}}}}},"400":{"$ref":"#/components/responses/NotValid"},"401":{"$ref":"#/components/responses/NotAuthenticated"},"403":{"$ref":"#/components/responses/NotAuthorized"}}}},"/queues/{queue_id}/managers":{"get":{"tags":["process queues"],"summary":"Get the queue's managers","description":"Deprecated endpoint. Use GET /queues/{queue_id:[0-9]+}/managers/queue instead.","security":[{"oauth2":["read:process_queues"]}],"operationId":"getQueueManagers","parameters":[{"name":"queue_id","in":"path","description":"The queue's id","required":true,"schema":{"type":"integer"}},{"$ref":"#/components/parameters/PerPage"},{"$ref":"#/components/parameters/Page"},{"name":"name","in":"query","description":"Partial first and last name search","schema":{"type":"string"}}],"responses":{"200":{"description":"Queue managers list","headers":{"X-Offset":{"$ref":"#/components/headers/X-Offset"},"X-Per-Page":{"$ref":"#/components/headers/X-Per-Page"},"X-Total-Pages":{"$ref":"#/components/headers/X-Total-Pages"},"X-Page":{"$ref":"#/components/headers/X-Page"}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BasicIndividualProfileSerializer"}}}}},"401":{"$ref":"#/components/responses/NotAuthenticated"},"403":{"$ref":"#/components/responses/NotAuthorized"}},"deprecated":true}},"/queues/{queue_id}/managers/{manager_id}":{"delete":{"tags":["process queues"],"summary":"Remove a queue manager","security":[{"oauth2":["write:process_queues"]}],"operationId":"deleteQueueManager","parameters":[{"name":"queue_id","in":"path","description":"The queue's id","required":true,"schema":{"type":"integer"}},{"name":"manager_id","in":"path","description":"The id of the queue manager","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteQueueManager"}}}},"responses":{"200":{"description":"Empty response","content":{}},"401":{"$ref":"#/components/responses/NotAuthenticated"},"403":{"$ref":"#/components/responses/NotAuthorized"},"404":{"$ref":"#/components/responses/NotFound"}}}},"/queues/{queue_id}/managers/queue":{"get":{"summary":"Get the managers of a queue","security":[{"oauth2":["read:queue_managers"]}],"tags":["process queues"],"operationId":"getQueueManagersQueue","parameters":[{"name":"queue_id","in":"path","description":"The queue id","required":true,"schema":{"type":"integer"}},{"$ref":"#/components/parameters/PerPage"},{"$ref":"#/components/parameters/Page"}],"responses":{"200":{"description":"List queue managers","headers":{"X-Offset":{"$ref":"#/components/headers/X-Offset"},"X-Per-Page":{"$ref":"#/components/headers/X-Per-Page"},"X-Total-Pages":{"$ref":"#/components/headers/X-Total-Pages"},"X-Page":{"$ref":"#/components/headers/X-Page"}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ProcessQueueManagerDetail"}}}}},"401":{"$ref":"#/components/responses/NotAuthenticated"},"403":{"$ref":"#/components/responses/NotAuthorized"},"404":{"$ref":"#/components/responses/NotFound"}}}},"/queues_individuals":{"get":{"tags":["process queues"],"summary":"get a list of queue individuals","description":"Deprecated endpoint. Use GET /queue_individuals instead.","security":[{"oauth2":["read:queue_individuals"]}],"operationId":"getStepIndividuals","parameters":[{"$ref":"#/components/parameters/PerPage"},{"$ref":"#/components/parameters/Page"},{"name":"statuses","in":"query","description":"Statuses of individuals in queue","style":"form","explode":true,"schema":{"type":"array","items":{"$ref":"#/components/schemas/ProcessQueueStatuses"}}},{"name":"assignment","in":"query","description":"Include individuals assigned to me or unassigned individuals. If this param is not provided, both will be included","schema":{"type":"string","enum":["ASSIGNED_TO_ME","UNASSIGNED"]}}],"responses":{"200":{"description":"List of queue individuals","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ProcessQueueIndividualDetail"}}}}},"401":{"$ref":"#/components/responses/NotAuthenticated"}},"deprecated":true}},"/queues_individuals/{queueIndividualId}":{"get":{"tags":["process queues"],"summary":"View queue individual details","description":"Deprecated endpoint. Use GET /queue_individuals/{queue_individual_id:[0-9]+} instead.","security":[{"oauth2":["read:queue_individuals"]}],"operationId":"getStepIndividual","parameters":[{"name":"queueIndividualId","in":"path","description":"The queue individual's id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"The queue individual","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProcessQueueIndividualDetail"}}}},"401":{"$ref":"#/components/responses/NotAuthenticated"},"403":{"$ref":"#/components/responses/NotAuthorized"},"404":{"$ref":"#/components/responses/NotFound"}},"deprecated":true},"put":{"tags":["process queues"],"summary":"Updates queue individual","description":"Deprecated endpoint. Use PUT /queue_individuals/{queue_individual_id:[0-9]+} instead.","security":[{"oauth2":["write:queue_individuals"]}],"operationId":"updateQueueIndividualDeprecated","parameters":[{"name":"queueIndividualId","in":"path","description":"The queue individual's id","required":true,"schema":{"type":"integer"}}],"requestBody":{"description":"The individual queue updates","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateQueueIndividualRequest"}}},"required":false},"responses":{"200":{"description":"The queue individual","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProcessQueueIndividualDetail"}}}},"401":{"$ref":"#/components/responses/NotAuthenticated"},"403":{"$ref":"#/components/responses/NotAuthorized"},"404":{"$ref":"#/components/responses/NotFound"}},"x-codegen-request-body-name":"updateQueueIndividualRequest","deprecated":true},"delete":{"tags":["process queues"],"summary":"Remove an individual from a queue","description":"Deprecated endpoint. Use DELETE /queue_individuals/{queue_individual_id:[0-9]+} instead.","security":[{"oauth2":["write:queue_individuals"]}],"operationId":"deleteQueueIndividualDeprecated","parameters":[{"name":"queueIndividualId","in":"path","description":"The queue individual's id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Empty response","content":{}},"401":{"$ref":"#/components/responses/NotAuthenticated"},"403":{"$ref":"#/components/responses/NotAuthorized"},"404":{"$ref":"#/components/responses/NotFound"}},"deprecated":true}},"/queues_individuals/{queueIndividualId}/done":{"post":{"tags":["process queues"],"summary":"Complete the queue individual and perform automations","description":"Deprecated endpoint.","security":[{"oauth2":["write:queue_individuals"]}],"operationId":"completeQueueIndividual","parameters":[{"name":"queueIndividualId","in":"path","description":"The queue individual's id","required":true,"schema":{"type":"integer"}}],"requestBody":{"description":"The automations to perform when completing a queue individual","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CompleteQueueIndividualRequest"}}},"required":false},"responses":{"200":{"description":"The completed queue individual","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProcessQueueIndividualDetail"}}}},"401":{"$ref":"#/components/responses/NotAuthenticated"},"403":{"$ref":"#/components/responses/NotAuthorized"},"404":{"$ref":"#/components/responses/NotFound"}},"x-codegen-request-body-name":"completeQueueIndividual","deprecated":true}},"/queues_individuals/{queueIndividualId}/queue":{"put":{"summary":"Update a queue individual","description":"\"Deprecated endpoint. Use PUT /queue_individuals/{queue_individual_id:[0-9]+} instead. Updates an individual in a queue. Update: status, manager, due date, completed date.\"\n","security":[{"oauth2":["write:queue_individuals"]}],"tags":["process queues"],"operationId":"updateQueueIndividualInternal","parameters":[{"name":"queueIndividualId","in":"path","description":"The queue individual id","required":true,"schema":{"type":"integer"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateQueueIndividualRequestInternal"}}}},"responses":{"200":{"description":"The updated queue individual (mock)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueueIndividualOutput"}}}},"401":{"$ref":"#/components/responses/NotAuthenticated"},"403":{"$ref":"#/components/responses/NotAuthorized"},"404":{"$ref":"#/components/responses/NotFound"}},"deprecated":true}},"/queues_individuals/notifications":{"post":{"tags":["process queues"],"summary":"Send notifications for individuals added to queue","description":"\"Deprecated endpoint. Prefer POST /queue_individuals/notifications instead. Send notifications to one or more queue managers for individuals added to queue.\"\n","security":[{"oauth2":["write:queue_individuals"]}],"operationId":"sendQueueIndividualsNotifications","requestBody":{"description":"Notification type and list of queue individual ids","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendNotificationsRequest"}}}},"responses":{"201":{"description":"Notifications accepted for delivery","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendNotificationsOutput"}}}},"400":{"$ref":"#/components/responses/NotValid"},"401":{"$ref":"#/components/responses/NotAuthenticated"},"403":{"$ref":"#/components/responses/NotAuthorized"},"404":{"$ref":"#/components/responses/NotFound"}},"deprecated":true}},"/individuals/{id}/sacraments":{"get":{"tags":["sacraments"],"summary":"gets individual sacraments","security":[{"oauth2":["read:individuals"]}],"operationId":"getSacrament","parameters":[{"name":"id","in":"path","description":"The individual's id","required":true,"schema":{"type":"integer"}}],"requestBody":{"description":"A sacrament object or array of sacrament objects","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SacramentSerializer"}}},"required":false},"responses":{"200":{"description":"Returns the individuals sacrament","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SacramentSerializer"}}}}},"x-codegen-request-body-name":"GetSacramentRequest"},"post":{"tags":["sacraments"],"summary":"Create individual sacrament","security":[{"oauth2":["write:individuals"]}],"operationId":"createSacrament","parameters":[{"name":"id","in":"path","description":"The individual's id","required":true,"schema":{"type":"integer"}}],"requestBody":{"description":"A sacrament object or array of sacrament objects","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SacramentSerializer"}}},"required":false},"responses":{"201":{"description":"Returns the sacrament","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SacramentSerializer"}}}}},"x-codegen-request-body-name":"CreateSacramentRequest"}},"/individuals/{individual_id}/sacraments/{id}":{"put":{"tags":["sacraments"],"summary":"Update individual sacrament","security":[{"oauth2":["write:individuals"]}],"operationId":"updateIndividualSacrament","parameters":[{"name":"individual_id","in":"path","description":"The individual's id","required":true,"schema":{"type":"integer"}},{"name":"id","in":"path","description":"The sacrament id","required":true,"schema":{"type":"integer"}}],"requestBody":{"description":"Update a sacrament object or array of sacrament objects","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SacramentSerializer"}}},"required":false},"responses":{"201":{"description":"Returns the sacrament","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SacramentSerializer"}}}}},"x-codegen-request-body-name":"UpdateIndividualSacramentRequest"},"delete":{"tags":["sacraments"],"summary":"Delete an individual sacrament","security":[{"oauth2":["write:individuals"]}],"operationId":"deleteIndividualSacrament","parameters":[{"name":"individual_id","in":"path","description":"The individual's id","required":true,"schema":{"type":"integer"}},{"name":"id","in":"path","description":"The sacrament id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Empty response","content":{}}}}},"/saved_searches/{individual_id}/list":{"get":{"tags":["saved searches"],"summary":"Search for a user's list of saved advanced searches","security":[{"oauth2":["read:advanced_searches"]}],"operationId":"getSavedAdvancedSearchesList","parameters":[{"$ref":"#/components/parameters/PerPage"},{"$ref":"#/components/parameters/Page"},{"name":"individual_id","in":"path","description":"The individual's id","required":true,"schema":{"type":"integer"}},{"name":"insight_id","in":"query","description":"The id of the insight domain","required":true,"schema":{"type":"integer"}},{"name":"search_term","in":"query","description":"The string to search for within saved search names","schema":{"type":"string"}},{"name":"is_owner","in":"query","description":"Denotes if the individual is the owner of a saved search","schema":{"type":"boolean"}}],"responses":{"200":{"description":"Individual saved search details\n","headers":{"X-Offset":{"$ref":"#/components/headers/X-Offset"},"X-Per-Page":{"$ref":"#/components/headers/X-Per-Page"},"X-Total-Pages":{"$ref":"#/components/headers/X-Total-Pages"},"X-Page":{"$ref":"#/components/headers/X-Page"}},"content":{"application/json":{"schema":{"type":"object"}}}},"401":{"$ref":"#/components/responses/NotAuthenticated"},"403":{"$ref":"#/components/responses/NotAuthorized"}}}},"/saved_searches/{individual_id}":{"get":{"tags":["saved searches"],"summary":"Search for the user's saved searches","security":[{"oauth2":["read:advanced_searches"]}],"operationId":"getSavedAdvancedSearches","parameters":[{"name":"individual_id","in":"path","description":"The individual's id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Saved search details associated with the given individual id\n","headers":{"X-Offset":{"$ref":"#/components/headers/X-Offset"},"X-Per-Page":{"$ref":"#/components/headers/X-Per-Page"},"X-Total-Pages":{"$ref":"#/components/headers/X-Total-Pages"},"X-Page":{"$ref":"#/components/headers/X-Page"}},"content":{"application/json":{"schema":{"type":"object"}}}},"401":{"$ref":"#/components/responses/NotAuthenticated"},"403":{"$ref":"#/components/responses/NotAuthorized"}}}},"/saved_searches/search/{id}":{"get":{"tags":["saved searches"],"summary":"Search for an advanced search.","security":[{"oauth2":["read:advanced_searches"]}],"operationId":"getSavedAdvancedSearch","parameters":[{"$ref":"#/components/parameters/PerPage"},{"$ref":"#/components/parameters/Page"},{"name":"id","in":"path","description":"The id of the saved search","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"The details of the saved search for the given search id\n","headers":{"X-Offset":{"$ref":"#/components/headers/X-Offset"},"X-Per-Page":{"$ref":"#/components/headers/X-Per-Page"},"X-Total-Pages":{"$ref":"#/components/headers/X-Total-Pages"},"X-Page":{"$ref":"#/components/headers/X-Page"}},"content":{"application/json":{"schema":{"type":"object"}}}},"401":{"$ref":"#/components/responses/NotAuthenticated"},"403":{"$ref":"#/components/responses/NotAuthorized"}}}},"/saved_searches/{individual_id}/search/{id}":{"delete":{"tags":["saved searches"],"summary":"Delete an advanced search","security":[{"oauth2":["write:advanced_searches"]}],"operationId":"deleteSavedSearch","parameters":[{"name":"individual_id","in":"path","description":"The individual id associated with the saved search","required":true,"schema":{"type":"integer"}},{"name":"id","in":"path","description":"The saved search's id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Empty response\n","content":{}},"401":{"$ref":"#/components/responses/NotAuthenticated"},"403":{"$ref":"#/components/responses/NotAuthorized"}}}},"/saved_searches/{individual_id}/search/{saved_search_id}/leave":{"delete":{"tags":["saved searches"],"summary":"Removes an individual's association with a saved search.","security":[{"oauth2":["write:advanced_searches"]}],"operationId":"leaveSavedSearch","parameters":[{"name":"individual_id","in":"path","description":"The individual's id","required":true,"schema":{"type":"integer"}},{"name":"saved_search_id","in":"path","description":"The saved search's id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Empty response\n","content":{}},"401":{"$ref":"#/components/responses/NotAuthenticated"},"403":{"$ref":"#/components/responses/NotAuthorized"}}}},"/saved_searches/search/{search_id}/individual/{individual_id}":{"get":{"tags":["saved searches"],"summary":"Get the individual associated with the saved search","security":[{"oauth2":["read:advanced_searches"]}],"operationId":"getSavedAdvancedSearchIndividual","parameters":[{"name":"search_id","in":"path","description":"The search's id","required":true,"schema":{"type":"integer"}},{"name":"individual_id","in":"path","description":"The individual's id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Details about the individual and individual saved search\n","headers":{"X-Offset":{"$ref":"#/components/headers/X-Offset"},"X-Per-Page":{"$ref":"#/components/headers/X-Per-Page"},"X-Total-Pages":{"$ref":"#/components/headers/X-Total-Pages"},"X-Page":{"$ref":"#/components/headers/X-Page"}},"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/BasicIndividualProfileSerializer"},{"$ref":"#/components/schemas/IndividualSavedSearchDetails"}]}}}},"401":{"$ref":"#/components/responses/NotAuthenticated"},"403":{"$ref":"#/components/responses/NotAuthorized"}}},"put":{"tags":["saved searches"],"summary":"Update and share individual saved searches","security":[{"oauth2":["write:advanced_searches"]}],"operationId":"addUpdateSavedAdvancedSearchIndividual","parameters":[{"name":"search_id","in":"path","description":"The search's id","required":true,"schema":{"type":"integer"}},{"name":"individual_id","in":"path","description":"The individual's id","required":true,"schema":{"type":"integer"}}],"requestBody":{"description":"Individual saved search fields","content":{"application/json":{"schema":{"type":"object","properties":{"is_starred":{"type":"boolean","description":"Whether the individual has starred the saved search"},"is_owner":{"type":"boolean","description":"Whether the individual is the owner of the saved search"},"can_edit":{"type":"boolean","description":"Whether or not the individual will be allowed to edit the saved search"},"remove":{"type":"boolean","description":"Remove the individual's association with this saved search"}}}}},"required":false},"responses":{"200":{"description":"","headers":{"X-Offset":{"$ref":"#/components/headers/X-Offset"},"X-Per-Page":{"$ref":"#/components/headers/X-Per-Page"},"X-Total-Pages":{"$ref":"#/components/headers/X-Total-Pages"},"X-Page":{"$ref":"#/components/headers/X-Page"}},"content":{"application/json":{"schema":{"type":"object"}}}},"401":{"$ref":"#/components/responses/NotAuthenticated"},"403":{"$ref":"#/components/responses/NotAuthorized"}},"x-codegen-request-body-name":"IndividualSavedSearchParams"}},"/saved_searches/search/{search_id}/individual/{individual_id}/star":{"put":{"tags":["saved searches"],"summary":"Update whether a saved search is starred or not.","security":[{"oauth2":["write:advanced_searches"]}],"operationId":"updateSavedSearchIndividualStar","parameters":[{"name":"search_id","in":"path","description":"The search's id","required":true,"schema":{"type":"integer"}},{"name":"individual_id","in":"path","description":"The individual's id","required":true,"schema":{"type":"integer"}}],"requestBody":{"description":"Whether the saved search is starred or not","content":{"application/json":{"schema":{"type":"boolean"}}},"required":true},"responses":{"200":{"description":"Details about the individual and individual saved search\n","headers":{"X-Offset":{"$ref":"#/components/headers/X-Offset"},"X-Per-Page":{"$ref":"#/components/headers/X-Per-Page"},"X-Total-Pages":{"$ref":"#/components/headers/X-Total-Pages"},"X-Page":{"$ref":"#/components/headers/X-Page"}},"content":{"application/json":{"schema":{"type":"object"}}}},"401":{"$ref":"#/components/responses/NotAuthenticated"},"403":{"$ref":"#/components/responses/NotAuthorized"}},"x-codegen-request-body-name":"is_starred"}},"/saved_searches/search/{search_id}/individuals":{"get":{"tags":["saved searches"],"summary":"Get the individuals associated with the saved search","security":[{"oauth2":["read:advanced_searches"]}],"operationId":"getSavedAdvancedSearchIndividuals","parameters":[{"$ref":"#/components/parameters/PerPage"},{"$ref":"#/components/parameters/Page"},{"name":"search_id","in":"path","description":"The saved search's id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Details about the indivdual and individual saved search\n","headers":{"X-Offset":{"$ref":"#/components/headers/X-Offset"},"X-Per-Page":{"$ref":"#/components/headers/X-Per-Page"},"X-Total-Pages":{"$ref":"#/components/headers/X-Total-Pages"},"X-Page":{"$ref":"#/components/headers/X-Page"}},"content":{"application/json":{"schema":{"type":"object"}}}},"401":{"$ref":"#/components/responses/NotAuthenticated"},"403":{"$ref":"#/components/responses/NotAuthorized"}}}},"/saved_searches/duplicate/{id}":{"post":{"tags":["saved searches"],"summary":"Create a duplicate of a saved search","security":[{"oauth2":["write:advanced_searches"]}],"operationId":"duplicateSavedAdvancedSearch","parameters":[{"name":"id","in":"path","description":"The saved search's id to duplicate","required":true,"schema":{"type":"integer"}}],"requestBody":{"description":"The saved search name","content":{"application/json":{"schema":{"type":"string"}}},"required":true},"responses":{"200":{"description":"Details of the duplicated saved search\n","headers":{"X-Offset":{"$ref":"#/components/headers/X-Offset"},"X-Per-Page":{"$ref":"#/components/headers/X-Per-Page"},"X-Total-Pages":{"$ref":"#/components/headers/X-Total-Pages"},"X-Page":{"$ref":"#/components/headers/X-Page"}},"content":{"application/json":{"schema":{"type":"object"}}}},"401":{"$ref":"#/components/responses/NotAuthenticated"},"403":{"$ref":"#/components/responses/NotAuthorized"}},"x-codegen-request-body-name":"name"}},"/scheduling/categories":{"get":{"tags":["scheduling"],"summary":"Gets all categories","security":[{"oauth2":["read:scheduling"]}],"operationId":"getScheduleCategories","requestBody":{"description":"filters the categories","content":{"*/*":{"schema":{"type":"object","properties":{"search_term":{"type":"string","description":"Search team used to search categories by name"},"status":{"type":"string","enum":["ACTIVE","ARCHIVED","ACTIVE_AND_ARCHIVED"]}}}}},"required":false},"responses":{"200":{"description":"Returns the list of categories","content":{"*/*":{"schema":{"$ref":"#/components/schemas/CategorySerializer"}}}}},"x-codegen-request-body-name":"category"},"post":{"tags":["scheduling"],"summary":"Creates a new category e.g. Children's Ministry","security":[{"oauth2":["write:scheduling"]}],"operationId":"createScheduleCategory","requestBody":{"description":"The category","content":{"application/json":{"schema":{"type":"object","properties":{"campus_id":{"type":"integer"},"name":{"type":"string"},"recurrence_pattern":{"type":"string","enum":["DAILY","WEEKLY","DOES_NOT_REPEAT"]},"default_assignment_status":{"type":"string","enum":["PENDING","ASSIGNED"]},"teams":{"type":"array","items":{"$ref":"#/components/schemas/TeamRequestBody"}},"events":{"type":"array","items":{"$ref":"#/components/schemas/ScheduleEventRequestBody"}},"associated_times":{"type":"array","items":{"$ref":"#/components/schemas/ScheduleEventRequestBody"}}}}}},"required":false},"responses":{"201":{"description":"Returns the category","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CategorySerializer"}}}}},"x-codegen-request-body-name":"category"}},"/scheduling/categories/{id}":{"get":{"tags":["scheduling"],"summary":"Gets a category","security":[{"oauth2":["read:scheduling"]}],"operationId":"getScheduleCategory","parameters":[{"name":"id","in":"path","description":"The category's id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Returns the category","content":{"*/*":{"schema":{"$ref":"#/components/schemas/CategorySerializer"}}}}}},"put":{"tags":["scheduling"],"summary":"Updates a category","security":[{"oauth2":["write:scheduling"]}],"operationId":"updateScheduleCategory","parameters":[{"name":"id","in":"path","description":"The category's id","required":true,"schema":{"type":"integer"}}],"requestBody":{"description":"The category","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"allowed_replacement_type":{"type":"string","enum":["NONE","CATEGORY","TEAM","POSITION"]},"child_work_approved_required":{"type":"boolean"},"archived":{"type":"boolean"},"default_assignment_status":{"type":"string","enum":["PENDING","ASSIGNED"]},"week_starts_on_day":{"type":"string","enum":["SUNDAY","MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY"]}}}}},"required":false},"responses":{"201":{"description":"Returns the updated category","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CategorySerializer"}}}}},"x-codegen-request-body-name":"category"},"delete":{"tags":["scheduling"],"summary":"Deletes a category","security":[{"oauth2":["read:scheduling"]}],"operationId":"deleteScheduleCategory","parameters":[{"name":"id","in":"path","description":"The category's id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Deletes the category","content":{"*/*":{"schema":{"$ref":"#/components/schemas/CategorySerializer"}}}}}}},"/scheduling/categories/{id}/organizers":{"parameters":[{"name":"id","in":"path","description":"Category id","required":true,"schema":{"type":"integer"}}],"get":{"tags":["scheduling"],"summary":"Get category's organizers","security":[{"oauth2":["read:scheduling"]}],"operationId":"getCategoryOrganizers","responses":{"200":{"description":"Returns category's organizers","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BasicIndividualProfileSerializer"}}}}}}},"post":{"tags":["scheduling"],"summary":"Create new category organizer","security":[{"oauth2":["write:scheduling"]}],"operationId":"createCategoryOrganizer","requestBody":{"description":"The individual id to add as a category's organizer","content":{"application/json":{"schema":{"type":"object","properties":{"individual_id":{"type":"integer"}}}}}},"responses":{"201":{"description":"Returns category's organizers","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BasicIndividualProfileSerializer"}}}}}}},"/scheduling/categories/{id}/schedules":{"delete":{"tags":["scheduling"],"summary":"Delete multiple schedules","security":[{"oauth2":["write:scheduling"]}],"operationId":"deleteSchedules","parameters":[{"name":"id","in":"path","description":"Category id","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"schedule_ids":{"type":"array","items":{"type":"integer","minimum":1}}},"required":["schedule_ids"]}}},"required":true},"responses":{"200":{"description":"Empty response","content":{}},"400":{"description":"Schedules not specified or not found","content":{}},"403":{"$ref":"#/components/responses/NotAuthorized"}}},"get":{"tags":["scheduling"],"summary":"Get schedules for a category","security":[{"oauth2":["read:scheduling"]}],"operationId":"getSchedules","parameters":[{"name":"id","in":"path","description":"Category id","required":true,"schema":{"type":"integer"}},{"name":"schedule_ids","in":"query","description":"list of ids","schema":{"type":"string"}},{"name":"sort","in":"query","description":"sort order of schedule dates","schema":{"type":"string","default":"DESC","enum":["DESC","ASC"]}},{"$ref":"#/components/parameters/PerPage"},{"$ref":"#/components/parameters/Page"},{"name":"after","in":"query","description":"Will return schedules with an end date after given date","schema":{"type":"string","format":"date"}},{"name":"before","in":"query","description":"Will return schedules with an end date before given date and sort by descending","schema":{"type":"string","format":"date"}},{"name":"between","in":"query","description":"Weill return schedules with an end date after the given start date and schedules with a start date before the given end date","schema":{"type":"object","properties":{"end":{"type":"string","format":"date"},"start":{"type":"string","format":"date"}}}},{"name":"getFullSchedules","in":"query","description":"Will return event teams for each scheduling event as well as assignments and associated times.","schema":{"type":"boolean","default":false}},{"name":"withMetrics","in":"query","description":"Will attach assignment metrics to the schedule entity and also each event in the schedule.","schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"Returns schedules with scheduling events.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ScheduleSerializer"}}}}}}},"post":{"tags":["scheduling"],"summary":"Create new schedules","security":[{"oauth2":["write:scheduling"]}],"operationId":"createCategorySchedules","parameters":[{"name":"id","in":"path","description":"Category id","required":true,"schema":{"type":"integer"}}],"requestBody":{"description":"The new schedules options","content":{"application/json":{"schema":{"type":"object","properties":{"count":{"type":"integer","description":"the count of new schedules to create"},"schedule_dates":{"type":"array","items":{"type":"string","format":"date"}}}}}},"required":false},"responses":{"201":{"description":"Returns schedules","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SchedulesSerializer"}}}}},"x-codegen-request-body-name":"options"}},"/scheduling/categories/{id}/available_schedule_dates":{"get":{"tags":["scheduling"],"summary":"Get available schedule dates for a category","security":[{"oauth2":["read:scheduling"]}],"operationId":"getScheduleDates","parameters":[{"name":"id","in":"path","description":"Category id","required":true,"schema":{"type":"integer"}},{"$ref":"#/components/parameters/PerPage"},{"$ref":"#/components/parameters/Page"}],"responses":{"200":{"description":"Returns available schedule dates","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AvailableScheduleDateSerializer"}}}}}}}},"/scheduling/categories/{id}/files":{"post":{"tags":["scheduling"],"summary":"Upload file for category","security":[{"oauth2":["write:scheduling"]}],"operationId":"createCategoryFile","parameters":[{"name":"id","in":"path","description":"Category id","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"properties":{"file":{"type":"string","description":"File to upload","format":"binary"}}}}}},"responses":{"201":{"description":"Returns a file serializer","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FileSerializer"}}}}}}},"/scheduling/categories/{id}/serving_rotations":{"get":{"tags":["scheduling"],"summary":"Get serving rotations for a category","security":[{"oauth2":["read:scheduling"]}],"operationId":"getServingRotations","parameters":[{"name":"id","in":"path","description":"Category id","required":true,"schema":{"type":"integer"}},{"name":"get_full_serving_rotations","in":"query","description":"Get the full rotation or only the base data","schema":{"type":"boolean"}}],"responses":{"200":{"description":"Returns the serving rotations for a category","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ServingRotationSerializer"}}}}}}},"put":{"tags":["scheduling"],"summary":"Update a serving rotation","security":[{"oauth2":["write:scheduling"]}],"operationId":"updateServingRotationPlan","parameters":[{"name":"id","in":"path","description":"Category id","required":true,"schema":{"type":"integer"}}],"requestBody":{"description":"The serving rotation","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"}}}}},"required":false},"responses":{"201":{"description":"Returns the updated serving rotation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServingRotationSerializer"}}}}},"x-codegen-request-body-name":"servingRotation"},"post":{"tags":["scheduling"],"summary":"Create a serving rotation","security":[{"oauth2":["write:scheduling"]}],"operationId":"createServingRotationPlan","parameters":[{"name":"id","in":"path","description":"Category id","required":true,"schema":{"type":"integer"}}],"requestBody":{"description":"The serving rotation","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"}}}}},"required":false},"responses":{"201":{"description":"Returns the created serving rotation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServingRotationSerializer"}}}}},"x-codegen-request-body-name":"servingRotation"},"delete":{"tags":["scheduling"],"summary":"Delete a serving rotation","security":[{"oauth2":["write:scheduling"]}],"operationId":"deleteServingRotationPlan","parameters":[{"name":"id","in":"path","description":"Category id","required":true,"schema":{"type":"integer"}}],"requestBody":{"description":"The serving rotation","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"}}}}},"required":false},"responses":{"200":{"description":"Returns empty response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServingRotationSerializer"}}}}},"x-codegen-request-body-name":"servingRotation"}},"/scheduling/categories/{id}/notifications":{"post":{"tags":["scheduling"],"summary":"Sends notifications","security":[{"oauth2":["write:scheduling"]}],"operationId":"sendScheduleCategoryNotifications","parameters":[{"name":"id","in":"path","description":"The category's id","required":true,"schema":{"type":"integer"}}],"requestBody":{"description":"Notifies volunteers via email and text to their scheduling requests.","content":{"*/*":{"schema":{"type":"object","properties":{"schedule_ids":{"type":"array","items":{"type":"integer"},"description":"List of schedule IDs to send notifications for"},"event_ids":{"type":"array","items":{"type":"integer"},"description":"List of event IDs to send notifications for"},"subject":{"type":"string","description":"Email subject line"},"message":{"type":"string","description":"Email message content"},"notified_status":{"type":"string","enum":["NOTIFIED","NOT_NOTIFIED","NOTIFIED_AND_NOT_NOTIFIED"],"description":"Filter recipients by notification status"},"dry_run":{"type":"boolean","description":"If this is set to true the emails will not be sent. Dry run is now deprecated, it's recommended to use the getNotificationMetrics endpoint instead.","default":true,"deprecated":true},"excluded_individual_ids":{"type":"array","items":{"type":"integer"},"description":"List of individual IDs to exclude from notifications"},"file_ids":{"type":"array","items":{"type":"integer"},"description":"List of file IDs to attach to the notification"}},"required":["schedule_ids"]}}},"required":true},"responses":{"200":{"description":"Returns empty response","content":{}}},"x-codegen-request-body-name":"schedulingNotificationRequest"}},"/scheduling/categories/{id}/notifications/metrics":{"get":{"tags":["scheduling"],"summary":"Gets notification metrics","security":[{"oauth2":["read:scheduling"]}],"operationId":"getNotificationMetrics","parameters":[{"name":"id","in":"path","description":"The category's id","required":true,"schema":{"type":"integer"}},{"name":"notification_context","description":"The context of the notification","in":"query","required":true,"schema":{"type":"string","enum":["ALERT_VOLUNTEERS","MESSAGE_VOLUNTEERS","SEND_REQUESTS"]}},{"name":"schedule_ids","description":"The schedule ids to filter by","in":"query","schema":{"type":"integer"}},{"name":"event_ids","description":"The event ids to filter by","in":"query","schema":{"type":"integer"}},{"name":"notification_statuses","description":"The notification statuses to filter by","in":"query","schema":{"type":"string","enum":["NOTIFIED","NOT_NOTIFIED","ALL"]}}],"responses":{"200":{"description":"Returns the notification metrics","$ref":"#/components/responses/GetScheduleNotificationMetricsResponse"}}}},"/scheduling/categories/{id}/messages":{"post":{"tags":["scheduling"],"summary":"Sends notifications","security":[{"oauth2":["write:scheduling"]}],"operationId":"messageVolunteers","parameters":[{"name":"id","in":"path","description":"The category's id","required":true,"schema":{"type":"integer"}}],"requestBody":{"description":"Sends a message to the volunteers for a team, schedules, or serving rotations via email. Text is unavailable for this schedule message type.","content":{"multipart/form-data":{"schema":{"properties":{"files":{"type":"array","description":"the files to attach to the message","items":{"type":"string","format":"binary"}},"subject":{"type":"string","description":"the subject of the message"},"body":{"type":"string","description":"the body of the message"},"position_ids":{"type":"array","description":"the position ids to filter volunteers by","items":{"type":"integer"}},"statuses":{"type":"array","description":"the statuses to filter volunteers by","items":{"type":"string","enum":["PENDING","ACCEPTED","DECLINED","CHECKED_IN"]}},"schedule_ids":{"type":"array","description":"the schedule ids to filter volunteers by","items":{"type":"integer"}},"serving_rotation_ids":{"type":"array","description":"the serving rotation ids to filter volunteers by","items":{"type":"integer"}},"event_ids":{"type":"array","description":"the event ids to filter volunteers by","items":{"type":"integer"}},"excluded_individual_ids":{"type":"array","description":"individual ids to exclude from the message recipients","items":{"type":"integer"}},"include_public_signups":{"type":"boolean","description":"whether to include public signups in the message recipients (cannot be used with serving_rotation_ids)","default":false},"send_scheduler_copy":{"type":"boolean","description":"When true, a preview email will be sent to the scheduler only.","default":false},"dry_run":{"type":"boolean","description":"If this is set to true the emails will not be sent. Dry run is now deprecated, it's recommended to use the getNotificationMetrics endpoint instead.","default":true,"deprecated":true}}}}}},"responses":{"200":{"description":"Returns the count of messages sent","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VolunteerMessageSerializer"}}}}}}},"/scheduling/categories/{id}/individuals":{"get":{"tags":["scheduling"],"summary":"Gets individuals serving in a category","security":[{"oauth2":["read:scheduling"]}],"operationId":"getCategoryIndividuals","parameters":[{"name":"id","in":"path","description":"The category's id","required":true,"schema":{"type":"integer"}},{"$ref":"#/components/parameters/PerPage"},{"$ref":"#/components/parameters/Page"}],"requestBody":{"description":"filters the individuals serving in a category","content":{"application/json":{"schema":{"type":"object","properties":{"has_email":{"type":"boolean"},"has_mobile_phone":{"type":"boolean"},"has_been_notified":{"type":"boolean","description":"do they have at least one assignment there they have or have not been notified"},"schedule_ids":{"type":"array","description":"the schedule ids to filter individuals by","items":{"type":"integer"}},"position_ids":{"type":"array","description":"the position ids to filter individuals by","items":{"type":"integer"}},"statuses":{"type":"array","description":"the statuses to filter individuals by","items":{"type":"string","enum":["PENDING","ACCEPTED","DECLINED","CHECKED_IN"]}},"serving_rotation_ids":{"type":"array","description":"the serving rotation ids to filter individuals by","items":{"type":"integer"}}}}}},"required":false},"responses":{"200":{"description":"Returns the individuals","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SchedulingIndividualSerializer"}}}}}},"x-codegen-request-body-name":"categoryIndividualsRequest"}},"/scheduling/categories/{id}/events":{"delete":{"tags":["scheduling"],"summary":"Delete multiple schedule events","security":[{"oauth2":["write:scheduling"]}],"operationId":"deleteScheduleEvents","parameters":[{"name":"id","in":"path","description":"The category's id","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"event_ids":{"type":"array","items":{"type":"integer","minimum":1}}},"required":["event_ids"]}}},"required":true},"responses":{"200":{"description":"Empty response","content":{}},"400":{"description":"Schedule events not specified or not found","content":{}},"403":{"$ref":"#/components/responses/NotAuthorized"}}},"get":{"tags":["scheduling"],"summary":"Gets events in the category","security":[{"oauth2":["read:scheduling"]}],"operationId":"getCategoryEvents","parameters":[{"name":"id","in":"path","description":"The category's id","required":true,"schema":{"type":"integer"}},{"$ref":"#/components/parameters/PerPage"},{"$ref":"#/components/parameters/Page"},{"name":"end_date","in":"query","description":"The ending date for the event","schema":{"type":"string","format":"date"}},{"name":"exclude_empty","in":"query","description":"Exclude events with empty assignments","schema":{"type":"boolean"}}],"responses":{"200":{"description":"Returns the events","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SchedulingEventSerializer"}}}}}}}},"/scheduling/search_individuals":{"post":{"tags":["scheduling"],"summary":"Use `POST /search/scheduling_individuals/results` instead","security":[{"oauth2":["read:scheduling"]}],"operationId":"searchForSchedulingIndividuals","parameters":[{"$ref":"#/components/parameters/PerPage"},{"$ref":"#/components/parameters/Page"},{"$ref":"#/components/parameters/PerformUnsavedAdvancedSearchRequestDeprecated"},{"name":"event_position_id","in":"query","description":"event position to get projected alerts for","schema":{"type":"integer"}}],"responses":{"200":{"description":"The search results","headers":{"X-Offset":{"$ref":"#/components/headers/X-Offset"},"X-Per-Page":{"$ref":"#/components/headers/X-Per-Page"},"X-Total-Pages":{"$ref":"#/components/headers/X-Total-Pages"},"X-Page":{"$ref":"#/components/headers/X-Page"}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SchedulingIndividualSerializer"}}}}},"401":{"$ref":"#/components/responses/NotAuthenticated"},"403":{"$ref":"#/components/responses/NotAuthorized"}},"deprecated":true}},"/scheduling/schedules/{id}":{"get":{"tags":["scheduling"],"summary":"Get a schedule","security":[{"oauth2":["read:scheduling"]}],"operationId":"getSchedule","parameters":[{"name":"id","in":"path","description":"The schedule id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Returns schedules","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ScheduleSerializer"}}}}}},"put":{"tags":["scheduling"],"summary":"Updates the schedule","security":[{"oauth2":["write:scheduling"]}],"operationId":"updateSchedule","parameters":[{"name":"id","in":"path","description":"The schedule id","required":true,"schema":{"type":"integer"}},{"name":"apply_settings_to_all","in":"query","description":"whether or not the settings of the target schedule should be applied to all future schedules","schema":{"type":"boolean"}}],"requestBody":{"description":"Schedule details","content":{"application/json":{"schema":{"type":"object","properties":{"events":{"type":"array","items":{"$ref":"#/components/schemas/ScheduleEventRequestBody"}},"associated_times":{"type":"array","items":{"$ref":"#/components/schemas/ScheduleEventRequestBody"}},"same_people_serve_all_times":{"type":"boolean"},"serving_reminder_message":{"type":"string"},"serving_reminder_times":{"type":"array","items":{"$ref":"#/components/schemas/ScheduleServingReminderTimesRequestBody"}}}}}},"required":false},"responses":{"200":{"description":"Returns the updated schedule","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScheduleSerializer"}}}}},"x-codegen-request-body-name":"scheduleRequest"},"delete":{"tags":["scheduling"],"summary":"Delete a schedule","security":[{"oauth2":["write:scheduling"]}],"operationId":"deleteSchedule","parameters":[{"name":"id","in":"path","description":"The schedule id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Empty response","content":{}}}}},"/scheduling/schedules/{id}/serving_reminder_times":{"get":{"tags":["scheduling"],"summary":"Get the serving reminder times for the schedule","security":[{"oauth2":["write:scheduling"]}],"operationId":"getServingReminderTimes","parameters":[{"name":"id","in":"path","description":"The schedule id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Returns the serving reminder time","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ServingReminderTimeSerializer"}}}}}}},"post":{"tags":["scheduling"],"summary":"Create a serving reminder time","security":[{"oauth2":["write:scheduling"]}],"operationId":"createServingReminderTime","parameters":[{"name":"id","in":"path","description":"The schedule id","required":true,"schema":{"type":"integer"}}],"requestBody":{"description":"The serving reminder time","content":{"application/json":{"schema":{"type":"object","properties":{"days_before":{"type":"integer","description":"An integer from 1 to 7"},"time_of_day":{"type":"string","description":"The time of day in HH:MM format"}}}}},"required":false},"responses":{"200":{"description":"Returns the serving reminder time","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ServingReminderTimeSerializer"}}}}},"x-codegen-request-body-name":"servingReminderTimeRequest"}},"/scheduling/schedules/{id}/message_schedulers":{"post":{"tags":["scheduling"],"summary":"Sends a message to the schedule's schedulers","security":[{"oauth2":["write:scheduling"]},{"oauth2":["write:scheduling_assignments"]}],"operationId":"messageSchedulers","parameters":[{"name":"id","in":"path","description":"The schedule id","required":true,"schema":{"type":"integer"}}],"requestBody":{"description":"message the schedulers for a schedule","content":{"application/json":{"schema":{"type":"object","properties":{"assignment_id":{"type":"string"},"event_position_id":{"type":"string"},"message":{"type":"string"}}}}},"required":false},"responses":{"200":{"description":"Empty body","content":{}}},"x-codegen-request-body-name":"messageSchedulersRequest"}},"/scheduling/schedules/{id}/open_schedule_notifications":{"post":{"tags":["scheduling"],"summary":"Sends schedule notification for open positions","security":[{"oauth2":["write:scheduling"]}],"operationId":"openScheduleNotification","parameters":[{"name":"id","in":"path","description":"The schedule id","required":true,"schema":{"type":"integer"}}],"requestBody":{"description":"Notifies volunteers about open positions they can sign up for in a schedule.","content":{"application/json":{"schema":{"type":"object","properties":{"subject":{"type":"string","description":"The subject line for the notification email"},"message":{"type":"string","description":"The message that will be sent to volunteers in the recipient list. Required when dry_run is false."},"dry_run":{"type":"boolean","description":"If this is set to true the emails will not be sent. Dry run is now deprecated, it's recommended to use the getNotificationMetrics endpoint instead.","default":true,"deprecated":true},"excluded_individual_ids":{"type":"array","description":"Pass in an array of individual ids that represent who should not be included in the recipient list.","items":{"type":"integer"},"default":[]},"file_ids":{"type":"array","description":"Array of file IDs to attach to the notification","items":{"type":"integer"},"default":[]},"send_scheduler_copy":{"type":"boolean","description":"When true, a preview email will be sent to the scheduler only.","default":false}}}}},"required":true},"responses":{"201":{"description":"Returns the count of messages sent","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VolunteerMessageSerializer"}}}},"400":{"description":"Schedule must be opened to notify volunteers","content":{}},"403":{"$ref":"#/components/responses/NotAuthorized"}},"x-codegen-request-body-name":"sendOpenScheduleNotificationRequest"}},"/scheduling/schedules/{id}/open_schedule_notifications/recipients":{"get":{"tags":["scheduling"],"summary":"Gets recipient info","security":[{"oauth2":["read:scheduling"]}],"operationId":"openScheduleNotificationRecipients","parameters":[{"name":"id","in":"path","description":"The schedule id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Returns the recipient information for sending open schedule notifications","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SchedulingIndividualSerializer"}}}}},"403":{"$ref":"#/components/responses/NotAuthorized"}}}},"/scheduling/schedules/{id}/open_event_positions":{"put":{"tags":["scheduling"],"summary":"Sets event positions as open or closed","security":[{"oauth2":["write:scheduling"]}],"operationId":"openEventPositions","parameters":[{"name":"id","in":"path","description":"The schedule id","required":true,"schema":{"type":"integer"}}],"requestBody":{"description":"The positions and their open values","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"position_id":{"type":"integer"},"is_open":{"type":"boolean"}}}}}},"required":false},"responses":{"200":{"description":"Empty body","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BasicEventPositionSerializer"}}}}}},"x-codegen-request-body-name":"openEventPositionsRequest"}},"/scheduling/events/{id}/set_checkin_labels":{"put":{"tags":["scheduling"],"summary":"Sets event checkin labels status","security":[{"oauth2":["write:scheduling"]}],"operationId":"setCheckinLabels","parameters":[{"name":"id","in":"path","description":"The event id","required":true,"schema":{"type":"integer"}}],"requestBody":{"description":"The positions and their checkin label values","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"position_id":{"type":"integer"},"should_print_checkin_label":{"type":"boolean"}}}}}},"required":false},"responses":{"200":{"description":"Empty body","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BasicEventPositionSerializer"}}}}}},"x-codegen-request-body-name":"checkinLabelEventPositionsRequest"}},"/scheduling/event_positions/{id}":{"put":{"tags":["scheduling"],"summary":"Updates the quantity required for an event position","security":[{"oauth2":["write:scheduling"]}],"operationId":"updateEventPosition","parameters":[{"name":"id","in":"path","description":"The event position id","required":true,"schema":{"type":"integer"}}],"requestBody":{"description":"Quantity needed for the event position","content":{"application/json":{"schema":{"type":"object","properties":{"quantity":{"type":"integer"}}}}},"required":false},"responses":{"200":{"description":"Returns the event position","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BasicEventPositionSerializer"}}}}},"x-codegen-request-body-name":"eventPositionRequest"}},"/scheduling/event_positions/{id}/assignments":{"post":{"tags":["scheduling"],"summary":"Creates a event position assignment","security":[{"oauth2":["write:scheduling"]}],"operationId":"createEventPositionAssignment","parameters":[{"name":"id","in":"path","description":"The event position's id","required":true,"schema":{"type":"integer"}}],"requestBody":{"description":"The individual ids to create assignments for","content":{"application/json":{"schema":{"type":"object","properties":{"individual_ids":{"type":"array","items":{"type":"integer"}},"update_existing_status":{"type":"boolean"}}}}},"required":false},"responses":{"201":{"description":"Returns the event position assignments created","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AssignmentSerializer"}}}}}},"x-codegen-request-body-name":"createAssignmentRequest"}},"/scheduling/event_positions/{id}/candidates":{"get":{"tags":["scheduling"],"summary":"Returns candidates for an event position","security":[{"oauth2":["read:scheduling"]}],"operationId":"getEventPositionCandidates","parameters":[{"name":"id","in":"path","description":"The serving rotation position id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Returns the candidates","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/VolunteerSerializer"}}}}}}}},"/scheduling/serving_rotation_positions/{id}/candidates":{"get":{"tags":["scheduling"],"summary":"Get serving rotation position candidates","security":[{"oauth2":["read:scheduling"]}],"operationId":"getServingRotationPositionCandidates","parameters":[{"name":"id","in":"path","description":"The serving rotation position id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Returns the candidates","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/VolunteerSerializer"}}}}}}}},"/scheduling/serving_rotation_positions/{id}/assignments":{"post":{"tags":["scheduling"],"summary":"Creates serving rotation position assignments","security":[{"oauth2":["write:scheduling"]}],"operationId":"createServingRotationPositionAssignment","parameters":[{"name":"id","in":"path","description":"The serving rotation position's id","required":true,"schema":{"type":"integer"}}],"requestBody":{"description":"The individual ids to create assignments for","content":{"application/json":{"schema":{"type":"object","properties":{"individual_ids":{"type":"array","items":{"type":"integer"}},"update_existing_status":{"type":"boolean"}}}}},"required":false},"responses":{"201":{"description":"Returns the created serving rotation assignments","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ServingRotationAssignmentSerializer"}}}}}},"x-codegen-request-body-name":"createAssignmentRequest"}},"/scheduling/events/{event_id}/event_position_associated_times":{"put":{"tags":["scheduling"],"summary":"Updates all event position associated times in an event","security":[{"oauth2":["write:schedules"]}],"operationId":"updateEventPositionsAssociatedTimes","parameters":[{"name":"event_id","in":"path","description":"The event's id","required":true,"schema":{"type":"integer"}}],"requestBody":{"description":"Updates to an event positions associated time","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"is_required":{"type":"boolean"},"event_position_id":{"type":"integer"},"associated_time_id":{"type":"integer"}}}}}},"required":false},"responses":{"200":{"description":"Returns the updated assignment associated times","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SchedulingEventSerializer"}}}}},"x-codegen-request-body-name":"eventPositionAssociatedTimeRequest"}},"/scheduling/event_teams/{event_team_id}/associated_times/{associated_time_id}":{"put":{"tags":["scheduling"],"summary":"Updates all assignment associated times in an event team","security":[{"oauth2":["write:schedules"]}],"operationId":"updateEventTeamAssociatedTimes","parameters":[{"name":"event_team_id","in":"path","description":"The event team's id","required":true,"schema":{"type":"integer"}},{"name":"associated_time_id","in":"path","description":"The associated time's id","required":true,"schema":{"type":"integer"}}],"requestBody":{"description":"Updates to an assignment associated time","content":{"application/json":{"schema":{"type":"object","properties":{"is_required":{"type":"boolean"}}}}},"required":false},"responses":{"200":{"description":"Returns the updated assignment associated times","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AssignmentAssociatedTimeSerializer"}}}}}},"x-codegen-request-body-name":"assignmentAssociatedTimeRequest"}},"/scheduling/event_positions/{event_position_id}/associated_times/{associated_time_id}":{"put":{"tags":["scheduling"],"summary":"Updates all associated time associated times in an event position","security":[{"oauth2":["write:schedules"]}],"operationId":"updateEventPositionAssociatedTimes","parameters":[{"name":"event_position_id","in":"path","description":"The event position's id","required":true,"schema":{"type":"integer"}},{"name":"associated_time_id","in":"path","description":"The associated time's id","required":true,"schema":{"type":"integer"}}],"requestBody":{"description":"Updates to an assignment associated time","content":{"application/json":{"schema":{"type":"object","properties":{"is_required":{"type":"boolean"}}}}},"required":false},"responses":{"200":{"description":"Returns the updated assignment associated times","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AssignmentAssociatedTimeSerializer"}}}}}},"x-codegen-request-body-name":"assignmentAssociatedTimeRequest"}},"/scheduling/assignments/{assignment_id}/associated_times/{associated_time_id}":{"put":{"tags":["scheduling"],"summary":"Updates an assignment associated time","security":[{"oauth2":["write:schedules"]}],"operationId":"updateAssignmentsAssociatedTimes","parameters":[{"name":"assignment_id","in":"path","description":"The assignment id","required":true,"schema":{"type":"integer"}},{"name":"associated_time_id","in":"path","description":"The associated time's id","required":true,"schema":{"type":"integer"}}],"requestBody":{"description":"Updates to an assignment associated time","content":{"application/json":{"schema":{"type":"object","properties":{"is_required":{"type":"boolean"}}}}},"required":false},"responses":{"200":{"description":"Returns the updated assignment associated times","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AssignmentAssociatedTimeSerializer"}}}}}},"x-codegen-request-body-name":"assignmentAssociatedTimeRequest"}},"/scheduling/assignments/{id}/associated_times":{"get":{"tags":["scheduling"],"summary":"Get associated times for an assignment","security":[{"oauth2":["read:scheduling"]}],"operationId":"getAssignmentAssociatedTimes","parameters":[{"name":"id","in":"path","description":"The assignment id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Returns the assignment","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AssociatedTimeSerializer"}}}}}}},"/scheduling/assignments/{id}/available_swaps":{"get":{"tags":["scheduling"],"summary":"Get list of assignments that could possibly swap with the supplied assignment","security":[{"oauth2":["read:scheduling"]}],"operationId":"getAvailableAssignmentSwaps","parameters":[{"name":"id","in":"path","description":"The assignment id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Returns a list of assignments","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AvailableAssignmentSwapSerializer"}}}}}}},"/scheduling/assignments/{id}/assignment_swaps":{"post":{"tags":["scheduling"],"summary":"Creates requests to swap serving assignments","security":[{"oauth2":["write:scheduling"]}],"operationId":"createAssignmentSwap","parameters":[{"name":"id","in":"path","description":"The assignment's id","required":true,"schema":{"type":"integer"}}],"requestBody":{"description":"The ids of assignments to create swap requests for","content":{"application/json":{"schema":{"type":"object","properties":{"individual_ids":{"type":"array","items":{"type":"integer"}}}}}},"required":false},"responses":{"201":{"description":"Returns the created assignments","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AssignmentSwapSerializer"}}}}},"x-codegen-request-body-name":"createAssignmentSwapRequest"}},"/scheduling/assignment_swaps/{id}":{"get":{"tags":["scheduling"],"summary":"get an assignment swap record","security":[{"oauth2":["read:scheduling"]}],"operationId":"getAssignmentSwap","parameters":[{"name":"id","in":"path","description":"The assignment_swap_id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Returns the assignment swap record","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AssignmentSwapSerializer"}}}}}},"put":{"tags":["scheduling"],"summary":"Update an assignment swap","security":[{"oauth2":["write:scheduling"]}],"operationId":"updateAssignmentSwap","parameters":[{"name":"id","in":"path","description":"The assignment_swap_id","required":true,"schema":{"type":"integer"}}],"requestBody":{"description":"The new status for the assignment swap","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AssignmentSwapRequestBody"}}},"required":false},"responses":{"200":{"description":"Returns the assignment swap record","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AssignmentSwapSerializer"}}}}},"x-codegen-request-body-name":"assignmentSwapRequest"}},"/scheduling/assignments":{"delete":{"tags":["scheduling"],"summary":"Delete all assignments of the given events","security":[{"oauth2":["write:scheduling"]}],"operationId":"deleteAssignments","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"event_ids":{"type":"array","items":{"type":"integer","minimum":1}},"statuses":{"type":"array","items":{"$ref":"#/components/schemas/AssignmentStatus"}},"include_notified":{"type":"boolean","default":false}},"required":["event_ids"]}}},"required":true},"responses":{"200":{"description":"Empty response","content":{}},"400":{"description":"Events not specified or not found, or invalid statuses","content":{}},"403":{"$ref":"#/components/responses/NotAuthorized"}}}},"/scheduling/assignments/{id}":{"get":{"tags":["scheduling"],"summary":"Get an assignment","security":[{"oauth2":["read:scheduling"]}],"operationId":"getAssignment","parameters":[{"name":"id","in":"path","description":"The assignment's id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Returns the assignment","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AssignmentSerializer"}}}}}},"put":{"tags":["scheduling"],"summary":"Update an assignment","security":[{"oauth2":["write:scheduling"]}],"operationId":"updateAssignment","parameters":[{"name":"id","in":"path","description":"The assignment's id","required":true,"schema":{"type":"integer"}}],"requestBody":{"description":"The new status for the assignment","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AssignmentRequestBody"}}},"required":false},"responses":{"200":{"description":"Returns the assignment","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AssignmentSerializer"}}}},"400":{"description":"Invalid status","content":{}}},"x-codegen-request-body-name":"assignmentRequest"},"delete":{"tags":["scheduling"],"summary":"Delete an assignment","security":[{"oauth2":["write:scheduling"]}],"operationId":"deleteAssignment","parameters":[{"name":"id","in":"path","description":"The assignment's id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Empty response","content":{}}}}},"/scheduling/positions":{"get":{"tags":["scheduling"],"summary":"Search for positions","security":[{"oauth2":["read:scheduling"]}],"operationId":"searchPositions","parameters":[{"name":"search_term","in":"query","description":"Search term used to search position by name","schema":{"type":"string"}},{"name":"status_filter","in":"query","description":"Used to filter positions by ACTIVE and INACTIVE","schema":{"type":"string","enum":["ACTIVE","INACTIVE"]}},{"name":"exclude_member_id","in":"query","description":"Individual Id to filter out positions where they are already a member","schema":{"type":"integer"}},{"name":"show_positions_to_add","in":"query","description":"Show positions that can be added","schema":{"type":"boolean"}},{"name":"position_ids","in":"query","description":"Filter results to specific position IDs","style":"form","explode":true,"schema":{"type":"array","items":{"type":"integer"}}}],"responses":{"200":{"description":"Returns the positions matching search criteria","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PositionSerializer"}}}}}}}},"/scheduling/position/{id}":{"put":{"tags":["scheduling"],"summary":"Update a position","security":[{"oauth2":["write:scheduling"]}],"operationId":"updatePosition","parameters":[{"name":"id","in":"path","description":"The position's id","required":true,"schema":{"type":"integer"}}],"requestBody":{"description":"Position data to update","content":{"application/json":{"schema":{"type":"object","properties":{"description":{"type":"string","description":"Position description"},"needed":{"type":"integer","description":"Number of volunteers needed for this position"},"background_check_type_ids":{"type":"array","items":{"type":"integer"},"description":"Array of background check type IDs required for this position"}}}}}},"responses":{"200":{"description":"Returns the updated position","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PositionSerializer"}}}}}}},"/scheduling/positions/{id}/volunteers":{"post":{"tags":["scheduling"],"summary":"Adds a volunteer to the position","security":[{"oauth2":["write:scheduling"]}],"operationId":"createVolunteer","parameters":[{"name":"id","in":"path","description":"The position's id","required":true,"schema":{"type":"integer"}}],"requestBody":{"description":"The individual ids to create volunteers for","content":{"application/json":{"schema":{"type":"object","properties":{"individual_ids":{"type":"array","items":{"type":"integer"}}}}}},"required":false},"responses":{"201":{"description":"Returns the volunteers created","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/VolunteerSerializer"}}}}}},"x-codegen-request-body-name":"createVolunteersRequest"}},"/scheduling/positions/{id}/volunteer-migrations":{"post":{"tags":["scheduling"],"summary":"Pulls group members into a position","security":[{"oauth2":["write:scheduling"]}],"operationId":"migrateVolunteer","parameters":[{"name":"id","in":"path","description":"The position's id","required":true,"schema":{"type":"integer"}}],"requestBody":{"description":"The group and optionally some positions to migrate group members from","content":{"application/json":{"schema":{"type":"object","properties":{"from_group_id":{"type":"integer"},"from_position_ids":{"type":"array","items":{"type":"integer"}}}}}},"required":false},"responses":{"201":{"description":"Returns the number of volunteers created","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/VolunteerMigrationSerializer"}}}}}},"x-codegen-request-body-name":"migrateVolunteersRequest"}},"/scheduling/individual/{id}/positions":{"post":{"tags":["scheduling"],"summary":"Adds an individual to positions","security":[{"oauth2":["write:scheduling"]}],"operationId":"createVolunteerPosition","parameters":[{"name":"id","in":"path","description":"The individual's id","required":true,"schema":{"type":"integer"}}],"requestBody":{"description":"The position ids to create volunteer records for","content":{"application/json":{"schema":{"type":"object","properties":{"positions_ids":{"type":"array","items":{"type":"integer"}}}}}},"required":false},"responses":{"201":{"description":"Returns the volunteer records created","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/VolunteerSerializer"}}}}}},"x-codegen-request-body-name":"createVolunteersRequest"}},"/individuals/{id}/assignments":{"get":{"tags":["scheduling","individuals"],"summary":"Gets an individual's assignments","security":[{"oauth2":["read:scheduling"]}],"operationId":"getIndividualAssignments","parameters":[{"name":"id","in":"path","description":"The individual's id","required":true,"schema":{"type":"integer"}},{"$ref":"#/components/parameters/PerPage"},{"$ref":"#/components/parameters/Page"}],"requestBody":{"description":"Request an individuals assignments","content":{"*/*":{"schema":{"type":"object","properties":{"start_date":{"type":"string","format":"date"},"end_date":{"type":"string","format":"date"},"statuses":{"type":"array","items":{"$ref":"#/components/schemas/AssignmentStatus"}}}}}},"required":false},"responses":{"200":{"description":"Returns the individual's assignments","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AssignmentSerializer"}}}}}},"x-codegen-request-body-name":"individualsAssignmentsRequest"},"put":{"tags":["scheduling","individuals"],"summary":"Updates all assignments to given status","security":[{"oauth2":["read:scheduling"]}],"operationId":"writeIndividualAssignments","parameters":[{"name":"id","in":"path","description":"The individual's id","required":true,"schema":{"type":"integer"}}],"requestBody":{"description":"update all pending assignments to status","content":{"*/*":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["ACCEPTED","DECLINED"]}}}}},"required":false},"responses":{"200":{"description":"Returns the individual's assignments","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AssignmentSerializer"}}}}}},"x-codegen-request-body-name":"updateAllAssignmentsRequest"}},"/scheduling/families/{id}/assignments":{"get":{"tags":["scheduling","families"],"summary":"Gets a family's assignments","security":[{"oauth2":["read:scheduling"]}],"operationId":"getFamilyAssignments","parameters":[{"name":"id","in":"path","description":"The family's id","required":true,"schema":{"type":"integer"}},{"$ref":"#/components/parameters/PerPage"},{"$ref":"#/components/parameters/Page"}],"requestBody":{"description":"Request a family's assignments","content":{"*/*":{"schema":{"type":"object","properties":{"start_date":{"type":"string","format":"date"},"end_date":{"type":"string","format":"date"},"statuses":{"type":"array","items":{"$ref":"#/components/schemas/AssignmentStatus"}},"exclude_individuals":{"type":"array","items":{"type":"integer"}}}}}},"required":false},"responses":{"200":{"description":"Returns the family's assignments","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AssignmentSerializer"}}}}}},"x-codegen-request-body-name":"FamilyAssignmentsRequest"},"put":{"tags":["scheduling","individuals"],"summary":"Updates all assignments to given status for a family","security":[{"oauth2":["read:scheduling"]}],"operationId":"writeFamilyAssignments","parameters":[{"name":"id","in":"path","description":"The family's id","required":true,"schema":{"type":"integer"}}],"requestBody":{"description":"update all of a family's pending assignments to status","content":{"*/*":{"schema":{"type":"object","properties":{"excluded_individual_ids":{"type":"array","items":{"type":"integer"}},"status":{"type":"string","enum":["ACCEPTED","DECLINED"]}}}}},"required":false},"responses":{"200":{"description":"Returns the family's updated assignments","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AssignmentSerializer"}}}}}},"x-codegen-request-body-name":"updateAllFamilyRequest"}},"/scheduling/families/{id}/blockout_dates":{"get":{"tags":["scheduling"],"summary":"Get a familiy's blockout dates for a date range","security":[{"oauth2":["read:scheduling"]},{"oauth2":["read:serving_preferences"]}],"operationId":"getFamilyBlockoutDates","parameters":[{"name":"id","in":"path","description":"The family's id","required":true,"schema":{"type":"integer"}},{"name":"start_date","in":"query","description":"The date to start getting blockout dates for","schema":{"type":"string","format":"date"}},{"name":"end_date","in":"query","description":"The end date to getting blockout dates","schema":{"type":"string","format":"date"}}],"responses":{"200":{"description":"Returns the family's blockout dates","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/IndividualBlockoutDateSerializer"}}}}}}},"post":{"tags":["scheduling"],"summary":"Create a blockout date range for all family members","security":[{"oauth2":["write:scheduling"]},{"oauth2":["write:serving_preferences"]}],"operationId":"createFamilyBlockoutDate","parameters":[{"name":"id","in":"path","description":"The family's id","required":true,"schema":{"type":"integer"}}],"requestBody":{"description":"The blockout date range to apply to all family members","content":{"application/json":{"schema":{"type":"object","properties":{"start":{"type":"string","format":"date-time"},"end":{"type":"string","format":"date-time"},"reason":{"type":"string"},"recurrence_rule":{"type":"string","description":"An iCalendar RRULE string for recurring blockout dates"}},"required":["start","end"]}}},"required":true},"responses":{"200":{"description":"Returns the created blockout dates for each authorized family member","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/IndividualBlockoutDateSerializer"}}}}},"401":{"$ref":"#/components/responses/NotAuthenticated"},"403":{"$ref":"#/components/responses/NotAuthorized"}},"x-codegen-request-body-name":"familyBlockoutDate"}},"/scheduling/events/{id}":{"get":{"tags":["scheduling"],"summary":"Get scheduling event","security":[{"oauth2":["read:scheduling"]}],"operationId":"getSchedulingEvent","parameters":[{"name":"id","in":"path","description":"Schedule Event id","required":true,"schema":{"type":"integer"}},{"name":"get_full_event","in":"query","description":"Get full event details","schema":{"type":"boolean"}}],"responses":{"200":{"description":"Returns the event","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SchedulingEventSerializer"}}}}}},"put":{"tags":["scheduling"],"summary":"Update an event","security":[{"oauth2":["write:scheduling"]}],"operationId":"updateSchedulingEvent","parameters":[{"name":"id","in":"path","description":"Schedule Event id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Returns the updated event","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SchedulingEventSerializer"}}}}}}},"/scheduling/events/{id}/copy_assignments":{"put":{"tags":["scheduling"],"summary":"Update multiple events with assignments from another event","security":[{"oauth2":["write:scheduling"]}],"operationId":"copyEventsAssignmentsEvent","parameters":[{"name":"id","in":"path","description":"Source schedule event id","required":true,"schema":{"type":"integer"}}],"requestBody":{"description":"Schedule event ids to copy assignments to","content":{"application/json":{"schema":{"type":"array","items":{"type":"integer"}}}},"required":true},"responses":{"200":{"description":"Returns the updated event","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SchedulingEventSerializer"}}}}}}}},"/scheduling/events/{id}/copy_assignments/{copyFromEventId}":{"put":{"tags":["scheduling"],"summary":"Update an event with assignments from another event","security":[{"oauth2":["write:scheduling"]}],"operationId":"copyEventAssignmentsEvent","parameters":[{"name":"id","in":"path","description":"Schedule Event id","required":true,"schema":{"type":"integer"}},{"name":"copyFromEventId","in":"path","description":"Schedule Event id to copy from","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Returns the updated event","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SchedulingEventSerializer"}}}}}}},"/scheduling/events/{event_id}/serving_rotations/{serving_rotation_id}":{"put":{"tags":["scheduling"],"summary":"Assign a serving rotation to an event","security":[{"oauth2":["write:scheduling"]}],"operationId":"assignServingRotationToEvent","parameters":[{"name":"event_id","in":"path","description":"Schedule Event id","required":true,"schema":{"type":"integer"}},{"name":"serving_rotation_id","in":"path","description":"Schedule serving rotation id","required":true,"schema":{"type":"integer"}}],"requestBody":{"description":"Individuals to exlude from the assignment","content":{"application/json":{"schema":{"type":"array","items":{"type":"integer"}}}},"required":false},"responses":{"200":{"description":"Returns the updated event","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SchedulingEventSerializer"}}}}},"x-codegen-request-body-name":"exclude_individual_ids"}},"/scheduling/events/{event_id}/serving_rotations/{serving_rotation_id}/conflicts":{"get":{"tags":["scheduling"],"summary":"Get event assignment conflicts with serving rotation","security":[{"oauth2":["read:scheduling"]}],"operationId":"conflictsServingRotationToEvent","parameters":[{"name":"event_id","in":"path","description":"Schedule Event id","required":true,"schema":{"type":"integer"}},{"name":"serving_rotation_id","in":"path","description":"Schedule serving rotation id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Returns the assignment conflicts","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/VolunteerSerializer"}}}}}}}},"/scheduling/serving_rotation_positions/{id}":{"put":{"tags":["scheduling"],"summary":"Updates the quantity required for a serving rotation position","security":[{"oauth2":["write:scheduling"]}],"operationId":"updateServingRotationPosition","parameters":[{"name":"id","in":"path","description":"The serving rotation position id","required":true,"schema":{"type":"integer"}}],"requestBody":{"description":"Quantity needed for the serving rotation position","content":{"application/json":{"schema":{"type":"object","properties":{"quantity":{"type":"integer"}}}}},"required":false},"responses":{"200":{"description":"Returns the serving rotation position","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServingRotationPositionSerializer"}}}}},"x-codegen-request-body-name":"servingRotationPosition"}},"/scheduling/events/{id}/files":{"post":{"tags":["scheduling"],"summary":"Upload file for event","security":[{"oauth2":["write:scheduling"]}],"operationId":"createEventFile","parameters":[{"name":"id","in":"path","description":"Schedule Event id","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"properties":{"file":{"type":"string","description":"File to upload","format":"binary"}}}}}},"responses":{"201":{"description":"Returns a file serializer","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/EventFileSerializer"}}}}}}}},"/scheduling/categories/{id}/service_plans":{"get":{"tags":["scheduling"],"summary":"Get category service plans","security":[{"oauth2":["write:scheduling"]}],"operationId":"getScheduleServicePlan","parameters":[{"name":"id","in":"path","description":"Category id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Returns the created service plan","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ServicePlanSerializer"}}}}}}},"post":{"tags":["scheduling"],"summary":"Create a service plan","security":[{"oauth2":["write:scheduling"]}],"operationId":"createScheduleServicePlan","parameters":[{"name":"id","in":"path","description":"Category id","required":true,"schema":{"type":"integer"}}],"requestBody":{"description":"The service plan","content":{"application/json":{"schema":{"type":"object","properties":{"category_id":{"type":"integer"},"name":{"type":"string"},"event_starttime_offset":{"type":"integer"}}}}},"required":false},"responses":{"201":{"description":"Returns the created service plan","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServicePlanSerializer"}}}}},"x-codegen-request-body-name":"servicePlan"}},"/scheduling/schedules/{id}/organizers":{"get":{"tags":["scheduling"],"summary":"Get schedule organizers","security":[{"oauth2":["write:scheduling"]}],"operationId":"getScheduleOrganizer","parameters":[{"name":"id","in":"path","description":"Schedule Id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Returns the schedule organizer","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BasicIndividualProfileSerializer"}}}}}}},"post":{"tags":["scheduling"],"summary":"Create a schedule organizer","security":[{"oauth2":["write:scheduling"]}],"operationId":"createScheduleOrganizer","parameters":[{"name":"id","in":"path","description":"Schedule Id","required":true,"schema":{"type":"integer"}}],"requestBody":{"description":"the schedule organizers","content":{"application/json":{"schema":{"type":"object","properties":{"schedule_id":{"type":"integer"},"individual_id":{"type":"integer"}}}}},"required":false},"responses":{"201":{"description":"Returns the created service plan","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BasicIndividualProfileSerializer"}}}}},"x-codegen-request-body-name":"scheduleOrganizer"},"delete":{"tags":["scheduling"],"summary":"Remove a schedule organizer","security":[{"oauth2":["write:scheduling"]}],"operationId":"deleteScheduleOrganizer","parameters":[{"name":"id","in":"path","description":"Schedule Id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Empty response","content":{}}}}},"/scheduling/categories/{id}/plan_organizers":{"get":{"tags":["scheduling"],"summary":"Get plan organizers","security":[{"oauth2":["write:scheduling"]}],"operationId":"getPlanOrganizers","parameters":[{"name":"id","in":"path","description":"Category Id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Returns plan organizers","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BasicIndividualProfileSerializer"}}}}}}},"post":{"tags":["scheduling"],"summary":"Create a plan organizer","security":[{"oauth2":["write:scheduling"]}],"operationId":"createPlanOrganizer","parameters":[{"name":"id","in":"path","description":"Category Id","required":true,"schema":{"type":"integer"}}],"requestBody":{"description":"the plan organizer","content":{"application/json":{"schema":{"type":"object","properties":{"individual_id":{"type":"integer"}}}}},"required":false},"responses":{"201":{"description":"Returns the created plan organizer","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BasicIndividualProfileSerializer"}}}}},"x-codegen-request-body-name":"planOrganizer"}},"/scheduling/categories/{id}/plan_organizers/{individualId}":{"delete":{"tags":["scheduling"],"summary":"Remove a plan organizer","security":[{"oauth2":["write:scheduling"]}],"operationId":"deletePlanOrganizer","parameters":[{"name":"id","in":"path","description":"Category Id","required":true,"schema":{"type":"integer"}},{"name":"individualId","in":"path","description":"Id of the Individual","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Empty response","content":{}}}}},"/scheduling/schedules/{id}/assignment_metrics":{"get":{"tags":["scheduling"],"summary":"Get schedule assignment metrics","security":[{"oauth2":["read:scheduling"]}],"operationId":"getScheduleAssignmentMetrics","parameters":[{"name":"id","in":"path","description":"Schedule Id","required":true,"schema":{"type":"integer"}},{"name":"categoryId","in":"query","description":"Category Id","required":false,"schema":{"type":"integer"}},{"name":"includePastEvents","in":"query","description":"Whether we should include past events","required":false,"schema":{"type":"boolean"}},{"name":"eventIds","in":"query","description":"Event Ids to filter the metrics","style":"form","explode":true,"required":false,"schema":{"type":"array","items":{"type":"integer"}}}],"responses":{"200":{"description":"Returns the schedule assignmentMetrics","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ScheduleAssignmentMetric"}}}}}}}},"/scheduling/service_plans/{id}":{"put":{"tags":["scheduling"],"summary":"Update a service plan","security":[{"oauth2":["write:scheduling"]}],"operationId":"updateScheduleServicePlan","parameters":[{"name":"id","in":"path","description":"Service plan id","required":true,"schema":{"type":"integer"}}],"requestBody":{"description":"The service plan","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"}}}}},"required":false},"responses":{"200":{"description":"Returns the updated service plan","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ServicePlanSerializer"}}}}}},"x-codegen-request-body-name":"servicePlan"},"delete":{"tags":["scheduling"],"summary":"Delete a service plan","security":[{"oauth2":["write:scheduling"]}],"operationId":"deleteScheduleServicePlan","parameters":[{"name":"id","in":"path","description":"Service plan id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Empty response","content":{}}}}},"/scheduling/service_plans/{id}/items":{"put":{"tags":["scheduling"],"summary":"Update bulk service plan items","security":[{"oauth2":["write:scheduling"]}],"operationId":"updateBulkServicePlanItems","parameters":[{"name":"id","in":"path","description":"Service plan id","required":true,"schema":{"type":"integer"}}],"requestBody":{"description":"The bulk service plan item request","content":{"application/json":{"schema":{"type":"object","properties":{"order":{"type":"array","items":{"type":"integer"}},"count_before":{"type":"integer"}}}}},"required":false},"responses":{"200":{"description":"Returns the service plan","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServicePlanSerializer"}}}}},"x-codegen-request-body-name":"bulkServicePlanItems"},"post":{"tags":["scheduling"],"summary":"Create a service plan item","security":[{"oauth2":["write:scheduling"]}],"operationId":"createScheduleServicePlanItem","parameters":[{"name":"id","in":"path","description":"Service plan id","required":true,"schema":{"type":"integer"}}],"requestBody":{"description":"The service plan item","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"item_type":{"type":"string","enum":["ITEM","SECTION_HEADER"]},"duration":{"type":"integer"},"links":{"type":"array","items":{"$ref":"#/components/schemas/ServicePlanItemLinkRequest"}},"fileIds":{"type":"array","items":{"type":"integer"}}}}}},"required":false},"responses":{"201":{"description":"Returns the service plan","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServicePlanSerializer"}}}}},"x-codegen-request-body-name":"servicePlanItem"}},"/scheduling/service_plan_items/{id}":{"put":{"tags":["scheduling"],"summary":"Update a service plan item","security":[{"oauth2":["write:scheduling"]}],"operationId":"updateScheduleServicePlanItem","parameters":[{"name":"id","in":"path","description":"Service plan item id","required":true,"schema":{"type":"integer"}}],"requestBody":{"description":"The service plan item","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"item_type":{"type":"string","enum":["ITEM","SECTION_HEADER"]},"duration":{"type":"integer"},"links":{"type":"array","items":{"$ref":"#/components/schemas/ServicePlanItemLinkRequest"}},"fileIds":{"type":"array","items":{"type":"integer"}}}}}},"required":false},"responses":{"200":{"description":"Returns the service plan item","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServicePlanItemSerializer"}}}}},"x-codegen-request-body-name":"servicePlanItem"},"delete":{"tags":["scheduling"],"summary":"delete a service plan item","security":[{"oauth2":["write:scheduling"]}],"operationId":"deleteScheduleServicePlanItem","parameters":[{"name":"id","in":"path","description":"Service plan item id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Returns empty","content":{}}}}},"/scheduling/teams":{"get":{"tags":["scheduling"],"summary":"Search teams","security":[{"oauth2":["read:scheduling"]}],"operationId":"searchTeams","parameters":[{"name":"search_term","in":"query","description":"Search term to filter teams by name","required":false,"schema":{"type":"string"}},{"name":"status_filter","in":"query","description":"Filter teams by status","required":false,"schema":{"$ref":"#/components/schemas/TeamStatusFilter"}}],"responses":{"200":{"description":"Returns the list of teams matching the search criteria","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/TeamSerializer"}}}}}}}},"/scheduling/teams/{id}/organizers":{"get":{"tags":["scheduling"],"summary":"Get team organizers","security":[{"oauth2":["write:scheduling"]}],"operationId":"getTeamOrganizers","parameters":[{"name":"id","in":"path","description":"Team Id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Returns the team organizers","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BasicIndividualProfileSerializer"}}}}}}},"post":{"tags":["scheduling"],"summary":"Create a team organizer","security":[{"oauth2":["write:scheduling"]}],"operationId":"createTeamOrganizer","parameters":[{"name":"id","in":"path","description":"Team Id","required":true,"schema":{"type":"integer"}}],"requestBody":{"description":"the team organizer","content":{"application/json":{"schema":{"type":"object","properties":{"individual_id":{"type":"integer"}}}}},"required":false},"responses":{"201":{"description":"The individual that was added","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BasicIndividualProfileSerializer"}}}}},"x-codegen-request-body-name":"teamOrganizer"}},"/scheduling/teams/{id}/organizers/{individual_id}":{"delete":{"tags":["scheduling"],"summary":"Remove a team organizer","security":[{"oauth2":["write:scheduling"]}],"operationId":"removeTeamOrganizer","parameters":[{"name":"id","in":"path","description":"Team Id","required":true,"schema":{"type":"integer"}},{"name":"individual_id","in":"path","description":"Individual Id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Empty response","content":{}}}}},"/scheduling/individuals/{id}/positions":{"get":{"tags":["scheduling"],"summary":"Get an individual's filled positions","security":[{"oauth2":["read:scheduling"]}],"operationId":"getIndividualPositions","parameters":[{"name":"id","in":"path","description":"The individuals's id","required":true,"schema":{"type":"integer"}},{"name":"status","in":"query","description":"Return 'ALL', 'ACTIVE' or 'INACTIVE' positions for an individual.","schema":{"type":"string","default":"ACTIVE","enum":["ALL","ACTIVE","INACTIVE"]}},{"$ref":"#/components/parameters/PerPage"},{"$ref":"#/components/parameters/Page"}],"responses":{"200":{"description":"Returns the individual's positions","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/IndividualPositionSerializer"}}}}}}}},"/scheduling/individuals/{id}/open_event_positions":{"get":{"tags":["scheduling"],"summary":"Get an individual's open event positions","security":[{"oauth2":["read:scheduling"]}],"operationId":"getIndividualOpenEventPositions","parameters":[{"name":"id","in":"path","description":"The individuals's id","required":true,"schema":{"type":"integer"}},{"$ref":"#/components/parameters/PerPage"},{"$ref":"#/components/parameters/Page"}],"responses":{"200":{"description":"Returns the individual's open event positions","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BasicIndividualEventPositionSerializer"}}}}}}}},"/scheduling/families/{id}/open_event_positions":{"get":{"tags":["scheduling"],"summary":"Get a family's open event positions","security":[{"oauth2":["read:scheduling"]}],"operationId":"getFamilyOpenEventPositions","parameters":[{"name":"id","in":"path","description":"The individuals's id","required":true,"schema":{"type":"integer"}},{"name":"after","in":"query","description":"start date of open positions to search for","schema":{"type":"string"}},{"name":"exclude_individual_id","in":"query","description":"Family individual ids to not include","style":"form","explode":false,"schema":{"type":"array","items":{"type":"integer"}}},{"$ref":"#/components/parameters/PerPage"},{"$ref":"#/components/parameters/Page"}],"responses":{"200":{"description":"Returns the family's open event positions","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BasicIndividualEventPositionSerializer"}}}}}}}},"/scheduling/individuals/{id}/open_event_positions/{event_position_id}":{"get":{"tags":["scheduling"],"summary":"Get an individual's open event position","security":[{"oauth2":["read:scheduling"]}],"operationId":"getIndividualOpenEventPosition","parameters":[{"name":"id","in":"path","description":"The individuals's id","required":true,"schema":{"type":"integer"}},{"name":"event_position_id","in":"path","description":"The event position's id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Returns the individual's open event positions","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IndividualEventPositionSerializer"}}}}}}},"/scheduling/individuals/{id}/preferences":{"get":{"tags":["scheduling"],"summary":"Get an individuals serving preferences","security":[{"oauth2":["read:scheduling"]}],"operationId":"getIndividualServingPreferences","parameters":[{"name":"id","in":"path","description":"The individuals's id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Returns the individual's serving preferences","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IndividualServingPreferencesSerializer"}}}}}},"put":{"tags":["scheduling"],"summary":"Update an individual's serving preferences (legacy)","security":[{"oauth2":["write:scheduling"]},{"oauth2":["write:serving_preferences"]}],"operationId":"updateIndividualServingPreferences","parameters":[{"name":"id","in":"path","description":"The individuals's id","required":true,"schema":{"type":"integer"}}],"requestBody":{"description":"The individual's serving preferences","content":{"application/json":{"schema":{"type":"object","properties":{"preference_type":{"type":"string","enum":["UNLIMITED","WEEKS_PER_MONTH","WEEKS_OF_MONTH"]},"preference":{"type":"array","items":{"type":"integer"}},"serve_with_family":{"type":"boolean"}}}}},"required":false},"responses":{"200":{"description":"Returns the individual's serving preferences","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IndividualServingPreferencesSerializer"}}}}},"x-codegen-request-body-name":"individualServingPreferences"},"delete":{"tags":["scheduling"],"summary":"Delete an individual's serving preferences","security":[{"oauth2":["write:scheduling"]}],"operationId":"deleteIndividualServingPreferences","parameters":[{"name":"id","in":"path","description":"The individuals's id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Empty response","content":{}}}}},"/scheduling/individuals/{id}/unified_preferences":{"put":{"tags":["scheduling"],"summary":"Update an individual's unified serving preferences","security":[{"oauth2":["write:scheduling"]},{"oauth2":["write:serving_preferences"]}],"operationId":"updateIndividualUnifiedServingPreferences","parameters":[{"name":"id","in":"path","description":"The individual's id","required":true,"schema":{"type":"integer"}}],"requestBody":{"description":"The individual's unified serving preferences","content":{"application/json":{"schema":{"type":"object","properties":{"serve_with_family":{"type":"boolean"},"frequency_mode":{"type":"string","enum":["GLOBAL","CATEGORY"]},"weekly":{"type":"object","properties":{"preference_type":{"type":"string","enum":["UNLIMITED","WEEKS_PER_MONTH","WEEKS_OF_MONTH"]},"preference":{"type":"array","items":{"type":"integer"}}}},"frequency":{"type":"object","properties":{"global":{"type":"object","properties":{"interval":{"type":"string","enum":["WEEK","MONTH"]},"number":{"type":"integer"}}},"category":{"type":"array","items":{"type":"object","properties":{"category_id":{"type":"integer"},"interval":{"type":"string","enum":["WEEK","MONTH"]},"number":{"type":"integer"}}}}}},"category_preferences":{"type":"array","items":{"type":"object","properties":{"category_id":{"type":"integer"},"name":{"type":"string"},"serving_times":{"type":"array","items":{"type":"object"}},"positions":{"type":"array","items":{"type":"object","properties":{"position_id":{"type":"integer"},"name":{"type":"string"},"serving_times":{"type":"array","items":{"type":"object"}},"interval":{"type":"string","nullable":true,"enum":["WEEK","MONTH"]},"number":{"type":"integer","nullable":true}}}}}}}}}}},"required":false},"responses":{"200":{"description":"Returns the individual's unified serving preferences","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnifiedServingPreferencesSerializer"}}}},"401":{"$ref":"#/components/responses/NotAuthenticated"},"403":{"$ref":"#/components/responses/NotAuthorized"}},"x-codegen-request-body-name":"unifiedServingPreferences"}},"/scheduling/individuals/{id}/blockout_dates":{"get":{"tags":["scheduling"],"summary":"Get an individuals blockout dates for a date range","security":[{"oauth2":["read:scheduling"]},{"oauth2":["read:serving_preferences"]}],"operationId":"getIndividualBlockoutDates","parameters":[{"name":"id","in":"path","description":"The individuals's id","required":true,"schema":{"type":"integer"}},{"name":"start_date","in":"query","description":"The date to start getting blockout dates for","schema":{"type":"string","format":"date"}},{"name":"end_date","in":"query","description":"The end date to getting blockout dates","schema":{"type":"string","format":"date"}}],"responses":{"200":{"description":"Returns the individual's blockout dates","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/IndividualBlockoutDateSerializer"}}}}}}},"post":{"tags":["scheduling"],"summary":"Create a blockout date range","security":[{"oauth2":["write:scheduling"]},{"oauth2":["write:serving_preferences"]}],"operationId":"createIndividualBlockoutDate","parameters":[{"name":"id","in":"path","description":"The individuals's id","required":true,"schema":{"type":"integer"}}],"requestBody":{"description":"The individual's blockout date range","content":{"application/json":{"schema":{"type":"object","properties":{"reason":{"type":"string"},"start":{"type":"string","format":"date-time"},"end":{"type":"string","format":"date-time"}}}}},"required":false},"responses":{"200":{"description":"Returns the new blockout date","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IndividualBlockoutDateSerializer"}}}}},"x-codegen-request-body-name":"individualBlockoutDate"}},"/scheduling/blockout_dates/{id}":{"put":{"tags":["scheduling"],"summary":"Update an individual blockout date","security":[{"oauth2":["write:scheduling"]},{"oauth2":["write:serving_preferences"]}],"operationId":"updateIndividualBlockoutDate","parameters":[{"name":"id","in":"path","description":"The blockout date's id","required":true,"schema":{"type":"integer"}}],"requestBody":{"description":"The individual's blockout date range","content":{"application/json":{"schema":{"type":"object","properties":{"reason":{"type":"string"},"start":{"type":"string","format":"date-time"},"end":{"type":"string","format":"date-time"}}}}},"required":false},"responses":{"200":{"description":"Returns the updated blockout date","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IndividualBlockoutDateSerializer"}}}}},"x-codegen-request-body-name":"individualBlockoutDate"},"delete":{"tags":["scheduling"],"summary":"Delete an individual blockout date","security":[{"oauth2":["write:scheduling"]},{"oauth2":["write:serving_preferences"]}],"operationId":"deleteIndividualBlockoutDate","parameters":[{"name":"id","in":"path","description":"The blockout date's id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Empty response","content":{}}}}},"/scheduling/blockout_dates/{id}/{occurrence}":{"delete":{"tags":["scheduling"],"summary":"Remove a single occurrence from a recurring blockout date","security":[{"oauth2":["write:scheduling"]}],"operationId":"deleteIndividualBlockoutDateOccurrence","parameters":[{"name":"id","in":"path","description":"The blockout date's id","required":true,"schema":{"type":"integer"}},{"name":"occurrence","in":"path","description":"The date of the occurrence to remove (ISO 8601 date)","required":true,"schema":{"type":"string","format":"date"}}],"responses":{"200":{"description":"Empty response","content":{}},"401":{"$ref":"#/components/responses/NotAuthenticated"},"403":{"$ref":"#/components/responses/NotAuthorized"}}}},"/scheduling/songs/{song_id}":{"get":{"tags":["scheduling"],"summary":"Get song detail","security":[{"oauth2":["read:scheduling"]}],"operationId":"getSongDetail","parameters":[{"name":"song_id","in":"path","description":"The song description","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Returns the detail of the song","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SongSerializer"}}}}}}},"/scheduling/song_versions/{version_id}/links":{"get":{"tags":["scheduling"],"summary":"Get song version links","security":[{"oauth2":["read:scheduling"]}],"operationId":"getVersionLinks","parameters":[{"name":"version_id","in":"path","description":"The song version id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Returns links for the song version","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SongVersionLinkSerializer"}}}}}}},"/scheduling/serving_reminder_times/{id}":{"put":{"tags":["scheduling"],"summary":"Update serving reminder time","security":[{"oauth2":["write:scheduling"]}],"operationId":"updateServingReminderTime","parameters":[{"name":"id","in":"path","description":"The serving reminder time's id","required":true,"schema":{"type":"integer"}}],"requestBody":{"description":"The serving reminder time","content":{"application/json":{"schema":{"type":"object","properties":{"days_before":{"type":"integer","description":"An integer from 1 to 7"},"time_of_day":{"type":"string","description":"The time of day in HH:MM format"}}}}},"required":false},"responses":{"200":{"description":"Returns the updated serving reminder time","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServingReminderTimeSerializer"}}}}},"x-codegen-request-body-name":"servingReminderTimeRequest"},"delete":{"tags":["scheduling"],"summary":"Delete a serving reminder time","security":[{"oauth2":["write:scheduling"]}],"operationId":"deleteServingReminderTime","parameters":[{"name":"id","in":"path","description":"The serving reminder time's id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Empty response","content":{}}}}},"/scheduling/event_positions/{source_id}/copy_to/{target_id}":{"post":{"tags":["scheduling"],"summary":"Copy assignments from a source to a target","security":[{"oauth2":["write:scheduling"]}],"operationId":"copyEventPositionAssignments","parameters":[{"name":"source_id","in":"path","description":"The source event position to copy the assignments from","required":true,"schema":{"type":"integer"}},{"name":"target_id","in":"path","description":"The target event position to copy the assignments to","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Returns the updated target event position","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventPositionSerializer"}}}}}}},"/scheduling/individuals/{individual_id}/preference_times":{"get":{"tags":["scheduling"],"summary":"retrieves preference times for an individual","security":[{"oauth2":["read:scheduling"]}],"operationId":"getIndividualServingPreferenceTimes","parameters":[{"name":"individual_id","in":"path","description":"the individual that the preference time is for","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Returns the preference times","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IndividualServingPreferenceTimeSerializer"}}}}}},"post":{"tags":["scheduling"],"summary":"creates a preference time per position for an individual","security":[{"oauth2":["write:scheduling"]}],"operationId":"createIndividualServingPreferenceTimes","parameters":[{"name":"individual_id","in":"path","description":"the individual that the preference time is for","required":true,"schema":{"type":"integer"}}],"requestBody":{"description":"create a serving time preference for an individual","content":{"application/json":{"schema":{"type":"object","properties":{"position_id":{"type":"integer"},"start":{"type":"string","format":"date-time"},"end":{"type":"string","format":"date-time"}}}}},"required":false},"responses":{"200":{"description":"creates a new preference time for an individual","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IndividualServingPreferenceTimeSerializer"}}}}},"x-codegen-request-body-name":"createIndividualServingPreferenceTimesRequest"}},"/scheduling/preference_times/{id}":{"put":{"tags":["scheduling"],"summary":"updates a preference time per position for an individual","security":[{"oauth2":["write:scheduling"]}],"operationId":"updateIndividualServingPreferenceTimes","parameters":[{"name":"id","in":"path","description":"unique id for preference time","required":true,"schema":{"type":"integer"}}],"requestBody":{"description":"update an existing serving preference time","content":{"application/json":{"schema":{"type":"object","properties":{"start":{"type":"string","format":"date-time"},"end":{"type":"string","format":"date-time"}}}}},"required":false},"responses":{"200":{"description":"updates an existing preference time for an individual","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IndividualServingPreferenceTimeSerializer"}}}}},"x-codegen-request-body-name":"updateIndividualServingPreferenceTimesRequest"},"delete":{"tags":["scheduling"],"summary":"Updates a preference time per position for an individual","security":[{"oauth2":["write:scheduling"]}],"operationId":"deleteIndividualServingPreferenceTimes","parameters":[{"name":"id","in":"path","description":"unique id for preference time","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"deletes an existing preference time for an individual","content":{}}}}},"/scheduling/volunteers/{id}":{"parameters":[{"name":"id","in":"path","description":"unique id for the volunteer","required":true,"schema":{"type":"integer"}}],"put":{"tags":["scheduling"],"summary":"updates a volunteer","security":[{"oauth2":["write:scheduling"]}],"operationId":"updateVolunteer","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["ACTIVE","HIDDEN","INACTIVE"]}}}}},"required":true},"responses":{"200":{"description":"The updated volunteer","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VolunteerSerializer"}}}}}}},"/scheduling/auto_schedule":{"post":{"tags":["scheduling"],"summary":"Creates as many assignments as possible for the given scheduling events","security":[{"oauth2":["write:scheduling","write:auto_schedule"]}],"operationId":"autoScheduleAssignments","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"event_ids":{"type":"array","items":{"type":"integer"}},"position_ids":{"type":"array","items":{"type":"integer"}},"filter_preferences":{"type":"array","items":{"type":"string","enum":["BLOCKOUT_DATE","SPECIFIC_WEEKS_SERVING_PREFERENCE","FREQUENCY_SERVING_PREFERENCE","SERVING_PREFERENCE_TIMES","FAMILY_SERVING_PREFERENCE"]}}}}}},"required":true},"responses":{"200":{"description":"Auto schedule completed successfully","$ref":"#/components/responses/AutoScheduleSuccessResponse"},"403":{"$ref":"#/components/responses/NotAuthorized"}}}},"/scheduling/auto_schedule/needed_volunteers":{"get":{"tags":["scheduling"],"summary":"Gets the number of needed volunteers for auto schedule","security":[{"oauth2":["read:scheduling","read:auto_schedule"]}],"operationId":"getAutoScheduleNeededVolunteers","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"event_ids":{"type":"array","items":{"type":"integer"}}}}}},"required":true},"responses":{"200":{"description":"The needed volunteers grouped by teams and positions","content":{"application/json":{"schema":{"type":"object","properties":{"needed":{"type":"integer"},"teams":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"},"needed":{"type":"integer"},"positions":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"},"needed":{"type":"integer"}}}}}}}}}}}},"403":{"$ref":"#/components/responses/NotAuthorized"}}}},"/search/assignments/results":{"post":{"tags":["search"],"summary":"Search for scheduling assignments","security":[{"oauth2":["read:advanced_searches"]}],"operationId":"getSchedulingAssignmentAdvancedSearchResults","parameters":[{"$ref":"#/components/parameters/PerPage"},{"$ref":"#/components/parameters/Page"}],"requestBody":{"description":"search filters and configuration","content":{"application/json":{"schema":{"type":"object","properties":{"configuration":{"$ref":"#/components/schemas/SearchConfiguration"},"filters":{"type":"object","properties":{}}}}}},"required":true},"responses":{"200":{"description":"Returns the list of assignments","headers":{"X-Offset":{"$ref":"#/components/headers/X-Offset"},"X-Per-Page":{"$ref":"#/components/headers/X-Per-Page"},"X-Total-Pages":{"$ref":"#/components/headers/X-Total-Pages"},"X-Page":{"$ref":"#/components/headers/X-Page"}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AssignmentAdvanceSearchSerializer"}}}}},"401":{"$ref":"#/components/responses/NotAuthenticated"},"403":{"$ref":"#/components/responses/NotAuthorized"},"412":{"$ref":"#/components/responses/NotValid"}},"x-codegen-request-body-name":"searchRequest"}},"/search/categories/results":{"post":{"tags":["search"],"summary":"Search for scheduling categories","security":[{"oauth2":["read:advanced_searches"]}],"operationId":"getSchedulingCategoriesAdvancedSearchResults","parameters":[{"$ref":"#/components/parameters/PerPage"},{"$ref":"#/components/parameters/Page"}],"requestBody":{"description":"search filters and configuration","content":{"application/json":{"schema":{"type":"object","properties":{"configuration":{"$ref":"#/components/schemas/SearchConfiguration"},"filters":{"type":"object","properties":{}}}}}},"required":true},"responses":{"200":{"description":"Returns the list of categories","headers":{"X-Offset":{"$ref":"#/components/headers/X-Offset"},"X-Per-Page":{"$ref":"#/components/headers/X-Per-Page"},"X-Total-Pages":{"$ref":"#/components/headers/X-Total-Pages"},"X-Page":{"$ref":"#/components/headers/X-Page"}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CategorySerializer"}}}}},"401":{"$ref":"#/components/responses/NotAuthenticated"},"403":{"$ref":"#/components/responses/NotAuthorized"},"412":{"$ref":"#/components/responses/NotValid"}},"x-codegen-request-body-name":"searchRequest"}},"/search/department_detail/results":{"post":{"tags":["search"],"summary":"Search for department details","security":[{"oauth2":["read:advanced_searches"]}],"operationId":"getDepartmentDetailAdvancedSearchResults","parameters":[{"$ref":"#/components/parameters/PerPage"},{"$ref":"#/components/parameters/Page"}],"requestBody":{"description":"search filters and configuration","content":{"application/json":{"schema":{"type":"object","properties":{"configuration":{"$ref":"#/components/schemas/SearchConfiguration"},"filters":{"type":"object","properties":{}}}}}},"required":true},"responses":{"200":{"description":"Returns the list of department details","headers":{"X-Offset":{"$ref":"#/components/headers/X-Offset"},"X-Per-Page":{"$ref":"#/components/headers/X-Per-Page"},"X-Total-Pages":{"$ref":"#/components/headers/X-Total-Pages"},"X-Page":{"$ref":"#/components/headers/X-Page"}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DepartmentDetailsSerializer"}}}}},"401":{"$ref":"#/components/responses/NotAuthenticated"},"403":{"$ref":"#/components/responses/NotAuthorized"},"412":{"$ref":"#/components/responses/NotValid"}},"x-codegen-request-body-name":"searchRequest"}},"/search/groups/results":{"post":{"tags":["search"],"summary":"Search for groups","security":[{"oauth2":["read:advanced_searches"]}],"operationId":"getGroupAdvancedSearchResults","parameters":[{"$ref":"#/components/parameters/PerPage"},{"$ref":"#/components/parameters/Page"}],"requestBody":{"description":"search filters and configuration","content":{"application/json":{"schema":{"type":"object","properties":{"configuration":{"$ref":"#/components/schemas/SearchConfiguration"},"filters":{"type":"object","properties":{}}}}}},"required":true},"responses":{"200":{"description":"Returns the list of groups","headers":{"X-Offset":{"$ref":"#/components/headers/X-Offset"},"X-Per-Page":{"$ref":"#/components/headers/X-Per-Page"},"X-Total-Pages":{"$ref":"#/components/headers/X-Total-Pages"},"X-Page":{"$ref":"#/components/headers/X-Page"}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BasicGroupSerializer"}}}}},"401":{"$ref":"#/components/responses/NotAuthenticated"},"403":{"$ref":"#/components/responses/NotAuthorized"},"412":{"$ref":"#/components/responses/NotValid"}},"x-codegen-request-body-name":"searchRequest"}},"/search/individual_event_attendance/results":{"post":{"tags":["search"],"summary":"Search for event attendance","security":[{"oauth2":["read:advanced_searches"]}],"operationId":"getEventAttendanceAdvancedSearchResults","parameters":[{"$ref":"#/components/parameters/PerPage"},{"$ref":"#/components/parameters/Page"}],"requestBody":{"description":"search filters and configuration","content":{"application/json":{"schema":{"type":"object","properties":{"configuration":{"$ref":"#/components/schemas/SearchConfiguration"},"filters":{"type":"object","properties":{}}}}}},"required":true},"responses":{"200":{"description":"Returns the list of event attendance records","headers":{"X-Offset":{"$ref":"#/components/headers/X-Offset"},"X-Per-Page":{"$ref":"#/components/headers/X-Per-Page"},"X-Total-Pages":{"$ref":"#/components/headers/X-Total-Pages"},"X-Page":{"$ref":"#/components/headers/X-Page"}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/EventAttendanceSummarySerializer"}}}}},"401":{"$ref":"#/components/responses/NotAuthenticated"},"403":{"$ref":"#/components/responses/NotAuthorized"},"412":{"$ref":"#/components/responses/NotValid"}},"x-codegen-request-body-name":"searchRequest"}},"/search/individual_groups/results":{"post":{"tags":["search"],"summary":"Search for groups associated to an individual","security":[{"oauth2":["read:advanced_searches"]}],"operationId":"getIndividualGroupAdvancedSearchResults","parameters":[{"$ref":"#/components/parameters/PerPage"},{"$ref":"#/components/parameters/Page"}],"requestBody":{"description":"search filters and configuration","content":{"application/json":{"schema":{"type":"object","properties":{"configuration":{"$ref":"#/components/schemas/SearchConfiguration"},"filters":{"type":"object","properties":{}}}}}},"required":true},"responses":{"200":{"description":"Returns the list of groups","headers":{"X-Offset":{"$ref":"#/components/headers/X-Offset"},"X-Per-Page":{"$ref":"#/components/headers/X-Per-Page"},"X-Total-Pages":{"$ref":"#/components/headers/X-Total-Pages"},"X-Page":{"$ref":"#/components/headers/X-Page"}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BasicIndividualGroupsProfileWithGroupSerializer"}}}}},"401":{"$ref":"#/components/responses/NotAuthenticated"},"403":{"$ref":"#/components/responses/NotAuthorized"},"412":{"$ref":"#/components/responses/NotValid"}},"x-codegen-request-body-name":"searchRequest"}},"/search/individuals/results":{"post":{"tags":["search"],"summary":"Search for individuals","security":[{"oauth2":["read:advanced_searches"]}],"operationId":"getIndividualAdvancedSearchResults","parameters":[{"$ref":"#/components/parameters/PerPage"},{"$ref":"#/components/parameters/Page"}],"requestBody":{"description":"search filters and configuration","content":{"application/json":{"schema":{"type":"object","properties":{"configuration":{"$ref":"#/components/schemas/IndividualSearchConfiguration"},"filters":{"type":"object","properties":{},"description":"You can see the individual params [here](/documentation/documents/search_params_individuals.html).\nYou can see an overview of search filters [here](/documentation/documents/search_overview.html)\n"}}}}},"required":true},"responses":{"200":{"description":"Returns the list of individuals","headers":{"X-Offset":{"$ref":"#/components/headers/X-Offset"},"X-Per-Page":{"$ref":"#/components/headers/X-Per-Page"},"X-Total-Pages":{"$ref":"#/components/headers/X-Total-Pages"},"X-Page":{"$ref":"#/components/headers/X-Page"}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/IndividualDetailsSerializer"}}}}},"401":{"$ref":"#/components/responses/NotAuthenticated"},"403":{"$ref":"#/components/responses/NotAuthorized"},"412":{"$ref":"#/components/responses/NotValid"}},"x-codegen-request-body-name":"individualSearchRequest"}},"/search/individuals/actions/mass_edit_sacraments":{"post":{"tags":["search"],"summary":"mass edit sacraments for individuals","security":[{"oauth2":["read:advanced_searches"]}],"operationId":"performMassEditSacraments","parameters":[{"$ref":"#/components/parameters/PerPage"},{"$ref":"#/components/parameters/Page"}],"requestBody":{"description":"search filters and configuration","content":{"application/json":{"schema":{"type":"object","properties":{"configuration":{"$ref":"#/components/schemas/IndividualSearchConfiguration"},"filters":{"type":"object","properties":{},"description":"You can see the individual params [here](/documentation/documents/search_params_individuals.html).\nYou can see an overview of search filters [here](/documentation/documents/search_overview.html)\n"}}}}},"required":true},"responses":{"200":{"description":"Returns the list of updated sacrament individuals","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BasicResultsActionSerializer"}}}}},"401":{"$ref":"#/components/responses/NotAuthenticated"},"403":{"$ref":"#/components/responses/NotAuthorized"}},"x-codegen-request-body-name":"individualSearchRequest"}},"/search/organizers/results":{"post":{"tags":["search"],"summary":"Search for scheduling organizers","security":[{"oauth2":["read:advanced_searches"]}],"operationId":"getSchedulingOrganizerAdvancedSearchResults","parameters":[{"$ref":"#/components/parameters/PerPage"},{"$ref":"#/components/parameters/Page"}],"requestBody":{"description":"search filters and configuration","content":{"application/json":{"schema":{"type":"object","properties":{"configuration":{"$ref":"#/components/schemas/SearchConfiguration"},"filters":{"type":"object","properties":{}}}}}},"required":true},"responses":{"200":{"description":"Returns the list of scheduling organizers","headers":{"X-Offset":{"$ref":"#/components/headers/X-Offset"},"X-Per-Page":{"$ref":"#/components/headers/X-Per-Page"},"X-Total-Pages":{"$ref":"#/components/headers/X-Total-Pages"},"X-Page":{"$ref":"#/components/headers/X-Page"}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/OrganizerAdvanceSearchSerializer"}}}}},"401":{"$ref":"#/components/responses/NotAuthenticated"},"403":{"$ref":"#/components/responses/NotAuthorized"},"412":{"$ref":"#/components/responses/NotValid"}},"x-codegen-request-body-name":"searchRequest"}},"/search/positions/results":{"post":{"tags":["search"],"summary":"Search for scheduling positions","security":[{"oauth2":["read:advanced_searches"]}],"operationId":"getSchedulingPositionAdvancedSearchResults","parameters":[{"$ref":"#/components/parameters/PerPage"},{"$ref":"#/components/parameters/Page"}],"requestBody":{"description":"search filters and configuration","content":{"application/json":{"schema":{"type":"object","properties":{"configuration":{"$ref":"#/components/schemas/SearchConfiguration"},"filters":{"type":"object","properties":{}}}}}},"required":true},"responses":{"200":{"description":"Returns the list of scheduling positions","headers":{"X-Offset":{"$ref":"#/components/headers/X-Offset"},"X-Per-Page":{"$ref":"#/components/headers/X-Per-Page"},"X-Total-Pages":{"$ref":"#/components/headers/X-Total-Pages"},"X-Page":{"$ref":"#/components/headers/X-Page"}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PositionAdvanceSearchSerializer"}}}}},"401":{"$ref":"#/components/responses/NotAuthenticated"},"403":{"$ref":"#/components/responses/NotAuthorized"},"412":{"$ref":"#/components/responses/NotValid"}},"x-codegen-request-body-name":"searchRequest"}},"/search/schedules/results":{"post":{"tags":["search"],"summary":"Search for schedules","security":[{"oauth2":["read:advanced_searches"]}],"operationId":"getScheduleAdvancedSearchResults","parameters":[{"$ref":"#/components/parameters/PerPage"},{"$ref":"#/components/parameters/Page"}],"requestBody":{"description":"search filters and configuration","content":{"application/json":{"schema":{"type":"object","properties":{"configuration":{"$ref":"#/components/schemas/SearchConfiguration"},"filters":{"type":"object","properties":{}}}}}},"required":true},"responses":{"200":{"description":"Returns the list of schedules","headers":{"X-Offset":{"$ref":"#/components/headers/X-Offset"},"X-Per-Page":{"$ref":"#/components/headers/X-Per-Page"},"X-Total-Pages":{"$ref":"#/components/headers/X-Total-Pages"},"X-Page":{"$ref":"#/components/headers/X-Page"}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ScheduleAdvanceSearchSerializer"}}}}},"401":{"$ref":"#/components/responses/NotAuthenticated"},"403":{"$ref":"#/components/responses/NotAuthorized"},"412":{"$ref":"#/components/responses/NotValid"}},"x-codegen-request-body-name":"searchRequest"}},"/search/schedules_totals/results":{"post":{"tags":["search"],"summary":"Search for totals for schedule results","security":[{"oauth2":["read:advanced_searches"]}],"operationId":"getScheduleTotalAdvancedSearchResults","parameters":[{"$ref":"#/components/parameters/PerPage"},{"$ref":"#/components/parameters/Page"}],"requestBody":{"description":"search filters and configuration","content":{"application/json":{"schema":{"type":"object","properties":{"configuration":{"$ref":"#/components/schemas/SearchConfiguration"},"filters":{"type":"object","properties":{}}}}}},"required":true},"responses":{"200":{"description":"Returns the of schedule totals","headers":{"X-Offset":{"$ref":"#/components/headers/X-Offset"},"X-Per-Page":{"$ref":"#/components/headers/X-Per-Page"},"X-Total-Pages":{"$ref":"#/components/headers/X-Total-Pages"},"X-Page":{"$ref":"#/components/headers/X-Page"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScheduleTotalsAdvanceSearchSerializer"}}}},"401":{"$ref":"#/components/responses/NotAuthenticated"},"403":{"$ref":"#/components/responses/NotAuthorized"},"412":{"$ref":"#/components/responses/NotValid"}},"x-codegen-request-body-name":"searchRequest"}},"/search/scheduling_files/results":{"post":{"tags":["search"],"summary":"Search for scheduling files","security":[{"oauth2":["read:advanced_searches"]}],"operationId":"getScheduleFileAdvancedSearchResults","parameters":[{"$ref":"#/components/parameters/PerPage"},{"$ref":"#/components/parameters/Page"}],"requestBody":{"description":"search filters and configuration","content":{"application/json":{"schema":{"type":"object","properties":{"configuration":{"$ref":"#/components/schemas/SearchConfiguration"},"filters":{"type":"object","properties":{}}}}}},"required":true},"responses":{"200":{"description":"Returns the list of scheduling files","headers":{"X-Offset":{"$ref":"#/components/headers/X-Offset"},"X-Per-Page":{"$ref":"#/components/headers/X-Per-Page"},"X-Total-Pages":{"$ref":"#/components/headers/X-Total-Pages"},"X-Page":{"$ref":"#/components/headers/X-Page"}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SearchFileDetailSerializer"}}}}},"401":{"$ref":"#/components/responses/NotAuthenticated"},"403":{"$ref":"#/components/responses/NotAuthorized"},"412":{"$ref":"#/components/responses/NotValid"}},"x-codegen-request-body-name":"searchRequest"}},"/search/scheduling_individuals/results":{"post":{"tags":["search"],"summary":"Search for individuals under a scheduling context","security":[{"oauth2":["read:advanced_searches"]}],"operationId":"getSchedulingIndividualAdvancedSearchResults","parameters":[{"$ref":"#/components/parameters/PerPage"},{"$ref":"#/components/parameters/Page"}],"requestBody":{"description":"search filters and configuration","content":{"application/json":{"schema":{"type":"object","properties":{"configuration":{"$ref":"#/components/schemas/SearchConfiguration"},"filters":{"type":"object","properties":{}}}}}},"required":true},"responses":{"200":{"description":"Returns the list of individuals","headers":{"X-Offset":{"$ref":"#/components/headers/X-Offset"},"X-Per-Page":{"$ref":"#/components/headers/X-Per-Page"},"X-Total-Pages":{"$ref":"#/components/headers/X-Total-Pages"},"X-Page":{"$ref":"#/components/headers/X-Page"}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SchedulingIndividualSerializer"}}}}},"401":{"$ref":"#/components/responses/NotAuthenticated"},"403":{"$ref":"#/components/responses/NotAuthorized"},"412":{"$ref":"#/components/responses/NotValid"}},"x-codegen-request-body-name":"searchRequest"}},"/search/songs/results":{"post":{"tags":["search"],"summary":"Search for songs","security":[{"oauth2":["read:advanced_searches"]}],"operationId":"getSongAdvancedSearchResults","parameters":[{"$ref":"#/components/parameters/PerPage"},{"$ref":"#/components/parameters/Page"}],"requestBody":{"description":"search filters and configuration","content":{"application/json":{"schema":{"type":"object","properties":{"configuration":{"$ref":"#/components/schemas/SearchConfiguration"},"filters":{"type":"object","properties":{}}}}}},"required":true},"responses":{"200":{"description":"Returns the list of songs","headers":{"X-Offset":{"$ref":"#/components/headers/X-Offset"},"X-Per-Page":{"$ref":"#/components/headers/X-Per-Page"},"X-Total-Pages":{"$ref":"#/components/headers/X-Total-Pages"},"X-Page":{"$ref":"#/components/headers/X-Page"}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SongSearchSerializer"}}}}},"401":{"$ref":"#/components/responses/NotAuthenticated"},"403":{"$ref":"#/components/responses/NotAuthorized"},"412":{"$ref":"#/components/responses/NotValid"}},"x-codegen-request-body-name":"searchRequest"}},"/search/volunteers/results":{"post":{"tags":["search"],"summary":"Search for scheduling volunteers","security":[{"oauth2":["read:advanced_searches"]}],"operationId":"getSchedulingVolunteerAdvancedSearchResults","parameters":[{"$ref":"#/components/parameters/PerPage"},{"$ref":"#/components/parameters/Page"}],"requestBody":{"description":"search filters and configuration","content":{"application/json":{"schema":{"type":"object","properties":{"configuration":{"$ref":"#/components/schemas/SearchConfiguration"},"filters":{"type":"object","properties":{}}}}}},"required":true},"responses":{"200":{"description":"Returns the list of volunteers","headers":{"X-Offset":{"$ref":"#/components/headers/X-Offset"},"X-Per-Page":{"$ref":"#/components/headers/X-Per-Page"},"X-Total-Pages":{"$ref":"#/components/headers/X-Total-Pages"},"X-Page":{"$ref":"#/components/headers/X-Page"}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/VolunteerAdvanceSearchSerializer"}}}}},"401":{"$ref":"#/components/responses/NotAuthenticated"},"403":{"$ref":"#/components/responses/NotAuthorized"},"412":{"$ref":"#/components/responses/NotValid"}},"x-codegen-request-body-name":"searchRequest"}},"/search/criteria/{domain}":{"get":{"tags":["search"],"summary":"Use `GET /search/{domain}` instead","security":[{"oauth2":["read:advanced_searches"]}],"operationId":"getAdvancedSearchCriteria","parameters":[{"name":"domain","in":"path","description":"the domain for which to get criteria","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Comma separated list of allowed criteria","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BasicCriteriaSerializer"}}}}},"403":{"$ref":"#/components/responses/NotAuthorized"}},"deprecated":true}},"/search/save":{"post":{"tags":["search"],"summary":"Save an advanced search","security":[{"oauth2":["write:advanced_searches"]}],"operationId":"saveAdvancedSearch","parameters":[{"$ref":"#/components/parameters/PerPage"},{"$ref":"#/components/parameters/Page"}],"requestBody":{"$ref":"#/components/requestBodies/SavedSearchParams"},"responses":{"200":{"description":"The search result object will be different for each domain.\n* When the setting output - csv is added, the data is run through the CsvOutputAdvancedSearchSerializer to return a CSV file.\n","headers":{"X-Offset":{"$ref":"#/components/headers/X-Offset"},"X-Per-Page":{"$ref":"#/components/headers/X-Per-Page"},"X-Total-Pages":{"$ref":"#/components/headers/X-Total-Pages"},"X-Page":{"$ref":"#/components/headers/X-Page"}},"content":{"application/json":{"schema":{"type":"object"}}}},"401":{"$ref":"#/components/responses/NotAuthenticated"},"403":{"$ref":"#/components/responses/NotAuthorized"}}}},"/search/save/{id}":{"put":{"tags":["search"],"summary":"Update an advanced search","security":[{"oauth2":["write:advanced_searches"]}],"operationId":"updateAdvancedSearch","parameters":[{"$ref":"#/components/parameters/PerPage"},{"$ref":"#/components/parameters/Page"},{"name":"id","in":"path","description":"The search's id","required":true,"schema":{"type":"integer"}}],"requestBody":{"$ref":"#/components/requestBodies/SavedSearchParams"},"responses":{"200":{"description":"The search result object will be different for each domain.\n* When the setting output - csv is added, the data is run through the CsvOutputAdvancedSearchSerializer to return a CSV file.\n","headers":{"X-Offset":{"$ref":"#/components/headers/X-Offset"},"X-Per-Page":{"$ref":"#/components/headers/X-Per-Page"},"X-Total-Pages":{"$ref":"#/components/headers/X-Total-Pages"},"X-Page":{"$ref":"#/components/headers/X-Page"}},"content":{"application/json":{"schema":{"type":"object"}}}},"401":{"$ref":"#/components/responses/NotAuthenticated"},"403":{"$ref":"#/components/responses/NotAuthorized"}}}},"/search/results":{"post":{"tags":["search"],"summary":"Use `POST /search/{domain}/results` instead","security":[{"oauth2":["read:advanced_searches"]}],"operationId":"performUnsavedAdvancedSearch","parameters":[{"$ref":"#/components/parameters/PerPage"},{"$ref":"#/components/parameters/Page"}],"requestBody":{"description":"The individuals advanced search __filters__ can be found [here](/documentation/documents/search_params_individuals.html)\nThe groups advanced search __filters__ can be found [here](/documentation/documents/search_params_groups.html)\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PerformUnsavedAdvancedSearchRequestDeprecated"}}},"required":false},"responses":{"200":{"description":"The search result object will be different for each domain.\n* When the setting output - csv is added, the data is run through the CsvOutputAdvancedSearchSerializer to return a CSV file.\n","headers":{"X-Offset":{"$ref":"#/components/headers/X-Offset"},"X-Per-Page":{"$ref":"#/components/headers/X-Per-Page"},"X-Total-Pages":{"$ref":"#/components/headers/X-Total-Pages"},"X-Page":{"$ref":"#/components/headers/X-Page"}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SearchResultsSerializer"}}}}},"401":{"$ref":"#/components/responses/NotAuthenticated"},"403":{"$ref":"#/components/responses/NotAuthorized"},"412":{"$ref":"#/components/responses/NotValid"}},"deprecated":true,"x-codegen-request-body-name":"performUnsavedAdvancedSearchRequestDeprecated"}},"/me":{"get":{"tags":["session"],"summary":"Get information about the current logged in individual","description":"Returns the individual associated with the access token","security":[],"operationId":"getMe","responses":{"200":{"description":"Current Individual Information","content":{"*/*":{"schema":{"$ref":"#/components/schemas/MeDetailsSerializer"}}}}}}},"/reset_password":{"post":{"tags":["session"],"summary":"Generates reset password email","description":"Available with client_credential auth type","security":[],"operationId":"resetPassword","requestBody":{"content":{"*/*":{"schema":{"type":"object","properties":{"email":{"type":"string","description":"The email of the individual for the password reset","format":"email"}}}}},"required":false},"responses":{"200":{"description":"Empty response","content":{}}},"x-codegen-request-body-name":""}},"/settings/financial":{"get":{"tags":["settings"],"summary":"Returns organization financial settings","security":[{"oauth2":["read:settings_financial"]}],"operationId":"getFinancialSettings","responses":{"200":{"description":"Financial Settings","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BasicFinancialSettingsSerializer"}}}}},"401":{"$ref":"#/components/responses/NotAuthenticated"},"403":{"$ref":"#/components/responses/NotAuthorized"}}},"put":{"tags":["settings"],"summary":"Update organization financial settings","security":[{"oauth2":["write:settings_financial"]}],"operationId":"updateFinancialSettings","requestBody":{"description":"Financial settings that can be updated","content":{"application/json":{"schema":{"type":"object","properties":{"system_wide_financials":{"type":"string","enum":["ADMIN"]},"allow_credit_card":{"type":"boolean"},"allow_public_giving":{"type":"boolean"}}}}},"required":false},"responses":{"200":{"description":"Update organization financial settings","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BasicFinancialSettingsSerializer"}}}},"401":{"$ref":"#/components/responses/NotAuthenticated"},"403":{"$ref":"#/components/responses/NotAuthorized"}},"x-codegen-request-body-name":"financial settings"}},"/templates":{"get":{"tags":["templates"],"summary":"Search and filter templates","security":[{"oauth2":["read:templates"]}],"operationId":"getTemplates","parameters":[{"name":"shared_with_campus_ids","in":"query","description":"array of campus ids the template has been shared to","style":"form","explode":true,"schema":{"type":"array","items":{"type":"integer"}}},{"name":"creator_ids","in":"query","description":"array of individual ids who created template","style":"form","explode":true,"schema":{"type":"array","items":{"type":"integer"}}},{"name":"entity_types","in":"query","description":"array of different entity types","style":"form","explode":true,"schema":{"type":"array","items":{"$ref":"#/components/schemas/TemplateEntityType"}}},{"name":"is_system_defined","in":"query","schema":{"type":"boolean"}},{"name":"sort_by","in":"query","description":"sort templates by name, last used by date, or last modified date","schema":{"type":"string","format":"enum - NAME - LAST_USED - LAST_MODIFIED"}},{"name":"sort_direction","in":"query","description":"sort templates in ascending or descending in order","schema":{"type":"string","format":"enum - ASC - DESC"}},{"name":"page","in":"query","description":"query page number","schema":{"type":"integer"}},{"name":"perPage","in":"query","description":"number of results per page","schema":{"type":"integer"}}],"responses":{"200":{"description":"Templates list","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Template"}}}}}}},"post":{"tags":["templates"],"summary":"create a new template","security":[{"oauth2":["write:templates"]}],"operationId":"createTemplate","requestBody":{"$ref":"#/components/requestBodies/CreateTemplateRequest"},"responses":{"201":{"$ref":"#/components/responses/TemplateDetailsResponse"}}}},"/templates/{id}":{"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"The template id"}],"get":{"tags":["templates"],"summary":"get a single template","security":[{"oauth2":["read:templates"]}],"operationId":"getTemplate","responses":{"200":{"$ref":"#/components/responses/TemplateDetailsResponse"}}},"put":{"tags":["templates"],"summary":"edit a template","security":[{"oauth2":["write:templates"]}],"operationId":"updateTemplate","requestBody":{"$ref":"#/components/requestBodies/UpdateTemplateRequest"},"responses":{"200":{"$ref":"#/components/responses/TemplateDetailsResponse"}}},"delete":{"tags":["templates"],"summary":"delete a template","security":[{"oauth2":["write:templates"]}],"operationId":"deleteTemplate","responses":{"200":{"description":"Empty response","content":{}}}}},"/templates/{id}/entities":{"post":{"tags":["templates"],"summary":"Use a template to create a new entity, such as a form or mail merge","security":[{"oauth2":["write:templates"]}],"operationId":"useTemplateToCreateEntity","parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"The template id"}],"requestBody":{"$ref":"#/components/requestBodies/UseTemplateRequest"},"responses":{"200":{"description":"entity id","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"integer"}}}}}}}}}},"components":{"securitySchemes":{"BearerTokenHeader":{"type":"http","scheme":"bearer"},"oauth2":{"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"/oauth/authorize","tokenUrl":"/oauth/token","scopes":{"delete:forms":"Delete forms","delete:messages":"Delete messages","delete:needs":"Delete needs","delete:notes":"Delete notes","delete:process_manager":"Remove a process manager assignment","delete:process_queues":"Delete process queues","delete:processes":"Delete processes","delete:queue_individuals":"Remove individuals from queues","delete:queue_managers":"Remove queue manager assignments","read:advanced_searches":"Read advanced search configurations","read:attendance_groupings":"Read attendance grouping definitions","read:auto_schedule":"Read auto schedule configurations","read:background_checks":"Read background checks","read:campuses":"Read campus information","read:church":"Read church information and configuration","read:custom_fields":"Read custom field definitions","read:departments":"Read department information","read:event_attendance":"Read event attendance","read:event_resources":"Read event resources","read:events":"Read event information","read:files":"Read uploaded files","read:form_responses":"Read form responses","read:forms":"Read form definitions and responses","read:group_members":"Read group members","read:groups":"Read group information","read:individual_departments":"Read individual department assignments","read:individual_events":"Read individual events","read:individual_files":"Read files attached to individual profiles","read:individual_forms":"Read individual forms","read:individual_groups":"Read individual groups","read:individual_messages":"Read messages associated with individuals","read:individual_needs":"Read individual needs","read:individual_notes":"Read individual notes","read:individual_pledges":"Read individual pledges","read:individual_scheduled_gifts":"Read individual scheduled giving plans","read:individuals":"Read individual profiles","read:individuals_metrics":"Read individuals metrics","read:individuals_privacy_settings":"Read individuals privacy settings","read:integrations":"Read integration configurations","read:leadership_roles":"Read campus leadership role definitions","read:messages":"Read messages","read:needs":"Read needs and volunteer opportunities","read:notes":"Read notes on individuals, groups, and other records","read:privacy_defaults":"Read church privacy default settings","read:process_managers":"Read process manager assignments","read:process_queues":"Read process queue configurations and items","read:processes":"Read process definitions","read:queue_individuals":"Read individuals assigned to queues","read:queue_managers":"Read queue manager assignments","read:scheduling":"Read scheduling plans and assignments","read:workflows":"Read workflow configurations and steps","read:service_times":"Read campus service time schedules","read:settings_financial":"Read settings financial","read:templates":"Read message and document templates","write:advanced_searches":"Create and update advanced searches","write:auto_schedule":"Create and update auto schedule configurations","write:background_checks":"Create and update background checks","write:campuses":"Create and update campus information","write:event_attendance":"Create and update event attendance","write:events":"Create and update events","write:files":"Upload and manage files","write:form_responses":"Create and update form responses","write:forms":"Create and update forms","write:group_members":"Create and update group members","write:groups":"Create and update groups","write:individual_events":"Create and update individual events","write:individual_files":"Upload and manage files on individual profiles","write:individual_groups":"Create and update individual groups","write:individual_messages":"Create and update individual messages","write:individual_notes":"Create and update individual notes","write:individual_scheduled_gifts":"Update individual scheduled giving plans","write:individuals":"Create and update individual profiles","write:individuals_privacy_settings":"Create and update individuals privacy settings","write:messages":"Create and update messages","write:needs":"Create and update needs","write:notes":"Create and update notes","write:privacy_defaults":"Update church privacy default settings","write:process_managers":"Add and update process managers","write:process_queues":"Create and update process queues","write:processes":"Create and update processes","write:queue_individuals":"Manage individuals assigned to queues","write:queue_managers":"Add and update queue managers","write:schedules":"Create and update schedules","write:scheduling":"Create and update scheduling plans and assignments","write:settings_financial":"Create and update settings financial","write:step_actions":"Create step actions","write:templates":"Create and update templates"}}}}},"responses":{"NotAuthenticated":{"description":"You are not authenticated","content":{}},"NotAuthorized":{"description":"Do not have the permission to access","content":{}},"NotFound":{"description":"Not found","content":{}},"NotValid":{"description":"The request failed validation","content":{}},"AutoScheduleSuccessResponse":{"description":"Map of event position ids and how many are still needed for each position","content":{"application/json":{"schema":{"type":"object","properties":{"needed":{"type":"integer"},"scheduled":{"type":"integer"},"events":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"},"start":{"type":"string","format":"date-time"},"needed":{"type":"integer"},"scheduled":{"type":"integer"}}}}}}}}},"GetScheduleNotificationMetricsResponse":{"description":"The schedule notification metrics","content":{"application/json":{"schema":{"type":"object","properties":{"total_recipients_count":{"type":"integer"},"email_recipients_count":{"type":"integer"},"text_recipients_count":{"type":"integer"},"missing_or_unsubscribed_count":{"type":"integer"}}}}}},"TemplateDetailsResponse":{"description":"A template","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Template"}}}}},"schemas":{"BasicLeadershipRoleSerializer":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"},"identifier":{"type":"string"},"description":{"type":"string"},"status":{"type":"string","enum":["ENABLED","DISABLED"]},"assignees":{"type":"array","items":{"$ref":"#/components/schemas/BasicIndividualProfileSerializer"}}}},"CampusServiceSerializer":{"type":"object","properties":{"id":{"type":"integer"},"campus_id":{"type":"integer"},"day_of_week":{"type":"string","enum":["SUNDAY","MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY"]},"start":{"type":"string","format":"time"},"end":{"type":"string","format":"time"}}},"BasicCampusSerializer":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"},"timezone":{"type":"string"},"locale":{"type":"string"},"country":{"type":"string"},"public_gift_message":{"type":"string"},"distance":{"type":"number","format":"float"},"actions":{"type":"object","properties":{"can_give":{"$ref":"#/components/schemas/Action"},"can_split_gifts":{"$ref":"#/components/schemas/Action"},"can_create_individuals":{"$ref":"#/components/schemas/Action"},"can_view_all_events_admin_calendar":{"$ref":"#/components/schemas/Action"},"can_view_facilities_calendar":{"$ref":"#/components/schemas/Action"},"can_view_draft_events_calendar":{"$ref":"#/components/schemas/Action"},"can_view_campus_wide_calendar":{"$ref":"#/components/schemas/Action"},"can_edit_schedules":{"$ref":"#/components/schemas/Action"},"can_perform_volunteer_checkin":{"$ref":"#/components/schemas/Action"}}}}},"UpdateCampusRequestSerializer":{"type":"object","properties":{"online_gift_message":{"type":"string"}}},"IndividualFavoriteCampusSerializer":{"type":"object","properties":{"individual_id":{"type":"integer"},"campus_id":{"type":"integer"},"date_created":{"type":"string","format":"date-time"}}},"PrivacyDefaultsSerializer":{"type":"object","properties":{"default_admin_created_profile":{"type":"string","enum":["LIMITED","BASIC"]},"default_approved_profile":{"type":"string","enum":["LIMITED","BASIC"]},"default_congregant_created_profile":{"type":"string","enum":["PENDING","LIMITED","BASIC"]},"default_listed":{"type":"boolean"},"default_address_privacy_level":{"type":"string","enum":["LEADERSHIP_ONLY","GROUP_MEMBERS","EVERYONE"]},"default_anniversary_privacy_level":{"type":"string","enum":["LEADERSHIP_ONLY","GROUP_MEMBERS","EVERYONE"]},"default_birthday_privacy_level":{"type":"string","enum":["LEADERSHIP_ONLY","GROUP_MEMBERS","EVERYONE"]},"default_email_privacy_level":{"type":"string","enum":["LEADERSHIP_ONLY","GROUP_MEMBERS","EVERYONE"]},"default_phone_privacy_level":{"type":"string","enum":["LEADERSHIP_ONLY","GROUP_MEMBERS","EVERYONE"]}}},"BasicChurchSerializer":{"type":"object","properties":{"id":{"type":"integer"},"master_ecg_id":{"type":"string"},"name":{"type":"string","example":"Church Partner"},"subdomain":{"type":"string"},"api_base_url":{"type":"string"},"base_url":{"type":"string"},"welcomeText":{"type":"string"},"is_fake":{"type":"boolean"},"public_find_group_name":{"type":"string"},"urls":{"type":"object","properties":{},"example":{"base":"https://...","api_base":"https://...","events":"https://...","events_public":"https://...","calendar_ical":"https://...","forms":"https://...","forms_public":"https://...","groups":"https://...","groups_public":"https://...","needs":"https://...","needs_public":"https://...","giving":"https://...","giving_public":"https://...","forgot_password":"https://...","login":"https://...","sign_up":"https://..."}},"features":{"type":"array","items":{"type":"string"}}}},"BasicSocialNetworkSerializer":{"type":"object","properties":{"id":{"type":"integer"},"type":{"type":"string","example":"Facebook"},"url":{"type":"string","example":"http://www.facebook.com/%s"}}},"BasicMobileCarrierSerializer":{"allOf":[{"$ref":"#/components/schemas/IdName"},{"type":"object","properties":{"major":{"type":"boolean"}}}]},"BasicCountrySerializer":{"type":"object","properties":{"iso":{"type":"string"},"iso3":{"type":"string"},"name":{"type":"string"},"display_name":{"type":"string"}}},"BasicCustomFieldSerializer":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["DATE","TEXT","PULLDOWN"]},"domain":{"type":"string","enum":["INDIVIDUAL"]},"label":{"type":"string"},"admin_only":{"type":"boolean"},"choices":{"type":"array","items":{"$ref":"#/components/schemas/IdName"}}}},"Action":{"type":"object","properties":{"allowed":{"type":"boolean"},"reasons":{"type":"array","items":{"type":"string"}}}},"Images":{"type":"object","properties":{"thumbnail":{"type":"string"},"medium":{"type":"string"},"large":{"type":"string"}}},"AddressSerializer":{"type":"object","properties":{"name":{"type":"string"},"street":{"type":"string"},"city":{"type":"string"},"state":{"type":"string"},"zip":{"type":"string"},"longitude":{"type":"string"},"latitude":{"type":"string"},"country_iso":{"type":"string"},"carrier_route":{"type":"string"}}},"AccessTokenSerializer":{"title":"Access Token","type":"object","properties":{"access_token":{"type":"string"},"token_type":{"type":"string","example":"bearer"},"expires_in":{"type":"integer","example":7200},"refresh_token":{"type":"string"},"scope":{"type":"string","example":"read:individuals read:groups"}}},"BasicListSerializer":{"$ref":"#/components/schemas/IdName"},"IdName":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"}}},"ModifiedMetadata":{"type":"object","properties":{"created":{"type":"string","format":"date-time"},"creator":{"$ref":"#/components/schemas/BasicIndividualProfileSerializer"},"modified":{"type":"string","format":"date-time"},"modifier":{"$ref":"#/components/schemas/BasicIndividualProfileSerializer"}}},"ImportSerializer":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ImportError"}},"rows":{"type":"integer"},"success":{"type":"boolean"}}},"ImportError":{"type":"object","properties":{"row":{"type":"integer"},"message":{"type":"string"}}},"BasicDepartmentSerializer":{"type":"object","properties":{"id":{"type":"integer"},"owner_id":{"type":"integer"},"name":{"type":"string"},"coach_term":{"type":"string"},"coach_term_plural":{"type":"string"},"director_term":{"type":"string"},"director_term_plural":{"type":"string"},"is_administered":{"type":"boolean","description":"`true` when the current viewer has an explicit row in\n`individual_department_admins` for this department. Master /\nfull-group admins administer departments by role rather than\nby assignment, so they receive `false` here even though they\ncan edit the department; consumers that want \"can the viewer\nadminister this?\" should fall back to the role-level checks.\n"}}},"IndividualsDepartmentSerializer":{"type":"object","properties":{"individual_id":{"type":"integer"},"department_id":{"type":"integer"},"campus_id":{"type":"integer"},"created":{"type":"string","format":"date-time"},"department":{"$ref":"#/components/schemas/BasicDepartmentSerializer"}}},"DepartmentDetailsSerializer":{"type":"object","properties":{"id":{"type":"integer"},"group_id":{"type":"integer"},"department_name":{"type":"string"},"coach_term":{"type":"string"},"director_term":{"type":"string"},"group_name":{"type":"string"},"owner_id":{"type":"integer"},"owner_name":{"type":"string"},"coach_id":{"type":"integer"},"coach_name":{"type":"string"},"director_id":{"type":"integer"},"director_name":{"type":"string"},"campus_id":{"type":"integer"},"campus_name":{"type":"string"}}},"SharedEventSerializer":{"type":"object","properties":{"event_id":{"type":"integer"},"campus_id":{"type":"integer"},"status":{"$ref":"#/components/schemas/SharedEventStatus"},"campus":{"$ref":"#/components/schemas/BasicCampusSerializer"},"event_occurrence":{"$ref":"#/components/schemas/BasicEventOccurrenceSerializer"},"modifier_id":{"type":"integer"},"creator_id":{"type":"integer"},"date_modified":{"type":"string","format":"date-time"},"date_created":{"type":"string","format":"date-time"}}},"SharedEventStatus":{"type":"string","enum":["ACCEPTED","DECLINED","INVITED","REVOKED"]},"EventRangeTypeFilter":{"type":"string","enum":["ALL","PAST","CURRENT","FUTURE"]},"FullEventOccurrenceType":{"type":"object","properties":{"event_id":{"type":"integer"},"occurrence":{"pattern":"/\\d{8}/gm","type":"string"},"start":{"type":"string","format":"date-time"},"end":{"type":"string","format":"date-time"},"group_id":{"type":"integer"},"checkin_label_type":{"type":"string"},"checkin_label_quantity":{"type":"integer"},"event":{"$ref":"#/components/schemas/FullEventSerializer"}}},"BasicIndividualEventsProfileWithIndividualSerializer":{"type":"object","properties":{"event_id":{"type":"integer"},"individual_id":{"type":"integer"},"status":{"type":"string","enum":["REQUESTING","GOING","NOT_GOING","MAYBE","NOT_RESPONDED"]},"comment":{"type":"string"},"quantity":{"type":"integer"},"individual":{"$ref":"#/components/schemas/BasicIndividualProfileSerializer"}}},"BasicIndividualEventsProfileWithEventSerializer":{"type":"object","properties":{"event_id":{"type":"integer"},"individual_id":{"type":"integer"},"status":{"type":"string","enum":["REQUESTING","GOING","NOT_GOING","MAYBE","NOT_RESPONDED"]},"comment":{"type":"string"},"quantity":{"type":"integer"},"event":{"$ref":"#/components/schemas/BasicEventSerializer"}}},"CreateIndividualEventsSerializer":{"type":"object","properties":{"assignments_count":{"type":"integer"},"assignments":{"type":"object","properties":{},"description":"Map individual_id to 'CREATED'/'UPDATED'"}}},"AttendanceSummarySerializer":{"allOf":[{"$ref":"#/components/schemas/BasicEventOccurrenceSerializer"},{"type":"object","properties":{"status":{"type":"string","enum":["MET","DID_NOT_MEET","NOT_REPORTED"]},"topic":{"type":"string"},"notes":{"type":"string"},"prayer_requests":{"type":"string"},"people_information":{"type":"string"},"total_attendance":{"type":"integer"},"visitors":{"type":"integer"},"email_to":{"type":"string","enum":["LEADERS","MEMBERS","NONE"]}}}]},"BasicEventOccurrenceSerializer":{"type":"object","properties":{"event_id":{"type":"integer","example":123},"occurrence":{"pattern":"/\\d{8}/gm","type":"string"},"start":{"type":"string","format":"date-time"},"end":{"type":"string","format":"date-time"},"event":{"$ref":"#/components/schemas/BasicEventWithGroupSerializer"}}},"BasicGroupEventOccurrenceSerializer":{"type":"object","properties":{"event_id":{"type":"integer","example":123},"occurrence":{"pattern":"/\\d{8}/gm","type":"string"},"start":{"type":"string","format":"date-time"},"end":{"type":"string","format":"date-time"},"event":{"$ref":"#/components/schemas/BasicEventSerializer"}}},"CheckinObject":{"type":"object","properties":{"grouping_id":{"type":"integer","example":1},"room_ratio":{"type":"integer"},"room_description":{"type":"string"},"checkin_label_type":{"type":"string","enum":["NONE","NAME","SECURE"]},"checkin_label_quantity":{"type":"integer"},"attend_max_quantity":{"type":"integer"},"checkin_type":{"type":"string","enum":["NONE","CHECKIN","PRECHECK","INSTANT"]},"announcement":{"$ref":"#/components/schemas/CheckinAnnouncementObject"}}},"CheckinAnnouncementObject":{"type":"object","properties":{"title":{"type":"string","example":"Announcement"},"body":{"type":"string","format":"html","example":"<p>This is the body</p>"},"source":{"type":"string","enum":["EVENT","SETUP"]},"source_id":{"type":"integer","example":123}}},"BasicEventSerializer":{"type":"object","properties":{"id":{"type":"integer","example":123},"campus_id":{"type":"integer","example":1},"name":{"type":"string","example":"Guy Fawkes Day"},"description":{"type":"string"},"start":{"type":"string","format":"date-time"},"end":{"type":"string","format":"date-time"},"setup":{"type":"string","format":"date-time"},"cleanup":{"type":"string","format":"date-time"},"room_ratio":{"type":"string"},"attend_max_quantity":{"type":"string"},"room_description":{"type":"string"},"phone":{"type":"string"},"recurs":{"type":"boolean"},"recur_end_date":{"type":"string","format":"date-time"},"guest_counts":{"type":"object","properties":{"going":{"type":"integer"},"maybe":{"type":"integer"},"not_going":{"type":"integer"},"not_responded":{"type":"integer"},"requesting":{"type":"integer"}}},"address":{"$ref":"#/components/schemas/AddressSerializer"},"images":{"$ref":"#/components/schemas/Images"},"checkin":{"$ref":"#/components/schemas/CheckinObject"},"checkin_label_type":{"type":"string","enum":["NONE","NAME","SECURE"]},"checkin_label_quantity":{"type":"integer"}}},"BasicEventWithGroupSerializer":{"allOf":[{"$ref":"#/components/schemas/BasicEventSerializer"},{"type":"object","properties":{"group":{"type":"object","properties":{"id":{"type":"string","example":"123"},"name":{"type":"string","example":"My Group"}}}}}]},"FullEventSerializer":{"allOf":[{"$ref":"#/components/schemas/BasicEventSerializer"},{"type":"object","properties":{"actions":{"type":"object","properties":{"can_edit":{"type":"object","properties":{"allowed":{"type":"boolean"},"reasons":{"type":"array","items":{"type":"string","example":""}}}},"can_view_guest_list":{"type":"object","properties":{"allowed":{"type":"boolean"},"reasons":{"type":"array","items":{"type":"string","example":""}}}}}},"approval_status":{"type":"string","example":"APPROVED"},"approval_status_id":{"type":"integer"},"description":{"type":"string","format":"html"},"use_campus_address":{"type":"boolean"},"uses_resources":{"type":"boolean"},"setup_notes":{"type":"string"},"estimated_attendance":{"type":"string","example":"0"},"modifier":{"$ref":"#/components/schemas/BasicIndividualProfileSerializer"},"creator":{"$ref":"#/components/schemas/BasicIndividualProfileSerializer"},"group":{"$ref":"#/components/schemas/BasicGroupSerializer"},"date_modified":{"type":"string","format":"date-time"},"date_created":{"type":"string","format":"date-time"},"recurrence":{"type":"object","properties":{"frequency":{"type":"string"},"interval":{"type":"integer"},"frequency_modifier":{"type":"string"},"end":{"type":"string","format":"date"}}},"next_occurrence":{"type":"object","nullable":true,"properties":{"start":{"type":"string","format":"date-time"},"end":{"type":"string","format":"date-time"},"occurrence":{"type":"string"}}},"type_id":{"type":"integer"},"owner":{"$ref":"#/components/schemas/BasicIndividualProfileSerializer"},"all_day":{"type":"boolean"},"invitation_settings":{"type":"object","properties":{"show_guest_list":{"type":"boolean"},"allow_additional_guests":{"type":"boolean"},"notify_owner_of_status_changes":{"type":"boolean"},"attend_max_quantity":{"type":"integer"}}},"attendance":{"type":"object","properties":{"occurrence_has_before":{"type":"boolean"},"occurrence_has":{"type":"boolean"},"occurrence_has_after":{"type":"boolean"},"occurrence_last_with":{"type":"string","format":"date-time"}}},"registration":{"type":"object","properties":{"closed":{"type":"boolean"},"form_id":{"type":"integer"},"url":{"type":"string"}}}}}]},"BaseIndividualEventStatuses":{"type":"object","properties":{"status":{"type":"string","description":"The individual's status for the event","enum":["GOING","MAYBE","NOT_GOING"]}}},"AdminIndividualEventStatuses":{"type":"object","properties":{"status":{"type":"string","description":"The individual's status for the event","enum":["GOING","MAYBE","NOT_GOING","NOT_RESPONDED","REQUESTING"]}}},"BaseIndividualEvent":{"type":"object","properties":{"comment":{"type":"string"},"quantity":{"type":"integer","description":"The quantity of people included in the rsvp"}}},"BaseIndividualEventSerializer":{"allOf":[{"$ref":"#/components/schemas/BaseIndividualEvent"},{"type":"object","properties":{"event_id":{"type":"integer"},"individual_id":{"type":"integer"}}}]},"IndividualEventSerializer":{"allOf":[{"$ref":"#/components/schemas/BaseIndividualEventStatuses"},{"$ref":"#/components/schemas/BaseIndividualEventSerializer"},{"type":"object","properties":{"event":{"$ref":"#/components/schemas/BasicEventSerializer"}}}]},"EventGuestSerializer":{"allOf":[{"$ref":"#/components/schemas/AdminIndividualEventStatuses"},{"$ref":"#/components/schemas/BaseIndividualEventSerializer"},{"type":"object","properties":{"individual":{"$ref":"#/components/schemas/BasicIndividualProfileSerializer"}}}]},"EventCandidateIndividualSerializer":{"allOf":[{"$ref":"#/components/schemas/BasicIndividualProfileSerializer"},{"type":"object","properties":{"attended":{"type":"integer"}}}]},"EventAttendeesIndividualSerializer":{"type":"object","properties":{"event_id":{"type":"integer"},"individual_id":{"type":"integer"},"occurrence_date":{"type":"string","format":"date"},"individual":{"$ref":"#/components/schemas/BasicIndividualProfileSerializer"}}},"BasicEventSummarySerializer":{"type":"object","properties":{"event_id":{"type":"integer"},"occurrence":{"type":"string"},"start":{"type":"string","format":"date"},"end":{"type":"string","format":"date"},"status":{"type":"string"},"visitors":{"type":"integer"},"total_attendance":{"type":"integer"},"topic":{"type":"string"},"notes":{"type":"string"},"prayer_requests":{"type":"string"},"people_information":{"type":"string"},"email_to":{"type":"string"},"email_sent":{"type":"string","format":"date"}}},"EventResourceSerializer":{"type":"object","properties":{"event_id":{"type":"integer"},"resource_id":{"type":"integer"},"status":{"type":"string","enum":["PENDING","APPROVED"]},"quantity":{"type":"integer"},"setup_notes":{"type":"string"},"resource":{"$ref":"#/components/schemas/ResourceSerializer"}}},"EventRoomSerializer":{"type":"object","properties":{"event_id":{"type":"integer"},"room_id":{"type":"integer"},"status":{"type":"string","enum":["PENDING","APPROVED"]},"primary_room":{"type":"boolean"},"layout":{"type":"string","enum":["BANQUET_RECTANGLES","BANQUET_ROUNDS","BOARDROOM","CHAIRS_CIRCLE","CHAIRS_SQUARE","CHAIRS_THEATER","CHAIRS_U_SHAPE","CLASSROOM_RECTANGLES","CLASSROOM_ROUNDS","HOLLOW_SQUARE","U_SHAPE","OTHER"]},"include_head_table":{"type":"boolean"},"setup_notes":{"type":"string"},"room":{"$ref":"#/components/schemas/RoomSerializer"},"resources":{"type":"array","items":{"$ref":"#/components/schemas/EventResourceSerializer"}}}},"EventCreate":{"$ref":"#/components/schemas/EventCreateUpdate"},"EventUpdate":{"$ref":"#/components/schemas/EventCreateUpdate"},"EventCreateUpdate":{"type":"object","properties":{"all_day":{"type":"boolean"},"approval_status_id":{"type":"integer"},"cleanup":{"type":"string","format":"date-time"},"confirm_change":{"type":"boolean","description":"To confirm if a change is being \"forced\" (overiding any warnding) set to true."},"description":{"type":"string","format":"html"},"end":{"type":"string","format":"date-time"},"group_id":{"type":"integer","example":123},"name":{"type":"string","example":"Guy Fawkes Day (Updated)"},"occurrence":{"pattern":"/\\d{8}/gm","type":"string","example":"20210101"},"owner_id":{"type":"integer","example":1},"setup":{"type":"string","format":"date-time"},"start":{"type":"string","format":"date-time"},"type_id":{"type":"integer","description":"Require leader approval or form response to get on the guest list"},"uses_resources":{"type":"boolean"},"phone":{"pattern":"^\\+[1-9]\\d{1,14}$","type":"string","example":19495551234},"location_name":{"type":"string"},"location_street":{"type":"string"},"location_city":{"type":"string"},"location_state":{"type":"string"},"location_zip":{"type":"string"},"apply_changes_to":{"type":"string","enum":["ONLY_THIS_DATE","THIS_AND_FUTURE_DATES","ALL_DATES"]},"recurs":{"type":"boolean"},"recur_end_date":{"type":"string","format":"date-time"},"recur_frequency":{"type":"string","description":"Daily = D | Weekly = W | Monthly by Day = MO | Monthly by Date = MP","enum":["D","W","MO","MP"]},"recur_interval":{"type":"integer"},"recur_freq_modifier":{"type":"string","enum":["SU","MO","TU","WE","TH","FR","SA"]},"attend_max_quantity":{"type":"integer","example":100},"checkin_label_quantity":{"type":"integer"},"checkin_label_type":{"type":"string","enum":["NONE","NAME","SECURE"]},"grouping_id":{"type":"integer","example":1},"room_description":{"type":"string","example":"The Escape Room"},"room_ratio":{"type":"integer","example":1},"checkin_type":{"type":"string","enum":["NONE","CHECKIN","PRECHECK","INSTANT"]},"checkin_announcement":{"type":"object","properties":{"title":{"type":"string","example":"Announcement"},"body":{"type":"string","format":"html","example":"<p>This is the body</p>"}}}}},"EventUnableToUpdate":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string","example":"re-request, for this date only, available rooms & resources that require approval"}},"status_type":{"type":"string","example":"NOT_ACCEPTED"}}},"EventUnableToCreate":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string","example":""}},"status_type":{"type":"string","example":null}}},"FileSerializer":{"type":"object","properties":{"id":{"type":"integer"},"label":{"type":"string"},"file_name":{"type":"string"},"description":{"type":"string"},"url":{"type":"string"},"file_size":{"type":"integer"},"mime_type":{"type":"string"},"updated":{"type":"string","format":"date-time"},"created":{"type":"string","format":"date-time"}}},"IndividualFileSerializer":{"type":"object","properties":{"file_id":{"type":"integer","description":"The file's id"},"individual_id":{"type":"integer","description":"The individual's id"},"file":{"$ref":"#/components/schemas/FileSerializer"}}},"SearchFileDetailSerializer":{"type":"object","properties":{"actual_name":{"type":"string"},"attached_to":{"type":"string"},"attachment_id":{"type":"integer"},"attachment_type":{"type":"string"},"category_id":{"type":"integer"},"category_name":{"type":"string"},"creator_id":{"type":"integer"},"creator_name":{"type":"string"},"date_last_used":{"type":"string","format":"date-time"},"doc_id":{"type":"integer"},"file_type":{"type":"string"},"label":{"type":"string"},"service_plan_id":{"type":"integer"},"size":{"type":"integer"},"url":{"type":"string"}}},"BasicScheduledGiftSerializer":{"type":"object","properties":{"id":{"type":"integer"},"campus_id":{"type":"integer"},"merchant":{"type":"object","properties":{"schedule_id":{"type":"string"},"transaction_id":{"type":"string"},"notes":{"type":"string"},"status":{"type":"string"}}},"total":{"type":"integer","description":"in cents"},"inactive":{"type":"boolean","example":false},"splits":{"type":"array","items":{"type":"object","properties":{"coa":{"$ref":"#/components/schemas/BasicCOASerializer"}}}},"recurrence":{"type":"object","properties":{"frequency":{"type":"string"},"interval":{"type":"integer"},"end":{"type":"string","format":"date"},"month_days":{"type":"array","items":{"type":"integer"},"description":"array of integers","example":""},"week_days":{"type":"array","items":{"type":"string"},"description":"array of weekdays","example":""},"times":{"type":"integer"}}},"remaining":{"type":"integer"},"payment_type":{"type":"string","description":"The type of the transaction","enum":["CREDIT","ACH"]},"payment_method_type":{"type":"string","description":"The type of card used, if available","enum":["VISA","MASTERCARD","DISCOVER","AMERICAN_EXPRESS","OTHER"]},"start":{"type":"string","format":"date"},"next":{"type":"string","format":"date"},"stopped":{"type":"string","format":"date"},"created":{"type":"string","format":"date"}}},"BasicCOASerializer":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"},"amount":{"type":"integer","description":"in cents"}}},"BasicPledgeSerializer":{"type":"object","properties":{"id":{"type":"integer"},"campus_id":{"type":"integer"},"pledged":{"type":"integer","description":"in cents"},"paid":{"type":"integer","description":"in cents"},"expected":{"type":"integer","description":"in cents"},"total":{"type":"integer","description":"in cents"},"coa":{"$ref":"#/components/schemas/BasicCOASerializer"},"recurrence":{"type":"object","properties":{"frequency":{"type":"string"},"end":{"type":"string","format":"date"}}},"start":{"type":"string","format":"date"},"created":{"type":"string","format":"date"}}},"BasicFormSerializer":{"type":"object","properties":{"id":{"type":"integer"},"title":{"type":"string"},"description":{"type":"string"},"url":{"type":"string","example":"https://stable.cchchurch.com/goto/forms/1/responses/new"},"campus_id":{"type":"integer"},"start":{"type":"string","format":"date-time"},"end":{"type":"string","format":"date-time"},"public":{"type":"boolean"},"manager_count":{"type":"integer"},"status":{"$ref":"#/components/schemas/FormStatus"},"actions":{"type":"object","properties":{"can_view_form":{"$ref":"#/components/schemas/Action"},"can_edit_form":{"$ref":"#/components/schemas/Action"},"can_respond_to_form":{"$ref":"#/components/schemas/Action"}}}}},"FullFormSerializer":{"allOf":[{"$ref":"#/components/schemas/BasicFormSerializer"},{"title":"FullFormSerializer","type":"object","properties":{"disabled":{"type":"boolean","description":"not implemented yet"},"show_confirmation_code":{"type":"boolean"},"confirmation_text":{"type":"string"},"is_template":{"type":"boolean"},"unavailable_message_title":{"type":"string"},"unavailable_message_description":{"type":"string"},"authentication_required":{"type":"boolean"},"total_form_pages":{"type":"integer"},"files":{"type":"array","items":{"$ref":"#/components/schemas/FileSerializer"}},"profile":{"$ref":"#/components/schemas/FormProfile"}}}]},"FormAutomationRequest":{"type":"object","properties":{"automation_type_id":{"type":"integer"},"automation_type_name":{"type":"string","enum":["group","event","queue","new pos."]},"choice_id":{"type":"integer"},"condition_id":{"type":"integer"},"form_id":{"type":"integer"},"question_id":{"type":"integer"},"target_id":{"type":"integer"}}},"FormProfile":{"type":"object","properties":{"id":{"type":"integer"},"title":{"type":"string"},"explaination":{"type":"string"},"fields":{"type":"array","items":{"$ref":"#/components/schemas/FormProfileField"}}}},"FormProfileField":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string","enum":["FIRST_NAME","LAST_NAME","EMAIL","MAILING_ADDRESS","MOBILE_PHONE","HOME_PHONE","WORK_PHONE","BIRTHDAY","GENDER","MARITAL_STATUS"]},"required":{"type":"boolean"}}},"FormResponseRequest":{"type":"object","properties":{"individual_id":{"type":"integer"},"profile":{"type":"object","properties":{"update_individual":{"type":"boolean"},"fields":{"type":"array","items":{"type":"object","properties":{"field_id":{"type":"integer"},"answer":{"type":"string","description":"This property is an object for a mailing_address type field"}}}}}},"answers":{"type":"array","items":{"type":"object","properties":{"question_id":{"type":"integer"},"answer":{"type":"string","description":"The answer will equal one of the following based on the question type:\n* SINGLE_LINE_TEXT, PARAGRAPH_TEXT: `string`\n* DATE: `ISO8601 date string`\n* NUMBER: `integer`\n* RADIO_BUTTONS, PULLDOWN_MENU: `integer` choice_id from the question choices\n* CHECKBOXES, PRIORITIZE: `[integer]` Array of choice_ids\n* SCALE: `[{ choice_id: integer, scale_id: integer }]` Array of choice_id, scale_id objects\n* FILE_UPLOAD: `integer` file id (Upload to the POST /files endpoint first and use the id returned)\n* PRODUCT: `[{ choice_id: integer, quantity: integer }]`\n* DONATION_AMOUNT: `{ choice_id: integer, amount: integer }`\n"}}}}}},"FormSortBy":{"type":"string","enum":["TITLE","DATE_CREATED","DAT_END","DATE_START","LAST_RESPONSE","MATCHED_RESPONSES","STATUS","TITLE","TOTAL_RESPONSES","UNMATCHED_RESPONSES"]},"FormStatus":{"type":"string","enum":["ACTIVE","SCHEDULED","UNPUBLISHED","EXPIRED","ARCHIVED"]},"BasicFormResponseSerializer":{"type":"object","properties":{"id":{"type":"integer"},"individual_id":{"type":"integer"},"form_id":{"type":"integer"},"created":{"type":"string","format":"date-time"},"payment_status":{"type":"string","enum":["PAID","NOT_PAID","NA"]},"form":{"$ref":"#/components/schemas/BasicFormSerializer"}}},"FormPaymentNeededSerializer":{"type":"object","properties":{"invoice_id":{"type":"integer"},"payment_status":{"type":"string","enum":["NEEDS_PAYMENT"]},"payment_url":{"type":"string"}},"description":"The invoice_id, payment_status, and payment_url will be returned when payment is needed for a form response.\n\nMake sure you redirect to the payment_url in order to finish the payment process to save the form response.\n"},"FullFormResponseSerializer":{"allOf":[{"$ref":"#/components/schemas/BasicFormResponseSerializer"},{"title":"FullFormResponseSerializer","type":"object","properties":{"profile":{"type":"object","properties":{"update_individual":{"type":"boolean"},"fields":{"type":"array","items":{"type":"object","properties":{"field_id":{"type":"integer"},"answer":{"type":"string","description":"This property is an object for a mailing_address type field"}}}}}},"answers":{"type":"array","items":{"type":"object","properties":{"question_id":{"type":"integer"},"answer":{"type":"string","description":"The answer will equal one of the following based on the question type:\n* SINGLE_LINE_TEXT, PARAGRAPH_TEXT: `string`\n* DATE: `ISO8601 date string`\n* NUMBER: `integer`\n* RADIO_BUTTONS, PULLDOWN_MENU: `integer` choice_id from the question choices\n* CHECKBOXES, PRIORITIZE: `[integer]` Array of choice_ids\n* SCALE: `[{ choice_id: integer, scale_id: integer }]` Array of choice_id, scale_id objects\n* FILE_UPLOAD: `integer` file id\n* PRODUCT: `[{ choice_id: integer, quantity: integer }]`\n* DONATION_AMOUNT: `{ choice_id: integer, amount: integer }`\n"}}}},"payment":{"type":"object","properties":{"method":{"type":"string","enum":["CREDIT_CARD","CASH","CHECK","OTHER"]},"total":{"type":"integer"},"discount":{"type":"object","properties":{"is_percentage":{"type":"boolean"},"value":{"type":"integer"},"amount":{"type":"integer"}}}}},"confirmation_code":{"type":"string"},"confirmation_code_on":{"type":"boolean"},"confirmation_text":{"type":"string"}}}]},"FormQuestionSerializer":{"title":"FormQuestionSerializer","type":"object","properties":{"id":{"type":"integer","description":"question id"},"type":{"type":"string","description":"question type","enum":["CHECKBOXES","DATE","DONATION_AMOUNT","FILE_UPLOAD","NUMBER","PAGE_BREAK","PARAGRAPH_TEXT","PRIORITIZE","PRODUCT","PULLDOWN_MENU","RADIO_BUTTONS","SCALE","SECTION_BREAK","SINGLE_LINE_TEXT"]},"form_id":{"type":"integer","description":"the id of the form the question belongs to"},"question":{"type":"string","description":"question header"},"explaination":{"type":"string"},"required":{"type":"boolean"},"admin_only":{"type":"boolean"},"single_choice":{"type":"boolean"},"min_value":{"type":"integer","description":"min_value will only exist for NUMBER question type"},"max_value":{"type":"integer","description":"max_value will only exist for NUMBER question type"},"choices":{"type":"array","description":"only for CHECKBOXES, DONATION_AMOUNT, PRIORITIZE, PRODUCT, PULLDOWN_MENU, RADIO_BUTTONS, SCALE","items":{"type":"object","properties":{"id":{"type":"integer","description":"choice id"},"value":{"type":"string"},"disabled":{"type":"boolean"},"disabled_reasons":{"type":"array","description":"array of messages explaining why question choice is disabled","items":{"type":"string"}},"coa_id":{"type":"integer","description":"only for DONATION_AMOUNT, PRODUCT"},"tax_deductible":{"type":"boolean","description":"only for DONATION_AMOUNT, PRODUCT"},"discountable":{"type":"boolean","description":"only for PRODUCT"},"price":{"type":"integer","description":"only for DONATION_AMOUNT, PRODUCT"},"total_available":{"type":"integer","description":"only for DONATION_AMOUNT, PRODUCT"},"quantity_sold":{"type":"integer","description":"only for DONATION_AMOUNT, PRODUCT"},"min_value":{"type":"integer","description":"only for DONATION_AMOUNT, PRODUCT"},"max_value":{"type":"integer","description":"only for DONATION_AMOUNT, PRODUCT"}}}},"range":{"type":"array","description":"only for SCALE","items":{"type":"object","properties":{"id":{"type":"integer","description":"range id"},"value":{"type":"string"}}}}}},"BasicFormManagerSerializer":{"type":"object","properties":{"form_id":{"type":"integer"},"manager_id":{"type":"integer"},"form":{"$ref":"#/components/schemas/BasicFormSerializer"},"manager":{"$ref":"#/components/schemas/BasicIndividualProfileSerializer"}}},"FormRespondentSerializer":{"type":"object","properties":{"id":{"type":"integer"},"actions":{"type":"object","properties":{"can_edit_profile":{"$ref":"#/components/schemas/Action"}}},"family_id":{"type":"integer"},"campus_id":{"type":"integer"},"name":{"type":"string","example":"Hunter Davis"},"first_name":{"type":"string","example":"Hunter"},"last_name":{"type":"string","example":"Davis"},"email":{"type":"string","example":"hunter.davis@testing.com"},"addresses":{"title":"Addresses","type":"object","properties":{"mailing":{"$ref":"#/components/schemas/AddressSerializer"}}},"phone":{"title":"Phone","type":"object","properties":{"mobile":{"type":"string"},"home":{"type":"string"},"work":{"type":"string"},"mobile_carrier_id":{"type":"string"}}},"marital_status":{"type":"string","description":"The marital status of the individual","enum":["MARRIED","SINGLE","WIDOWED","DIVORCED","SEPARATED"]},"gender":{"type":"string","description":"The gender of the individual","enum":["MALE","FEMALE"]}}},"FormAutomationSerializer":{"type":"object","properties":{"choice_id":{"type":"integer"},"condition_id":{"type":"integer"},"form_id":{"type":"integer"},"id":{"type":"integer"},"question_id":{"type":"integer"},"target_id":{"type":"integer"},"type_id":{"type":"integer"},"type_name":{"type":"string","enum":["group","event","queue","new pos."]}}},"BasicGroupSerializer":{"type":"object","properties":{"id":{"type":"integer"},"campus_id":{"type":"integer"},"name":{"type":"string","example":"Small Group"},"inactive":{"type":"boolean","example":false},"group_type":{"$ref":"#/components/schemas/IdName"},"interaction_type":{"$ref":"#/components/schemas/GroupInteractionType"},"membership_type":{"type":"string","enum":["OPEN_TO_ALL","REQUEST_REQUIRED"]},"main_leader":{"$ref":"#/components/schemas/MainLeaderSerializer"},"images":{"$ref":"#/components/schemas/Images"},"owner_id":{"type":"integer"},"coach_id":{"type":"integer"},"director_id":{"type":"integer"},"public_signup_form":{"$ref":"#/components/schemas/BasicFormSerializer"},"department":{"type":"object","properties":{"id":{"type":"integer"}}}}},"FullGroupSerializer":{"type":"object","properties":{"id":{"type":"integer"},"campus_id":{"type":"integer"},"name":{"type":"string","example":"Small Group"},"description":{"type":"string"},"inactive":{"type":"boolean","example":false},"group_type":{"$ref":"#/components/schemas/IdName"},"interaction_type":{"$ref":"#/components/schemas/GroupInteractionType"},"membership_type":{"type":"string","enum":["OPEN_TO_ALL","REQUEST_REQUIRED"]},"images":{"$ref":"#/components/schemas/Images"},"member_count":{"type":"integer","example":54},"childcare":{"type":"boolean","example":true},"listed":{"type":"boolean","example":true},"full":{"type":"boolean","example":false},"main_leader":{"$ref":"#/components/schemas/MainLeaderSerializer"},"meet_day":{"$ref":"#/components/schemas/IdName"},"meet_time":{"$ref":"#/components/schemas/IdName"},"area":{"$ref":"#/components/schemas/IdName"},"address":{"$ref":"#/components/schemas/AddressSerializer"},"allowed_attachment_extensions":{"type":"array","items":{"type":"string"},"example":["pdf","doc","docx","xls","xlsx","ppt","pptx","jpg","jpeg","png","gif","webp","psd","psb","mp4","mov","mp3","wav","m4a","aac","ogg","zip"]}}},"GroupMessageSerializer":{"type":"object","properties":{"id":{"type":"integer"},"subject":{"type":"string"},"body":{"type":"string"},"view_count":{"type":"integer"},"pinned":{"type":"boolean"},"locked":{"type":"boolean"},"leaders_only":{"type":"boolean"},"created":{"type":"string","format":"date-time"},"total_comments":{"type":"integer"},"actions":{"type":"object","properties":{"can_comment":{"$ref":"#/components/schemas/Action"},"can_edit":{"$ref":"#/components/schemas/Action"},"can_delete":{"$ref":"#/components/schemas/Action"}}},"creator":{"$ref":"#/components/schemas/BasicIndividualProfileSerializer"},"recent_comments":{"$ref":"#/components/schemas/GroupMessageCommentSerializer"},"files":{"$ref":"#/components/schemas/FileSerializer"}}},"GroupMessageCommentSerializer":{"type":"object","properties":{"id":{"type":"integer"},"message_id":{"type":"integer"},"body":{"type":"string"},"created":{"type":"string","format":"date-time"},"files":{"$ref":"#/components/schemas/FileSerializer"}}},"GroupTextMessageRequestSerializer":{"type":"object","properties":{"body":{"type":"string","description":"contents of text message"}}},"GroupMessageRequestSerializer":{"type":"object","properties":{"from":{"type":"array","items":{"type":"string"}},"send_to":{"type":"string","enum":["ALL_PARTICIPANTS","LEADERS_ONLY"]},"locked":{"type":"boolean","description":"default false"},"subject":{"type":"string","description":"title of message"},"body":{"type":"string","description":"contents of message"},"pinned":{"type":"boolean","description":"default false"}}},"BasicIndividualGroupsProfileSerializer":{"type":"object","properties":{"group_id":{"type":"integer"},"individual_id":{"type":"integer"},"status":{"$ref":"#/components/schemas/IndividualGroupStatus"},"date_added":{"type":"string","format":"date-time"},"receive_sms":{"type":"boolean"},"individual":{"$ref":"#/components/schemas/BasicIndividualProfileSerializer"}}},"RemoveBasicIndividualGroupsProfileSerializer":{"type":"object","properties":{"group_id":{"type":"integer"},"individual_id":{"type":"integer"},"status":{"type":"string","enum":["REMOVED"]}}},"BasicIndividualGroupsProfileWithGroupSerializer":{"allOf":[{"$ref":"#/components/schemas/BasicIndividualGroupsProfileSerializer"},{"title":"BasicIndividualGroupsProfileWithGroupSerializer","type":"object","properties":{"group":{"allOf":[{"$ref":"#/components/schemas/BasicGroupSerializer"},{"type":"object","properties":{"leaders":{"type":"array","description":"Owner / coach / director references for this\ngroup, deduped (same individual playing multiple\nroles appears once) and filtered to populated\nids. Stale / deleted ids are silently dropped\nfrom the roster rather than producing a\nplaceholder. Only present when the request\nincluded `with_leaders=true`.\n","items":{"$ref":"#/components/schemas/IndividualReferenceSerializer"}}}}]},"actions":{"type":"object","properties":{"can_edit_individual_group_communication_settings":{"$ref":"#/components/schemas/Action"},"can_join_group":{"$ref":"#/components/schemas/Action"},"can_leave_group":{"$ref":"#/components/schemas/Action"}}}}}]},"IndividualGroupsHistorySerializer":{"type":"object","properties":{"group_id":{"type":"integer"},"group_name":{"type":"string"},"status":{"$ref":"#/components/schemas/IndividualGroupStatus"},"type":{"type":"string","enum":["START","END"]},"created":{"type":"string","format":"date-time"}}},"GroupAttendanceGroupingsSerializer":{"type":"object","properties":{"id":{"type":"integer","example":123},"group_id":{"type":"integer","example":1},"name":{"type":"string"}}},"IndividualGroupStatus":{"type":"string","enum":["INVITED","REQUESTING","MEMBER","LEADER","MAIN_LEADER","COACH","DIRECTOR"]},"GroupInteractionType":{"type":"string","enum":["MEMBERS_INTERACT","ANNOUNCE_ONLY","ADMINISTRATIVE"]},"UpdateGroupMessageRequest":{"type":"object","properties":{"subject":{"type":"string"},"body":{"type":"string"},"locked":{"type":"boolean"},"pinned":{"type":"boolean"}}},"CreateGroupMessageCommentRequest":{"type":"object","properties":{"subject":{"type":"string"},"body":{"type":"string"}}},"UpdateGroupMessageCommentRequest":{"type":"object","properties":{"body":{"type":"string"}}},"GroupSpecialDaysSerializer":{"type":"object","properties":{"type":{"type":"string","enum":["birthday","anniversary"]},"date":{"type":"string","format":"date"},"individuals":{"type":"array","items":{"$ref":"#/components/schemas/BasicIndividualProfileSerializer"}}}},"MainLeaderSerializer":{"type":"object","properties":{"id":{"type":"integer","example":1},"first_name":{"type":"string","example":"Ted"},"last_name":{"type":"string","example":"Lasso"},"name":{"type":"string","example":"Ted Lasso"},"email":{"type":"string","example":"example@pushpay.com"},"actions":{"type":"object","properties":{"can_view_profile":{"$ref":"#/components/schemas/Action"}}}}},"IndividualReferenceSerializer":{"type":"object","description":"Minimal reference shape produced by\n`IndividualReferenceService::getReferenceInformation` /\n`getReferencesInformation`. Used by the embedded `leaders`\narray on `/individuals/{id}/groups?with_leaders=true`.\n","properties":{"id":{"type":"integer","example":1},"name":{"type":"string","example":"Ted Lasso"},"first_name":{"type":"string","example":"Ted"},"last_name":{"type":"string","example":"Lasso"},"images":{"$ref":"#/components/schemas/Images"},"email":{"type":"string","nullable":true,"example":"example@pushpay.com"}}},"UpdateIndividualGroupsOutputSerializer":{"type":"array","items":{"type":"object","properties":{"group_id":{"type":"integer","example":42},"result":{"type":"string","enum":["REMOVED","ERROR"]},"errors":{"type":"array","items":{"type":"string","example":"NOT_A_MEMBER"},"description":"This array is always present, but has values only when `result` is `ERROR`","example":[]}}}},"IndividualHistorySerializer":{"type":"object","properties":{"id":{"type":"integer"},"modifier_id":{"type":"integer"},"modifier":{"$ref":"#/components/schemas/MinimalIndividualProfileSerializer"},"source":{"type":"object","properties":{"type":{"type":"string","enum":["WEB","APIv1","APIv2"]},"name":{"type":"string","description":"The api user name if APIv1, or the application name if APIv2"}}},"changeset":{"type":"array","items":{"$ref":"#/components/schemas/BasicIndividualsChangeSetSerializer"}},"modified":{"type":"string","format":"date-time"}}},"BasicIndividualsChangeSetSerializer":{"type":"object","properties":{"category":{"type":"string","enum":["ADMIN","CONTACT","CUSTOM","FAMILY","MEMBERSHIP","NAME","PERSONAL","SYSTEM"]},"field":{"type":"string"},"previous":{"type":"string"},"updated":{"type":"string"}}},"IndividualMessageRequestSerializer":{"type":"object","properties":{"subject":{"type":"string"},"body":{"type":"string"}}},"IndividualMessageReplyRequestSerializer":{"type":"object","properties":{"body":{"type":"string"}}},"IndividualMessageSerializer":{"type":"object","properties":{"id":{"type":"integer"},"subject":{"type":"string"},"body":{"type":"string"},"created":{"type":"string","format":"date-time"},"sender":{"$ref":"#/components/schemas/BasicIndividualProfileSerializer"},"recipient":{"$ref":"#/components/schemas/BasicIndividualProfileSerializer"}}},"IndividualMessageWithRecentRepliesSerializer":{"allOf":[{"$ref":"#/components/schemas/IndividualMessageSerializer"},{"title":"IndividualMessageWithRecentRepliesSerializer","type":"object","properties":{"reply_count":{"type":"integer"},"recent_replies":{"$ref":"#/components/schemas/IndividualMessageReplySerializer"}}}]},"IndividualMessageReplySerializer":{"type":"object","properties":{"id":{"type":"integer"},"body":{"type":"string"},"created":{"type":"string","format":"date-time"},"message":{"$ref":"#/components/schemas/IndividualMessageSerializer"},"creator":{"$ref":"#/components/schemas/BasicIndividualProfileSerializer"}}},"BasicIndividualMetricSerializer":{"type":"object","properties":{"id":{"type":"integer"},"count":{"type":"integer"},"start":{"type":"string","format":"date"}}},"BasicIndividualMetricSummarySerializer":{"type":"object","properties":{"first":{"type":"string","format":"date"},"latest":{"type":"string","format":"date"}}},"FamilyGivingMetricSerializer":{"type":"object","properties":{"family_id":{"type":"integer"},"date":{"type":"string","format":"date"},"count":{"type":"integer","description":"family total gifts"},"members":{"type":"array","items":{"$ref":"#/components/schemas/BasicIndividualMetricSerializer"}}}},"GroupMetricSerializer":{"type":"object","properties":{"member":{"type":"integer","description":"Count of the groups where the individual is a member.  Does not include other membership types."},"leader":{"type":"integer","description":"Count of the groups where the individual is a leader"},"coach":{"type":"integer","description":"Count of the groups where the individual is a coach"},"director":{"type":"integer","description":"Count of the groups where the individual is a director"},"invited":{"type":"integer","description":"Count of the groups that the individual has been invited"},"requesting":{"type":"integer","description":"Count of the groups where the individual has requested to join"}}},"GroupsHistoryMetricSerializer":{"type":"object","properties":{"member":{"type":"integer","description":"Count of the groups where the individual is a member.  Does not include other membership types.","example":7},"leader":{"type":"integer","description":"Count of the groups where the individual is a leader","example":3},"date":{"type":"string","description":"ISO 8601 year-month date","format":"date"}}},"ProcessQueueMetricSerializer":{"type":"object","properties":{"overdue":{"type":"integer"},"not_started":{"type":"integer"},"waiting":{"type":"integer"},"in_process":{"type":"integer"},"done":{"type":"integer"}}},"MergedIndividualOutputType":{"type":"object","properties":{"loserId":{"type":"integer"},"winnerId":{"type":"integer"},"creatorId":{"type":"integer"},"modifierId":{"type":"integer"},"dateCreated":{"type":"string","format":"date-time"},"dateModified":{"type":"string","format":"date-time"}}},"IndividualPrivacySettingsSerializer":{"type":"object","properties":{"listed":{"type":"boolean"},"address_privacy_level":{"type":"string","enum":["LEADERSHIP_ONLY","GROUP_MEMBERS","EVERYONE"]},"anniversary_privacy_level":{"type":"string","enum":["LEADERSHIP_ONLY","GROUP_MEMBERS","EVERYONE"]},"birthday_privacy_level":{"type":"string","enum":["LEADERSHIP_ONLY","GROUP_MEMBERS","EVERYONE"]},"email_privacy_level":{"type":"string","enum":["LEADERSHIP_ONLY","GROUP_MEMBERS","EVERYONE"]},"phone_privacy_level":{"type":"string","enum":["LEADERSHIP_ONLY","GROUP_MEMBERS","EVERYONE"]}}},"MinimalIndividualProfileSerializer":{"type":"object","properties":{"id":{"type":"integer"},"first_name":{"type":"string"},"last_name":{"type":"string"},"name":{"type":"string"}}},"BasicFamilyProfileSerializer":{"type":"object","properties":{"id":{"type":"integer"},"last_name":{"type":"string"},"message":{"type":"string","description":"Only present when checkin_message exists for the family"},"address":{"$ref":"#/components/schemas/AddressSerializer"},"actions":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/Action"}},"messages":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"message":{"type":"string"}}}},"images":{"$ref":"#/components/schemas/Images"}}},"FamilyProfileSerializer":{"allOf":[{"$ref":"#/components/schemas/BasicFamilyProfileSerializer"},{"type":"object","properties":{"members":{"type":"array","items":{"$ref":"#/components/schemas/IndividualDetailsSerializer"}},"authorized_individuals":{"type":"array","description":"Individuals authorized for pickup or check-in on behalf of this family","items":{"$ref":"#/components/schemas/BasicIndividualProfileSerializer"}}}}]},"BasicIndividualProfileSerializer":{"type":"object","properties":{"id":{"type":"integer"},"family_id":{"type":"integer"},"campus_id":{"type":"integer"},"birthday":{"type":"string","format":"date","example":"2011-10-27T00:00:00.000Z"},"name":{"type":"string","example":"Hunter Davis"},"name_prefix":{"type":"string","example":"Dr."},"first_name":{"type":"string","example":"Hunter"},"middle_name":{"type":"string"},"last_name":{"type":"string","example":"Davis"},"name_suffix":{"type":"string","example":"Sr."},"legal_first_name":{"type":"string"},"email":{"type":"string","example":"hunter.davis@testing.com"},"email_unsubscribed":{"type":"boolean"},"email_unsubscribed_reason":{"type":"string","description":"The reason a person was unsubscribed","enum":["API_UNSUBSCRIBED","DOMAIN_UNSUBSCRIBED","SITE_UNSUBSCRIBED"]},"images":{"$ref":"#/components/schemas/Images"},"created":{"type":"string","format":"date"},"family_position":{"type":"string","description":"The position of the individual in the family","enum":["PRIMARY_CONTACT","SPOUSE","CHILD","OTHER"]},"marital_status":{"type":"string","description":"The marital status of the individual","enum":["MARRIED","SINGLE","WIDOWED","DIVORCED","SEPARATED"]},"gender":{"type":"string","description":"The gender of the individual","enum":["MALE","FEMALE"]},"addresses":{"title":"Addresses","type":"object","properties":{"mailing":{"$ref":"#/components/schemas/AddressSerializer"},"home":{"$ref":"#/components/schemas/AddressSerializer"},"work":{"$ref":"#/components/schemas/AddressSerializer"}}},"phone":{"title":"Phone","type":"object","properties":{"mobile":{"type":"string"},"home":{"type":"string"},"work":{"type":"string"},"fax":{"type":"string"},"pager":{"type":"string"},"mobile_carrier_id":{"type":"string"}}},"preferred_number":{"$ref":"#/components/schemas/PreferredNumberTypes"},"active":{"type":"boolean"},"deceased":{"type":"string","format":"date"},"membership_type_id":{"type":"integer"},"date_child_work_start":{"type":"string","format":"date"},"date_child_work_stop":{"type":"string","format":"date"},"is_child_work_approved":{"type":"boolean"},"approval_status_modifier_id":{"type":"string"},"denied_status_reason":{"type":"string"}}},"DuplicateIndividualProfileSerializer":{"allOf":[{"$ref":"#/components/schemas/BasicIndividualProfileSerializer"},{"type":"object","properties":{"spouse":{"$ref":"#/components/schemas/BasicIndividualProfileSerializer"},"campus":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"}}},"match_score":{"type":"integer"},"matches":{"type":"object","properties":{"source":{"type":"array","description":"The fields that match the user being compared to","items":{"type":"string"}},"match":{"type":"array","description":"The fields that match this user","items":{"type":"string"}}},"description":"matches to an individual have source and match keys, matches to params just have the matches"}}}]},"BackgroundCheckSerializer":{"type":"object","properties":{"id":{"type":"integer","description":"Internal ID for the background check","example":1},"status":{"type":"string","enum":["ACTIVE","EXPIRED","PENDING"]},"expired":{"type":"boolean"},"individual_id":{"type":"integer","description":"ID for the person who is the subject of the background check","example":1},"vendor_id":{"type":"integer","example":1},"package_name":{"type":"string","description":"Public display name for background check","example":"Commercial Driver"},"package_slug":{"type":"string","description":"Internal key for background check package","example":"commercial_driver"},"status_date_modified":{"type":"string","description":"Day of last","format":"date-time"},"expiration_date":{"type":"string","format":"date-time"}}},"IndividualDetailsSerializer":{"allOf":[{"$ref":"#/components/schemas/BasicIndividualProfileSerializer"},{"$ref":"#/components/schemas/ModifiedMetadata"},{"type":"object","properties":{"actions":{"type":"object","properties":{"can_add_individual_to_positions":{"$ref":"#/components/schemas/Action"},"can_add_individual_to_process_queues":{"$ref":"#/components/schemas/Action"},"can_change_limited_access_user":{"$ref":"#/components/schemas/Action"},"can_create_form_response":{"$ref":"#/components/schemas/Action"},"can_create_general_notes":{"$ref":"#/components/schemas/Action"},"can_create_gift":{"$ref":"#/components/schemas/Action"},"can_create_individual_message":{"$ref":"#/components/schemas/Action"},"can_create_pledge":{"$ref":"#/components/schemas/Action"},"can_create_transaction":{"$ref":"#/components/schemas/Action"},"can_deny_pending_profiles":{"$ref":"#/components/schemas/Action"},"can_edit_communication_preferences":{"$ref":"#/components/schemas/Action"},"can_edit_deceased":{"$ref":"#/components/schemas/Action"},"can_edit_full_profile":{"$ref":"#/components/schemas/Action"},"can_edit_inactive":{"$ref":"#/components/schemas/Action"},"can_edit_individual_file":{"$ref":"#/components/schemas/Action"},"can_edit_login":{"$ref":"#/components/schemas/Action"},"can_edit_pending_profiles":{"$ref":"#/components/schemas/Action"},"can_edit_privacy_settings":{"$ref":"#/components/schemas/Action"},"can_edit_profile":{"$ref":"#/components/schemas/Action"},"can_edit_profile_admin":{"$ref":"#/components/schemas/Action"},"can_manage_individual_serving":{"$ref":"#/components/schemas/Action"},"can_mass_join_groups":{"$ref":"#/components/schemas/Action"},"can_mass_leave_groups":{"$ref":"#/components/schemas/Action"},"can_merge_as_loser":{"$ref":"#/components/schemas/Action"},"can_merge_as_winner":{"$ref":"#/components/schemas/Action"},"can_move_individual_transactions":{"$ref":"#/components/schemas/Action"},"can_order_background_check":{"$ref":"#/components/schemas/Action"},"can_read_individual_sacrament":{"$ref":"#/components/schemas/Action"},"can_save_individual_sacrament":{"$ref":"#/components/schemas/Action"},"can_view_background_checks":{"$ref":"#/components/schemas/Action"},"can_view_contact_card":{"$ref":"#/components/schemas/Action"},"can_view_individual":{"$ref":"#/components/schemas/Action"},"can_view_individual_attendance":{"$ref":"#/components/schemas/Action"},"can_view_individual_files":{"$ref":"#/components/schemas/Action"},"can_view_individual_forms":{"$ref":"#/components/schemas/Action"},"can_view_individual_gifts":{"$ref":"#/components/schemas/Action"},"can_view_individual_giving_statement":{"$ref":"#/components/schemas/Action"},"can_view_individual_groups":{"$ref":"#/components/schemas/Action"},"can_view_individual_history":{"$ref":"#/components/schemas/Action"},"can_view_individual_involvement":{"$ref":"#/components/schemas/Action"},"can_view_individual_messages":{"$ref":"#/components/schemas/Action"},"can_view_individual_needs":{"$ref":"#/components/schemas/Action"},"can_view_individual_notes":{"$ref":"#/components/schemas/Action"},"can_view_individual_pledge_statement":{"$ref":"#/components/schemas/Action"},"can_view_individual_pledges":{"$ref":"#/components/schemas/Action"},"can_view_individual_processes":{"$ref":"#/components/schemas/Action"},"can_view_individual_scheduled_gifts":{"$ref":"#/components/schemas/Action"},"can_view_individual_serving":{"$ref":"#/components/schemas/Action"},"can_view_individuals_my_fit":{"$ref":"#/components/schemas/Action"},"can_view_profile_admin":{"$ref":"#/components/schemas/Action"},"can_view_scheduling_entities_organized":{"$ref":"#/components/schemas/Action"}}},"allergies":{"type":"string","description":"The allergies of the individual"},"confirmed_no_allergies":{"type":"string","description":"Does this individual have allergies?","enum":["NOT_SPECIFIED"]},"barcode":{"type":"string","description":"Individual's barcode for quick access"},"school_id":{"type":"integer"},"school_grade_id":{"type":"integer"},"alternate_name":{"type":"string"},"legal_first_name":{"type":"string"},"middle_name":{"type":"string"},"maiden_name":{"type":"string"},"name_prefix":{"type":"string"},"name_suffix":{"type":"string"},"listed":{"type":"boolean"},"limited_access_user":{"type":"boolean"},"cid":{"type":"string"},"membership_start_date":{"type":"string","format":"date"},"baptized":{"type":"boolean","description":"If you are using the Sacraments feature, then the Sacraments API would be more effective and up-to-date alternative for surfacing baptism data"},"baptized_date":{"type":"string","description":"If you are using the Sacraments feature, then the Sacraments API would be more effective and up-to-date alternative for surfacing baptism data","format":"date"},"commitment_date":{"type":"string","format":"date"},"commitment_story":{"type":"string"},"current_story":{"type":"string"},"reason_left":{"type":"string"},"reason_left_id":{"type":"integer"},"preferred_service":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"}}},"style":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"}}},"last_login":{"type":"string","format":"date"},"campus_name":{"type":"string"},"membership_type_name":{"type":"string"},"school_grade":{"type":"string"},"age":{"type":"string"},"baptized_note":{"type":"string","description":"If you are using the Sacraments feature, then the Sacraments API would be more effective and up-to-date alternative for surfacing baptism data"},"emergency_contact_name":{"type":"string"},"giving_number":{"type":"string","example":"987"},"envelope_user_id":{"type":"integer","description":"Use the [`/church/envelope_user_options`](#/church/readEnvelopeUserOptions) API to get the envelope user options in order to look up the value by id.","example":1},"religion_id":{"type":"integer","description":"Use the [`/church/religions`](#/church/readReligions) API to get the religion options in order to look up the value by id.","example":2},"preferred_language_id":{"type":"string","description":"Use the [`/church/preferred_languages`](#/church/readPreferredLanguages) API to get the preferred language options in order to look up the value by id.","example":"1"},"ethnicity_id":{"type":"string","description":"Use the [`/church/ethnicities`](#/church/readEthnicities) API to get the ethnicity options in order to look up the value by id.","example":8},"external_safe_environment_id":{"type":"string","example":"1234"},"external_diocesan_id":{"type":"string","example":"5678"},"external_fundraising_id":{"type":"string","example":"1223"},"homebound_ministry_id":{"type":"integer","description":"Use the [`/church/homebound_ministries`](#/church/readHomeboundMinistryOptions) API to get the homebound ministry options in order to look up the value by id.","example":1},"family_household_mailing_name":{"type":"string","description":"Family/Household Mailing Name","example":"Smith"},"military":{"type":"string"},"work_title":{"type":"string"},"protected_fields":{"type":"array","items":{"type":"string"}},"date_anyone_run_giving_statement":{"type":"string","format":"date"},"date_family_run_giving_statement":{"type":"string","format":"date"},"last_attended_date":{"type":"string","format":"date"},"last_giving_date":{"type":"string","format":"date"},"membership_date":{"type":"string","format":"date"},"membership_date_stop":{"type":"string","format":"date"},"creator":{"$ref":"#/components/schemas/BasicIndividualProfileSerializer"}}}]},"IndividualDetailsWithCustomFieldsSerializer":{"allOf":[{"$ref":"#/components/schemas/IndividualDetailsSerializer"},{"type":"object","properties":{"custom_fields":{"type":"array","items":{"$ref":"#/components/schemas/BasicIndividualsCustomFieldsSerializer"}}}}]},"IndividualContactInfoRequestSerializer":{"type":"object","properties":{"first_name":{"type":"string","example":"Hunter"},"last_name":{"type":"string","example":"Davis"},"email":{"type":"string","example":"hunter.davis@testing.com"},"phone":{"title":"Phone","type":"object","properties":{"mobile":{"type":"string"},"mobile_carrier_id":{"type":"string"}}}}},"IndividualDetailsRequestSerializer":{"type":"object","properties":{"birthday":{"type":"string","format":"date"},"campus_id":{"type":"integer"},"church_service":{"type":"array","items":{"type":"integer"}},"first_name":{"type":"string","example":"Hunter"},"last_name":{"type":"string","example":"Davis"},"middle_name":{"type":"string","example":"Lee"},"prefix":{"type":"string","example":"Dr"},"suffix":{"type":"string","example":"Jr"},"email":{"type":"string","example":"hunter.davis@testing.com"},"email_unsubscribed":{"type":"boolean"},"email_unsubscribed_reason":{"type":"string","description":"The reason a person was unsubscribed","enum":["BLOCKED","BOUNCED","DISENGAGED","DOMAIN_UNSUBSCRIBED","SITE_UNSUBSCRIBED"]},"family_id":{"type":"integer"},"family_position":{"type":"string","description":"The position of the individual in the family","enum":["PRIMARY_CONTACT","SPOUSE","CHILD","OTHER"]},"marital_status":{"type":"string","description":"The marital status of the individual","enum":["MARRIED","SINGLE","WIDOWED","DIVORCED","SEPARATED"]},"gender":{"type":"string","description":"The gender of the individual","enum":["MALE","FEMALE"]},"allergies":{"type":"string","description":"The allergies of the individual"},"confirmed_no_allergies":{"type":"string","description":"Does this individual have allergies?","enum":["NOT_SPECIFIED"]},"barcode":{"type":"string","description":"Individual's barcode for quick access"},"school_id":{"type":"integer"},"school_grade_id":{"type":"integer"},"legal_first_name":{"type":"string"},"listed":{"type":"boolean"},"active":{"type":"boolean"},"limited_access_user":{"type":"boolean"},"deceased":{"type":"string","format":"date"},"reason_left_id":{"type":"integer"},"membership_type_id":{"type":"integer"},"membership_start_date":{"type":"string","format":"date"},"baptized":{"type":"boolean","description":"If you are using the Sacraments feature, then the Sacraments API would be more effective and up-to-date alternative for surfacing baptism data"},"baptized_date":{"type":"string","description":"If you are using the Sacraments feature, then the Sacraments API would be more effective and up-to-date alternative for surfacing baptism data","format":"date"},"cid":{"type":"string"},"addresses":{"title":"Addresses","type":"object","properties":{"mailing":{"$ref":"#/components/schemas/AddressSerializer"},"home":{"$ref":"#/components/schemas/AddressSerializer"},"work":{"$ref":"#/components/schemas/AddressSerializer"}}},"phone":{"title":"Phone","type":"object","properties":{"mobile":{"type":"string"},"home":{"type":"string"},"work":{"type":"string"},"fax":{"type":"string"},"pager":{"type":"string"},"mobile_carrier_id":{"type":"string"}}},"preferred_number":{"$ref":"#/components/schemas/PreferredNumberTypes"},"custom_fields":{"type":"array","items":{"$ref":"#/components/schemas/BasicIndividualsCustomFieldsSerializer"}}}},"TimelineTypes":{"type":"string","enum":["LEFT_GROUP","JOINED_GROUP","FIRST_SERVED_IN_POSITION","INDIVIDUAL_CREATED","INDIVIDUAL_BAPTIZED","FIRST_GIFT","COMMITMENT","BECAME_GROUP_MEMBER","BECAME_GROUP_LEADER","BECAME_GROUP_COACH","BECAME_GROUP_DIRECTOR","FILLED_OUT_FORM","BECAME_FORM_MANAGER","IN_PROCESS_QUEUE","BECAME_PROCESS_MANAGER","BECAME_QUEUE_MANAGER"]},"TimelineCategories":{"type":"string","enum":["FORMS","GROUPS","GIVING","ATTENDANCE","SERVING","PROCESSES","INDIVIDUAL"]},"TimelineContext":{"type":"object","properties":{"type":{"type":"string","enum":["FORM","FORM_RESPONSE","GROUP","INDIVIDUAL","POSITION","PROCESSES"]},"id":{"type":"number"}},"description":"Context information for non-transaction timeline entries"},"TransactionTimelineContext":{"type":"object","properties":{"type":{"type":"string","enum":["TRANSACTION"]},"id":{"type":"number"},"is_refund":{"type":"boolean","default":false,"description":"Indicates whether this transaction is a refund."},"has_refunds":{"type":"boolean","default":false,"description":"Indicates whether this transaction has been refunded."},"refunds_total":{"type":"integer","description":"Total refunded amount in cents, returned as a negative value (e.g., -3000 represents $30.00 refunded). Only present when has_refunds is true."},"unrefunded_amount":{"type":"integer","description":"Remaining unrefunded amount in cents. Zero indicates a fully refunded transaction. Only present when has_refunds is true."},"notes":{"type":"string","description":"Notes associated with the transaction, when available."}},"description":"Context information for transaction/giving timeline entries"},"TimelineGroupingTypes":{"type":"string","enum":["FORM","FORM_RESPONSE","GROUP","INDIVIDUAL","POSITION","TRANSACTION","PROCESSES"]},"BasicIndividualsCustomFieldsSerializer":{"type":"object","properties":{"id":{"type":"string"},"value":{"type":"string"}},"description":"The id field will be of the form \"TYPE_ID\" where TYPE is one of the following and determines the accepted format for the value property:\n\n  | id                                  | value               |\n  |-------------------------------------|---------------------|\n  | text:individual/{id:0-9+}           | string              |\n  | date:individual/{id:0-9+}           | ISO8601 date string |\n  | option:individual/{id:0-9+}         | integer             |\n"},"PreferredNumberTypes":{"type":"string","enum":["HOME","MOBILE","WORK","NONE"]},"IndividualTimelineSerializer":{"type":"object","properties":{"category":{"$ref":"#/components/schemas/TimelineCategories"},"type":{"$ref":"#/components/schemas/TimelineTypes"},"date":{"type":"string","format":"date"},"name":{"type":"string","description":"The name of the activity's context object"},"description":{"type":"string","description":"Additional information about the activity"},"image":{"type":"string","description":"The image URL for the activity, where applicable. E.G. group image."},"subtext":{"type":"string","description":"Further information about the activity, such as paid amount for forms, etc."},"campus_id":{"type":"integer","description":"The ID of the campus where the timeline event took place"},"context":{"oneOf":[{"$ref":"#/components/schemas/TimelineContext"},{"$ref":"#/components/schemas/TransactionTimelineContext"}],"description":"Information about the context of the timeline entry. Transaction/giving entries include additional refund properties."},"grouping":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/TimelineGroupingTypes"},"id":{"type":"number"}},"description":"Information about how the contexts are grouped"},"has_peers":{"type":"boolean","description":"If true, this context and id can be used to get peer records from the contextual timeline endpoint"}}},"IndividualsSocialNetworkSerializer":{"type":"object","properties":{"type":{"type":"string"},"url":{"type":"string"},"value":{"type":"string"}}},"IndividualsSocialNetworkRequest":{"type":"object","properties":{"type":{"type":"string"},"value":{"type":"string"}}},"CreateFamilyRequest":{"type":"object","properties":{"individual_id":{"type":"integer","description":"When provided, will create a new family with this individual as the primary contact (all other fields ignored)"},"last_name":{"type":"string"},"campus_id":{"type":"integer"},"address":{"type":"object","properties":{"street":{"type":"string"},"city":{"type":"string"},"state":{"type":"string"},"zip":{"type":"string"},"country_iso":{"type":"string"}}},"message":{"type":"string","description":"valid only when can_edit_checkin_message is TRUE"},"phone":{"type":"string"},"members":{"type":"array","items":{"$ref":"#/components/schemas/IndividualDetailsRequestSerializer"}}}},"UpdateFamilyRequest":{"type":"object","properties":{"last_name":{"type":"string"},"campus_id":{"type":"integer"},"address":{"type":"object","properties":{"street":{"type":"string"},"city":{"type":"string"},"state":{"type":"string"},"zip":{"type":"string"},"country_iso":{"type":"string"}}},"membership_type_id":{"type":"integer"},"membership_start_date":{"type":"string","format":"date"},"message":{"type":"string","description":"valid only when can_edit_checkin_message is TRUE"},"phone":{"type":"string"},"active":{"type":"boolean"},"deceased":{"type":"string","format":"date"},"reason_left_id":{"type":"integer"}}},"MergeMultipleIndividualsRequestSerializer":{"type":"object","properties":{"loser_ids":{"type":"array","items":{"type":"integer"}},"profile_overrides":{"$ref":"#/components/schemas/IndividualDetailsRequestSerializer"}}},"CheckrOrganizationSerializer":{"type":"object","properties":{"expiration_policy":{"type":"integer"},"integrations":{"type":"array","items":{"type":"string"}}}},"BasicNeedSerializer":{"type":"object","properties":{"id":{"type":"integer"},"group_id":{"type":"integer"},"coordinator_id":{"type":"integer"},"name":{"type":"string"},"external_listed":{"type":"boolean"},"listed":{"type":"boolean"},"items_count":{"type":"integer"},"items_taken":{"type":"integer"},"group":{"$ref":"#/components/schemas/BasicGroupSerializer"},"coordinator":{"$ref":"#/components/schemas/BasicIndividualProfileSerializer"}}},"BasicNeedDetailsSerializer":{"type":"object","properties":{"id":{"type":"integer"},"group_id":{"type":"integer"},"name":{"type":"string"},"description":{"type":"string"},"coordinator":{"$ref":"#/components/schemas/BasicIndividualProfileSerializer"},"address":{"$ref":"#/components/schemas/AddressSerializer"},"total_items":{"type":"integer"},"items_taken":{"type":"integer"},"end_Date":{"type":"string","format":"date-time"}}},"NeedDetailsSerializer":{"allOf":[{"$ref":"#/components/schemas/BasicNeedDetailsSerializer"},{"title":"NeedDetailsSerializer","type":"object"},{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/NeedItemDetailsSerializer"}}}}]},"NeedItemDetailsSerializer":{"type":"object","properties":{"id":{"type":"integer"},"need_id":{"type":"integer"},"name":{"type":"string"},"date":{"type":"string","format":"date-time"},"order_by":{"type":"integer"},"assignee":{"$ref":"#/components/schemas/BasicIndividualProfileSerializer"}}},"UpdateNeedRequestProperties":{"type":"object","properties":{"group_id":{"type":"integer"},"name":{"type":"string"},"description":{"type":"string"},"coordinator_id":{"type":"integer"},"address":{"type":"object","properties":{"name":{"type":"string"},"street":{"type":"string"},"city":{"type":"string"},"state":{"type":"string"},"zip":{"type":"string"},"country_iso":{"type":"string"}}},"ordered_item_ids":{"type":"array","items":{"type":"integer"}}}},"BasicNoteSerializer":{"type":"object","properties":{"id":{"type":"integer"},"individual_id":{"type":"integer"},"note":{"type":"string"},"sharing_level":{"type":"string","enum":["PRIVATE","CONTEXT_LEADERS","HIDDEN_CONTEXT_LEADERS","ALL_LEADERS"]},"context":{"type":"string","enum":["GROUP","DEPARTMENT","PROCESS_QUEUE","GENERAL"]},"context_id":{"type":"integer"},"context_object":{"type":"object","properties":{"type":{"type":"string","enum":["GROUP","DEPARTMENT","PROCESS_QUEUE","GENERAL"]},"group":{"$ref":"#/components/schemas/BasicGroupSerializer"},"department":{"$ref":"#/components/schemas/BasicDepartmentSerializer"},"individual_queue":{"$ref":"#/components/schemas/BasicQueueSerializer"}},"description":"The type property will be present, and the other keys will be present depending on the value of the type"},"creator":{"$ref":"#/components/schemas/BasicIndividualProfileSerializer"},"date":{"type":"string","format":"date"},"hidden_process":{"type":"boolean"},"can_delete_note":{"$ref":"#/components/schemas/Action"},"can_edit_note":{"$ref":"#/components/schemas/Action"}}},"BasicNoteWithIndividualSerializer":{"allOf":[{"$ref":"#/components/schemas/BasicNoteSerializer"},{"type":"object","properties":{"individual":{"$ref":"#/components/schemas/BasicIndividualProfileSerializer"}}}]},"NoteDetailsSerializer":{"$ref":"#/components/schemas/BasicNoteWithIndividualSerializer"},"CreateQueueIndividualRequest":{"required":["individual_id"],"type":"object","properties":{"individual_id":{"type":"integer"},"assignee_id":{"type":"integer"},"status":{"type":"string","enum":["NOT_STARTED","WAITING","IN_PROCESS"]},"note":{"type":"string"}}},"UpdateQueueIndividualRequest":{"type":"object","properties":{"assignee_id":{"type":"integer"},"status":{"type":"string","enum":["NOT_STARTED","WAITING","IN_PROCESS"]},"due":{"type":"string","format":"date"}}},"CompleteQueueIndividualRequest":{"type":"object","properties":{"completed":{"type":"string","format":"date"},"automations":{"type":"array","items":{"$ref":"#/components/schemas/ProcessQueueAutomationRequestTypes"}}}},"BasicQueueSerializer":{"type":"object","properties":{"id":{"type":"integer"},"process_id":{"type":"integer"},"process_campus_id":{"type":"integer"},"children":{"type":"boolean"},"name":{"type":"string"},"order_by":{"type":"integer"},"description":{"type":"string"},"note":{"type":"string"},"process":{"$ref":"#/components/schemas/BasicProcessSerializer"},"automations":{"$ref":"#/components/schemas/ProcessQueueAutomationDetail"},"assigned_count":{"type":"integer"},"unassigned_count":{"type":"integer"},"process_name":{"type":"string"},"queue_managers":{"type":"array","items":{"$ref":"#/components/schemas/ProcessQueueManagerDetail"}},"managers":{"type":"array","items":{"$ref":"#/components/schemas/BasicIndividualProfileSerializer"}},"integrations":{"type":"array","items":{"type":"object","properties":{"entity":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"}}}}}}}},"ProcessQueueAutomationRequestTypes":{"required":["type"],"type":"object","properties":{"next_queue_id":{"type":"integer"},"assignee_id":{"type":"string"},"type":{"$ref":"#/components/schemas/ProcessQueueAutomationTypes"}}},"BasicProcessSerializer":{"type":"object","properties":{"id":{"type":"integer"},"campus_id":{"type":"integer"},"owner_id":{"type":"integer"},"name":{"type":"string"},"hidden":{"type":"boolean"},"archived":{"type":"boolean"},"managers":{"type":"array","items":{"type":"string"}},"process_managers":{"type":"array","items":{"$ref":"#/components/schemas/ProcessManagerDetail"}},"status":{"type":"array","items":{"$ref":"#/components/schemas/ProcessStatusType"}}}},"ProcessQueueAutomationDetail":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"},"parent_name":{"type":"string"},"type":{"$ref":"#/components/schemas/ProcessQueueAutomationTypes"},"default":{"$ref":"#/components/schemas/ProcessQueueAutomationDefaults"}}},"ProcessQueueAutomationTypes":{"type":"string","enum":["GROUP","POSITION","EVENT","MEMBERSHIP","BAPTIZED","MAIL_MERGE","NEXT_QUEUE"]},"ProcessManagerDetail":{"type":"object","properties":{"id":{"type":"integer"},"first_name":{"type":"string"},"last_name":{"type":"string"},"name":{"type":"string"},"email_primary":{"type":"string"},"process_id":{"type":"integer"},"status_id":{"type":"integer"}}},"ProcessStatusType":{"type":"string","enum":["HIDDEN","ACTIVE","ARCHIVED"]},"ProcessSortBy":{"type":"string","enum":["NAME","STATUS","CAMPUS","MANAGER"]},"ProcessQueueAutomationDefaults":{"type":"string","enum":["MANDATORY","CHECKED","UNCHECKED"]},"ProcessQueueStatuses":{"type":"string","enum":["NOT_STARTED","WAITING","IN_PROCESS","DONE"]},"ProcessQueueIndividualDetail":{"type":"object","properties":{"queue_individual_id":{"type":"integer"},"queue_id":{"type":"integer"},"individual_id":{"type":"integer"},"status":{"$ref":"#/components/schemas/ProcessQueueStatuses"},"due":{"type":"string","format":"date-time"},"created":{"type":"string","format":"date-time"},"completed":{"type":"string","format":"date-time"},"process":{"$ref":"#/components/schemas/BasicProcessSerializer"},"queue":{"$ref":"#/components/schemas/BasicQueueSerializer"},"individual":{"$ref":"#/components/schemas/BasicIndividualProfileSerializer"},"assignee":{"$ref":"#/components/schemas/BasicIndividualProfileSerializer"}}},"AddProcessManager":{"type":"object","required":["process_manager_id"],"properties":{"process_manager_id":{"type":"integer","description":"The ID of the individual to add as a manager"}}},"AddQueueManager":{"type":"object","required":["queue_manager_id"],"properties":{"queue_manager_id":{"type":"integer","description":"Individual ID to add as a manager"}}},"CreateProcessRequest":{"required":["campus_id","name"],"type":"object","properties":{"campus_id":{"type":"integer","description":"The ID of the campus"},"name":{"type":"string","description":"The name of the process","minLength":1,"maxLength":50},"hidden":{"type":"boolean","description":"Whether the process is hidden"}}},"CreateQueueRequest":{"required":["process_id","name"],"type":"object","properties":{"process_id":{"type":"integer","description":"The ID of the process"},"name":{"type":"string","description":"The name of the queue","minLength":1,"maxLength":50},"description":{"type":"string","description":"The description of the queue","maxLength":65535},"note":{"type":"string","description":"The instructions of the queue","maxLength":65535}}},"DeleteQueueManager":{"type":"object","properties":{"new_manager_id":{"type":"integer","description":"The ID of an individual to replace the existing manager"}}},"StepDetail":{"type":"object","properties":{"id":{"type":"integer"},"process_id":{"type":"integer"},"name":{"type":"string"},"description":{"type":"string"},"note":{"type":"string"}}},"QueueDetail":{"type":"object","properties":{"id":{"type":"integer"},"actions":{"type":"array","items":{"type":"object","properties":{"apply_mode":{"type":"string","enum":["OPTIONAL","REQUIRED","SUGGESTED"]},"entity":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"}}},"entity_type":{"$ref":"#/components/schemas/QueueActionEntity"},"id":{"type":"integer"},"type":{"type":"string","enum":["ASSIGN","MEMBERSHIP","BAPTISM"]},"value":{"type":"object"}}}},"date":{"type":"string","format":"date-time"},"days_later":{"type":"integer"},"description":{"type":"string"},"due_date":{"type":"string","format":"date-time"},"due_date_type":{"type":"string","enum":["ABSOLUTE","MONTHLY_DATE","MONTHLY_DAY","QUARTERLY_DAY","RELATIVE","WEEKLY"]},"instructions":{"type":"string"},"integrations":{"type":"array","items":{"type":"object","properties":{"entity":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"}}},"entity_type":{"$ref":"#/components/schemas/QueueIntegrationEntity"}}}},"managers":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"}}}},"name":{"type":"string"},"notify_queue_managers_days":{"type":"integer"},"pref_notify_managers_assigned":{"type":"boolean"},"pref_notify_managers_unassigned":{"type":"boolean"},"process":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"},"hidden":{"type":"boolean"},"archived":{"type":"boolean"}}},"status_counts":{"type":"object","properties":{"done":{"type":"integer"},"in_process":{"type":"integer"},"not_started":{"type":"integer"},"overdue":{"type":"integer"},"unassigned":{"type":"integer"},"waiting":{"type":"integer"}}},"weekday":{"type":"string"},"week_number":{"type":"string"}}},"ProcessDetail":{"type":"object","properties":{"id":{"type":"integer"},"campus_id":{"type":"integer"},"name":{"type":"string"},"hidden":{"type":"boolean"},"archived":{"type":"boolean"},"queues":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"}}}},"managers":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"}}}}}},"ProcessQueueManagerDetail":{"type":"object","properties":{"id":{"type":"integer"},"first_name":{"type":"string"},"last_name":{"type":"string"},"name":{"type":"string"},"email_primary":{"type":"string"},"queue_id":{"type":"integer"},"status_id":{"type":"integer"}}},"UpdateProcessRequest":{"type":"object","properties":{"campus_id":{"type":"integer","description":"The ID of the campus"},"name":{"type":"string","description":"The name of the process","minLength":1,"maxLength":50},"hidden":{"type":"boolean","description":"Whether the process is hidden"},"archived":{"type":"boolean","description":"Whether the process is archived"}}},"UpdateQueueIndividualRequestInternal":{"type":"object","properties":{"status":{"type":"string"},"managerId":{"type":"integer"},"dueDate":{"type":"string","format":"date-time"},"completedDate":{"type":"string","format":"date-time"}}},"QueueIndividualOutput":{"type":"object","properties":{"individualId":{"type":"integer"},"queueId":{"type":"integer"},"status":{"type":"string"},"managerId":{"type":"integer"},"dueDate":{"type":"string"},"completedDate":{"type":"string"}}},"UpdateQueueOrderRequest":{"type":"object","required":["queue_ids"],"properties":{"queue_ids":{"type":"array","description":"Ordered list of queue IDs representing the new queue order","items":{"type":"integer"}}}},"UpdateQueueOrderResponse":{"type":"object","properties":{"success":{"type":"boolean","description":"Whether the reorder operation was successful"}}},"SendNotificationsRequest":{"type":"object","required":["queue_individual_ids"],"properties":{"queue_individual_ids":{"type":"array","items":{"type":"integer","description":"List of queue individual IDs to notify"}},"type":{"type":"string","description":"Type of notification to send (e.g., 'EMAIL')"}}},"SendNotificationsOutput":{"type":"object","properties":{"notifications_sent":{"type":"integer"}}},"QueueDetailsOutput":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"},"description":{"type":"string"},"instructions":{"type":"string"},"process":{"$ref":"#/components/schemas/BasicProcessSerializer"},"managers":{"type":"array","items":{"$ref":"#/components/schemas/ProcessQueueManagerDetail"}},"integrations":{"type":"array","items":{"$ref":"#/components/schemas/QueueIntegrationOutput"}},"status_counts":{"type":"object","properties":{"not_started":{"type":"integer"},"waiting":{"type":"integer"},"in_process":{"type":"integer"},"done":{"type":"integer"}}},"actions":{"type":"array","items":{"$ref":"#/components/schemas/QueueActionOutput"}},"due_date_type":{"type":"string","enum":["NONE","SPECIFIC_DATE","DAYS_LATER","WEEKLY"]},"days_later":{"type":"integer"},"date":{"type":"string","format":"date"},"due_date":{"type":"string","format":"date"},"weekday":{"type":"string"},"week_number":{"type":"string"},"notify_queue_managers_days":{"type":"integer"},"pref_notify_managers_assigned":{"type":"boolean"},"pref_notify_managers_unassigned":{"type":"boolean"}}},"QueueIndividualDetail":{"type":"object","properties":{"id":{"type":"integer"},"individual":{"type":"object","properties":{"id":{"type":"integer"},"first_name":{"type":"string"},"last_name":{"type":"string"},"name":{"type":"string"},"email_primary":{"type":"string"},"campus_id":{"type":"integer"},"phones":{"type":"array","items":{"type":"object","properties":{"number":{"type":"string"},"type":{"type":"string","enum":["CONTACT","EMERGENCY","FAX","HOME","MOBILE","PAGER","WORK"]}}}}}},"manager":{"type":"object","nullable":true,"properties":{"id":{"type":"integer"},"first_name":{"type":"string"},"last_name":{"type":"string"},"name":{"type":"string"}}},"status":{"$ref":"#/components/schemas/QueueIndividualListStatus"},"due_date":{"type":"string","format":"date"},"date_completed":{"type":"string","format":"date-time"},"date_created":{"type":"string","format":"date-time"},"date_modified":{"type":"string","format":"date-time"},"history":{"type":"array","items":{"$ref":"#/components/schemas/QueueIndividualHistoryEntry"}},"creator_id":{"type":"integer","nullable":true},"modifier_id":{"type":"integer","nullable":true}}},"QueueIntegrationOutput":{"type":"object","properties":{"id":{"type":"integer"},"queue_id":{"type":"integer"},"entity_id":{"type":"integer"},"entity_type":{"type":"string"}}},"QueueActionOutput":{"type":"object","properties":{"id":{"type":"integer"},"type":{"type":"string"},"apply_mode":{"type":"string","enum":["ON_ADD","ON_DONE"]},"entity_type":{"type":"string"},"value":{"type":"object"},"filter_ids":{"type":"array","items":{"type":"integer"}}}},"QueueActionTypeOutput":{"type":"object","properties":{"status":{"type":"string"},"type":{"type":"string"}}},"UpdateQueueRequest":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":50},"description":{"type":"string","maxLength":65535},"instructions":{"type":"string","maxLength":65535},"due_date_type":{"type":"string","enum":["NONE","SPECIFIC_DATE","DAYS_LATER","WEEKLY"]},"days_later":{"type":"integer"},"date":{"type":"string","format":"date"},"due_date":{"type":"string","format":"date"},"weekday":{"type":"string"},"week_number":{"type":"string","maxLength":25},"notify_queue_managers_days":{"type":"integer","minimum":0,"maximum":999},"pref_notify_managers_assigned":{"type":"boolean"},"pref_notify_managers_unassigned":{"type":"boolean"}}},"CreateQueueActionRequest":{"type":"object","required":["apply_mode","entity_type","type","value"],"properties":{"apply_mode":{"type":"string","enum":["ON_ADD","ON_DONE"]},"entity_type":{"type":"string"},"filter_ids":{"type":"array","items":{"type":"integer"}},"type":{"type":"string"},"value":{"type":"object"}}},"UpdateQueueActionsRequest":{"type":"object","required":["actions"],"properties":{"actions":{"type":"array","items":{"$ref":"#/components/schemas/CreateQueueActionRequest"}}}},"CreateQueueIntegrationRequest":{"type":"object","required":["entity_id","entity_type"],"properties":{"entity_id":{"type":"integer"},"entity_type":{"type":"string"}}},"AddQueueIndividualRequest":{"type":"object","required":["individual_id"],"properties":{"individual_id":{"type":"integer","description":"The ID of the individual to add"},"manager_id":{"type":"integer","description":"The ID of the queue manager to assign"},"status_id":{"type":"integer","description":"The initial status ID"}}},"UpdateQueueIntegrationRequest":{"type":"object","required":["entity_type"],"properties":{"entity_id":{"type":"integer"},"entity_type":{"type":"string"},"queue_id":{"type":"integer","description":"The queue ID for this integration"}}},"CreateQueueInput":{"type":"object","required":["name"],"properties":{"date":{"type":"string","format":"date"},"days_later":{"type":"integer"},"description":{"type":"string","maxLength":65535},"due_date":{"type":"string","format":"date"},"due_date_type":{"type":"string","enum":["NONE","SPECIFIC_DATE","DAYS_LATER","WEEKLY"]},"instructions":{"type":"string","maxLength":65535},"name":{"type":"string","minLength":1,"maxLength":50},"notify_queue_managers_days":{"type":"integer","minimum":0,"maximum":999},"pref_notify_managers_assigned":{"type":"boolean"},"pref_notify_managers_unassigned":{"type":"boolean"},"weekday":{"type":"string"},"week_number":{"type":"string","maxLength":25}}},"UpdateQueueIndividualInput":{"type":"object","properties":{"completed_date":{"type":"string","format":"date-time"},"due_date":{"type":"string","format":"date"},"manager_id":{"type":"integer","description":"The ID of the queue manager to assign"},"status":{"type":"string","enum":["NOT_STARTED","WAITING","IN_PROCESS","DONE"]}}},"QueueIndividualHistoryEntry":{"type":"object","properties":{"date_time_stamp":{"type":"string","format":"date-time"},"activity_type":{"$ref":"#/components/schemas/QueueActivityType"},"change":{"type":"object","properties":{"from":{"oneOf":[{"type":"string"},{"type":"integer"}]},"to":{"oneOf":[{"type":"string"},{"type":"integer"}]}}},"entity":{"type":"object","properties":{"id":{"type":"integer"},"type":{"oneOf":[{"$ref":"#/components/schemas/QueueActionEntity"},{"$ref":"#/components/schemas/QueueIntegrationEntity"}]},"name":{"type":"string"}}},"actor":{"type":"object","properties":{"id":{"type":"integer"},"type":{"$ref":"#/components/schemas/QueueIndividualActorType"},"name":{"type":"string"}}},"source":{"type":"object","properties":{"id":{"type":"integer"},"type":{"$ref":"#/components/schemas/QueueActivitySourceType"},"name":{"type":"string"}}}}},"QueueActivityType":{"type":"string","enum":["ASSIGN_MANAGER","CHANGE_STATUS","EGRESS","INGRESS","UNASSIGN_MANAGER"]},"QueueActionEntity":{"type":"string","enum":["EVENT","GROUP","MAIL_MERGE","POSITION","PROFILE","QUEUE"]},"QueueIntegrationEntity":{"type":"string","enum":["FORM"]},"QueueIndividualListStatus":{"type":"string","enum":["WAITING","IN_PROCESS","DONE","NOT_STARTED"]},"QueueIndividualActorType":{"type":"string","enum":["USER","SYSTEM"]},"QueueActivitySourceType":{"type":"string","enum":["AD_HOC","FORM_RESPONSE","PEOPLE_SEARCH","PROFILE","QUEUE"]},"BaseResourceSerializer":{"type":"object","properties":{"id":{"type":"integer"},"campuse_id":{"type":"integer"},"name":{"type":"string"},"description":{"type":"string"},"notify_leaders_of_approval_groups":{"type":"boolean"},"listed":{"type":"boolean"},"grouping":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"}}}}},"RoomSerializer":{"allOf":[{"$ref":"#/components/schemas/BaseResourceSerializer"},{"type":"object","properties":{"allow_layout":{"type":"boolean"},"allow_conflicts":{"type":"boolean"}}}]},"ResourceSerializer":{"allOf":[{"$ref":"#/components/schemas/BaseResourceSerializer"},{"type":"object","properties":{"quantity":{"type":"integer"}}}]},"SacramentSerializer":{"type":"object","properties":{"id":{"type":"integer"},"individual_id":{"type":"integer"},"sacrament":{"$ref":"#/components/schemas/Baptism"}}},"GodParents":{"type":"object","properties":{"isTrained":{"type":"boolean"},"name":{"type":"string"}}},"Parish":{"type":"object","properties":{"email":{"type":"string"},"name":{"type":"string"},"street":{"type":"string"},"street2":{"type":"string"},"city":{"type":"string"},"state":{"type":"string"},"zip":{"type":"string"},"diocese":{"type":"string"},"diocese_email":{"type":"string"}}},"Baptism":{"type":"object","properties":{"type":{"type":"string","example":"BAPTISM"},"status":{"type":"string","enum":["COMPLETED","IN_PROGRESS","PENDING"]},"date_performed":{"type":"string"},"parish":{"type":"array","items":{"$ref":"#/components/schemas/Parish"}},"godparents":{"type":"array","items":{"$ref":"#/components/schemas/GodParents"}},"notes":{"type":"string"}}},"IndividualSavedSearchDetails":{"type":"object","properties":{"id":{"type":"integer","description":"Id of the saved search"},"name":{"type":"string","description":"Name of the saved search"},"is_owner":{"type":"boolean","description":"Whether the individual is the owner of the saved search"},"is_starred":{"type":"boolean","description":"Whether the individual has starred the saved search"},"is_editor":{"type":"boolean","description":"Whether the individual was given edit access to the saved search by another individual"},"can_edit":{"type":"boolean","description":"Whether the individual has authorization to edit a saved search based on system permission level"},"invited_by_individual_id":{"type":"integer","description":"Id of the individual that shared the saved search"}}},"TeamStatusFilter":{"type":"string","enum":["ACTIVE","ARCHIVED","ACTIVE_AND_ARCHIVED"]},"SongKey":{"type":"string","enum":["A","A#","Bb","B","C","C#","Db","D","D#","Eb","E","F","F#","Gb","G","G#","Ab","Am","A#m","Bbm","Bm","Cm","C#m","Dbm","Dm","D#m","Ebm","Em","Fm","F#m","Gbm","Gm","G#m","Abm"]},"EventFileSerializer":{"type":"object","properties":{"id":{"type":"integer"},"doc_id":{"type":"integer"},"label":{"type":"string"},"file_name":{"type":"string"},"description":{"type":"string"},"url":{"type":"string"},"file_size":{"type":"integer"},"mime_type":{"type":"string"},"updated":{"type":"string","format":"date-time"},"created":{"type":"string","format":"date-time"}}},"CategorySerializer":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"},"organizer":{"$ref":"#/components/schemas/BasicIndividualProfileSerializer","deprecated":true},"teams":{"type":"array","items":{"$ref":"#/components/schemas/TeamSerializer"}},"campus":{"$ref":"#/components/schemas/BasicCampusSerializer"},"start":{"type":"string","format":"date-time"},"end":{"type":"string","format":"date-time"},"allowed_replacement_type":{"type":"string","enum":["NONE","CATEGORY","TEAM","POSITION"]},"default_assignment_status":{"type":"string","enum":["PENDING","ASSIGNED"]},"child_work_approved_required":{"type":"boolean"},"archived":{"type":"boolean"},"has_service_plans":{"type":"boolean"},"has_serving_rotations":{"type":"boolean"},"actions":{"type":"object","properties":{"can_edit_category":{"$ref":"#/components/schemas/Action"},"can_delete_category":{"$ref":"#/components/schemas/Action"}}}}},"TeamSerializer":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"},"positions":{"type":"array","items":{"$ref":"#/components/schemas/PositionSerializer"}}}},"BasicSchedulingPositionSerializer":{"type":"object","properties":{"id":{"type":"integer"},"team_id":{"type":"integer"},"name":{"type":"string"}}},"PositionSerializer":{"allOf":[{"$ref":"#/components/schemas/BasicSchedulingPositionSerializer"},{"type":"object","properties":{"volunteers":{"type":"array","items":{"$ref":"#/components/schemas/VolunteerSerializer"}}}}]},"VolunteerSerializer":{"type":"object","properties":{"id":{"type":"integer"},"position_id":{"type":"integer"},"individual":{"$ref":"#/components/schemas/SchedulingIndividualSerializer"},"alerts":{"type":"array","items":{"$ref":"#/components/schemas/AlertSerializer"}}}},"VolunteerMigrationSerializer":{"type":"object","properties":{"migration_count":{"type":"integer"}}},"SchedulingIndividualSerializer":{"allOf":[{"$ref":"#/components/schemas/BasicIndividualProfileSerializer"},{"type":"object","properties":{"receive_scheduling_emails":{"type":"boolean"},"receive_scheduling_texts":{"type":"boolean"},"alerts":{"type":"array","items":{"$ref":"#/components/schemas/AlertSerializer"}},"last_served_date":{"type":"string","format":"date-time"}}}]},"BasicScheduleSerializer":{"type":"object","properties":{"id":{"type":"integer"},"category_id":{"type":"integer"},"name":{"type":"string"},"start":{"type":"string","format":"date-time"},"end":{"type":"string","format":"date-time"},"allowed_signup_type":{"type":"boolean"},"same_people_serve_all_times":{"type":"boolean"},"needed":{"type":"integer"}}},"ScheduleSerializer":{"allOf":[{"$ref":"#/components/schemas/BasicScheduleSerializer"},{"type":"object","properties":{"events":{"type":"array","items":{"$ref":"#/components/schemas/SchedulingEventSerializer"}},"associated_times":{"type":"array","items":{"$ref":"#/components/schemas/AssociatedTimeSerializer"}},"metrics":{"$ref":"#/components/schemas/SchedulingAssignmentMetricsSerializer"}}}]},"SchedulesSerializer":{"type":"array","items":{"$ref":"#/components/schemas/ScheduleSerializer"}},"AvailableScheduleDateSerializer":{"type":"object","properties":{"start":{"type":"string","format":"date-time"},"end":{"type":"string","format":"date-time"}}},"BasicSchedulingEventSerializer":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"},"recurrence_rule":{"type":"string"},"service_plan_id":{"type":"integer"},"serving_rotation_id":{"type":"integer"},"start":{"type":"string","format":"date-time"},"end":{"type":"string","format":"date-time"}}},"SchedulingEventSerializer":{"allOf":[{"$ref":"#/components/schemas/BasicSchedulingEventSerializer"},{"type":"object","properties":{"event_files":{"type":"array","items":{"$ref":"#/components/schemas/EventFileSerializer"}},"event_teams":{"type":"array","items":{"$ref":"#/components/schemas/EventTeamSerializer"}},"metrics":{"$ref":"#/components/schemas/SchedulingAssignmentMetricsSerializer"},"has_associated_times":{"type":"boolean"}}}]},"SchedulingAssignmentMetricsSerializer":{"type":"object","properties":{"total_assignments":{"type":"integer"},"pending_assignments":{"type":"integer"},"declined_assignments":{"type":"integer"},"accepted_assignments":{"type":"integer"},"checked_in_assignments":{"type":"integer"},"not_notified_assignments":{"type":"integer"},"pending_swaps":{"type":"integer"},"pending_replacements":{"type":"integer"}}},"AssociatedTimeSerializer":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"},"start":{"type":"string","format":"date-time"},"end":{"type":"string","format":"date-time"}}},"EventTeamSerializer":{"type":"object","properties":{"id":{"type":"integer"},"needed":{"type":"integer"},"quantity":{"type":"integer"},"event_id":{"type":"integer"},"team_id":{"type":"integer"},"event_positions":{"type":"array","items":{"$ref":"#/components/schemas/EventPositionSerializer"}},"team":{"$ref":"#/components/schemas/TeamSerializer"}}},"ServingReminderTimeSerializer":{"type":"object","properties":{"id":{"type":"integer"},"category_id":{"type":"integer"},"schedule_id":{"type":"integer"},"days_before":{"type":"integer"},"time_of_day":{"type":"string"}}},"SongSerializer":{"type":"object","properties":{"id":{"type":"integer"},"title":{"type":"string"},"authors":{"type":"string"},"ccli_number":{"type":"integer"},"song_select_id":{"type":"integer"},"time_signature":{"type":"string"},"tempo":{"type":"integer"},"duration":{"type":"integer"},"key_name":{"$ref":"#/components/schemas/SongKey"}}},"SongSearchSerializer":{"type":"object","properties":{"song_id":{"type":"integer"},"ccli_number":{"type":"string"},"song_select_id":{"type":"string"},"title":{"type":"string"},"authors":{"type":"string"},"version_id":{"type":"integer"},"version_title":{"type":"string"},"primary_version":{"type":"integer"},"time_signature":{"type":"string"},"tempo":{"type":"string"},"duration":{"type":"integer"},"song_keys":{"type":"string"},"key_file_count":{"type":"integer"},"version_file_count":{"type":"integer"},"archived":{"type":"integer"},"creator_id":{"type":"integer"},"modifier_id":{"type":"integer"},"date_created":{"type":"string","format":"date-time"},"date_modified":{"type":"string","format":"date-time"},"date_last_used":{"type":"string","format":"date-time"}}},"SongVersionLinkSerializer":{"type":"object","properties":{"id":{"type":"integer"},"version_id":{"type":"integer"},"url":{"type":"string"},"label":{"type":"string"}}},"BasicEventPositionSerializer":{"type":"object","properties":{"id":{"type":"integer"},"needed":{"type":"integer"},"quanitity":{"type":"integer"},"should_print_checkin_label":{"type":"boolean"},"is_open":{"type":"boolean"},"category_id":{"type":"integer"},"event_team_id":{"type":"integer"},"position_id":{"type":"integer"},"schedule_id":{"type":"integer"},"event_position_associated_times":{"type":"array","items":{"$ref":"#/components/schemas/EventPositionAssociatedTimeSerializer"}},"assignments":{"type":"array","items":{"$ref":"#/components/schemas/AssignmentSerializer"}},"position":{"$ref":"#/components/schemas/BasicSchedulingPositionSerializer"}}},"EventPositionSerializer":{"allOf":[{"$ref":"#/components/schemas/BasicEventPositionSerializer"},{"type":"object","properties":{"assignments":{"type":"array","items":{"$ref":"#/components/schemas/AssignmentSerializer"}}}}]},"EventPositionAssociatedTimeSerializer":{"type":"object","properties":{"event_position_id":{"type":"integer"},"event_team_id":{"type":"integer"},"event_id":{"type":"integer"},"schedule_id":{"type":"integer"},"category_id":{"type":"integer"},"position_id":{"type":"integer"},"associated_time_id":{"type":"integer"},"is_required":{"type":"boolean"}}},"AvailableAssignmentSwapSerializer":{"type":"object","properties":{"id":{"type":"integer"},"category_id":{"type":"integer"},"schedule_id":{"type":"integer"},"event_id":{"type":"integer"},"event_position_id":{"type":"integer"},"status":{"type":"string","enum":["PENDING","ACCEPTED","DECLINED","CHECKED_IN"]},"status_reason":{"type":"string"},"status_date_modified":{"type":"string","format":"date-time"},"notifier_id":{"type":"integer"},"date_notified":{"type":"string","format":"date-time"},"context_data":{"type":"object","properties":{"event":{"$ref":"#/components/schemas/BasicSchedulingEventSerializer"},"individual":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"}}},"position":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"}}},"team":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"}}}}}}},"AssignmentSerializer":{"type":"object","properties":{"id":{"type":"integer"},"category_id":{"type":"integer"},"schedule_id":{"type":"integer"},"event_id":{"type":"integer"},"event_team_id":{"type":"integer"},"event_position_id":{"type":"integer"},"status":{"type":"string","enum":["PENDING","ACCEPTED","DECLINED","CHECKED_IN"]},"status_reason":{"type":"string"},"status_date_modified":{"type":"string","format":"date-time"},"notifier_id":{"type":"integer"},"date_notified":{"type":"string","format":"date-time"},"volunteer":{"$ref":"#/components/schemas/VolunteerSerializer"},"assignment_associated_times":{"type":"array","items":{"$ref":"#/components/schemas/AssignmentAssociatedTimeSerializer"}},"alerts":{"type":"array","items":{"$ref":"#/components/schemas/AlertSerializer"}}}},"AssignmentAssociatedTimeSerializer":{"type":"object","properties":{"category_id":{"type":"integer"},"schedule_id":{"type":"integer"},"event_id":{"type":"integer"},"event_team_id":{"type":"integer"},"event_position_id":{"type":"integer"},"assignment_id":{"type":"integer"},"associated_time_id":{"type":"integer"},"is_required":{"type":"boolean"}}},"AlertSerializer":{"type":"object","properties":{"id":{"type":"integer"},"assignment_id":{"type":"integer"},"volunteer_id":{"type":"integer"},"alert_type":{"type":"string","enum":["SCHEDULING_CONFLICT","BLOCKOUT_DATE","SPECIFIC_WEEKS_SERVING_PREFERENCE","FREQUENCY_SERVING_PREFERENCE","BACKGROUND_CHECK_EXPIRATION"]},"message":{"type":"string"}}},"AssignmentSwapSerializer":{"type":"object","properties":{"id":{"type":"integer"},"status":{"type":"string"},"context_data":{"type":"object","properties":{"source_assignment":{"$ref":"#/components/schemas/AssignmentSerializer"},"destination_assignment":{"$ref":"#/components/schemas/AssignmentSerializer"}}}}},"VolunteerMessageSerializer":{"type":"object","properties":{"recipient_count":{"type":"integer"},"missing_email_count":{"type":"integer"}}},"ServicePlanSerializer":{"type":"object","properties":{"id":{"type":"integer"},"category_id":{"type":"integer"},"name":{"type":"string"},"event_starttime_offset":{"type":"integer"},"items":{"type":"array","items":{"$ref":"#/components/schemas/ServicePlanItemSerializer"}},"duration":{"type":"integer"}}},"ServicePlanItemSerializer":{"type":"object","properties":{"id":{"type":"integer"},"category_id":{"type":"integer"},"service_plan_id":{"type":"integer"},"order_by":{"type":"integer"},"item_type":{"type":"string","enum":["ITEM","SECTION_HEADER"]},"duration":{"type":"integer"},"name":{"type":"string"},"description":{"type":"string"},"links":{"type":"array","items":{"$ref":"#/components/schemas/ServicePlanItemLinkSerializer"}},"files":{"type":"array","items":{"$ref":"#/components/schemas/ServicePlanItemFileSerializer"}}}},"ServicePlanItemLinkSerializer":{"type":"object","properties":{"id":{"type":"integer"},"category_id":{"type":"integer"},"service_plan_id":{"type":"integer"},"service_plan_item_id":{"type":"integer"},"label":{"type":"string"},"url":{"type":"string"}}},"ServicePlanItemFileSerializer":{"type":"object","properties":{"id":{"type":"integer"},"category_id":{"type":"integer"},"service_plan_id":{"type":"integer"},"service_plan_item_id":{"type":"integer"},"doc_id":{"type":"integer"},"label":{"type":"string"},"file_name":{"type":"string"},"description":{"type":"string"},"url":{"type":"string"},"file_size":{"type":"integer"},"mime_type":{"type":"string"}}},"ServingRotationSerializer":{"type":"object","properties":{"id":{"type":"integer"},"category_id":{"type":"integer"},"name":{"type":"string"},"serving_rotation_teams":{"type":"array","items":{"$ref":"#/components/schemas/ServingRotationTeamSerializer"}}}},"ServingRotationTeamSerializer":{"type":"object","properties":{"id":{"type":"integer"},"category_id":{"type":"integer"},"serving_rotation_id":{"type":"integer"},"team_id":{"type":"integer"},"team":{"$ref":"#/components/schemas/TeamSerializer"},"serving_rotation_positions":{"type":"array","items":{"$ref":"#/components/schemas/ServingRotationPositionSerializer"}}}},"ServingRotationPositionSerializer":{"type":"object","properties":{"id":{"type":"integer"},"category_id":{"type":"integer"},"serving_rotation_id":{"type":"integer"},"serving_rotation_team_id":{"type":"integer"},"position_id":{"type":"integer"},"position":{"$ref":"#/components/schemas/PositionSerializer"},"quantity":{"type":"integer"}}},"ServingRotationAssignmentSerializer":{"type":"object","properties":{"id":{"type":"integer"},"category_id":{"type":"integer"},"serving_rotation_id":{"type":"integer"},"serving_rotation_team_id":{"type":"integer"},"serving_rotation_position_id":{"type":"integer"},"volunteer_id":{"type":"integer"},"volunteer":{"$ref":"#/components/schemas/VolunteerSerializer"},"alerts":{"type":"array","items":{"$ref":"#/components/schemas/AlertSerializer"}}}},"IndividualServingPreferencesSerializer":{"type":"object","properties":{"individual_id":{"type":"integer"},"type":{"type":"string","enum":["UNLIMITED","WEEKS_PER_MONTH","WEEKS_OF_MONTH"]},"value":{"type":"array","items":{"type":"integer"}}}},"UnifiedServingPreferencesSerializer":{"type":"object","properties":{"individual_id":{"type":"integer"},"serve_with_family":{"type":"boolean"},"frequency_mode":{"type":"string","enum":["GLOBAL","CATEGORY"]},"weekly":{"type":"object","properties":{"preference_type":{"type":"string","enum":["UNLIMITED","WEEKS_PER_MONTH","WEEKS_OF_MONTH"]},"preference":{"type":"array","nullable":true,"items":{"type":"integer"}}}},"frequency":{"type":"object","properties":{"global":{"type":"object","nullable":true,"properties":{"interval":{"type":"string"},"number":{"type":"integer"}}},"category":{"type":"array","items":{"type":"object","properties":{"category_id":{"type":"integer"},"name":{"type":"string"},"interval":{"type":"string","nullable":true},"number":{"type":"integer","nullable":true}}}}}},"category_preferences":{"type":"array","items":{"type":"object","properties":{"category_id":{"type":"integer"},"name":{"type":"string"},"serving_times":{"type":"array","items":{"type":"object"}},"teams":{"type":"array","items":{"type":"object","properties":{"team_id":{"type":"integer"},"name":{"type":"string"},"positions":{"type":"array","items":{"type":"object","properties":{"position_id":{"type":"integer"},"name":{"type":"string"},"interval":{"type":"string","nullable":true},"number":{"type":"integer","nullable":true},"serving_times":{"type":"array","items":{"type":"object"}}}}}}}}}}}}},"IndividualBlockoutDateSerializer":{"type":"object","properties":{"id":{"type":"integer"},"individual_id":{"type":"integer"},"start":{"type":"string","format":"date-time"},"end":{"type":"string","format":"date-time"},"reason":{"type":"string"}}},"BasicIndividualEventPositionSerializer":{"type":"object","properties":{"individual_id":{"type":"integer"},"alerts":{"type":"array","items":{"type":"string"}},"event_position":{"type":"object","allOf":[{"$ref":"#/components/schemas/BasicEventPositionSerializer"},{"type":"object","properties":{"start":{"type":"string"},"end":{"type":"string"}}}]}}},"IndividualEventPositionSerializer":{"allOf":[{"$ref":"#/components/schemas/BasicIndividualEventPositionSerializer"},{"type":"object","properties":{"schedule":{"$ref":"#/components/schemas/ScheduleSerializer"}}}]},"IndividualPositionSerializer":{"allOf":[{"$ref":"#/components/schemas/BasicSchedulingPositionSerializer"},{"type":"object","properties":{"category":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"}}},"team":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"}}}}}]},"IndividualServingPreferenceTimeSerializer":{"type":"object","properties":{"id":{"type":"integer"},"category_id":{"type":"integer"},"individual_id":{"type":"integer"},"position_id":{"type":"integer"},"start":{"type":"string","format":"date-time"},"end":{"type":"string","format":"date-time"}}},"AssignmentAdvanceSearchSerializer":{"type":"object","properties":{"id":{"type":"integer"},"date_modified":{"type":"string","format":"date-time"},"is_public":{"type":"integer"},"event":{"type":"object","properties":{"campus_timezone":{"type":"string","format":"date-time"},"datetime_end":{"type":"string","format":"date-time"},"datetime_start":{"type":"string","format":"date-time"},"id":{"type":"integer"},"name":{"type":"string"}}},"status":{"type":"object","properties":{"date_modified":{"type":"string","format":"date-time"},"name":{"type":"string"},"reason":{"type":"string"}}},"individual":{"type":"object","properties":{"email_primary":{"type":"string"},"first_name":{"type":"string"},"id":{"type":"integer"},"last_name":{"type":"string"},"name":{"type":"string"}}},"volunteer":{"type":"object","properties":{"id":{"type":"integer"}}},"category":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"},"organizers":{"type":"array","items":{"$ref":"#/components/schemas/Organizer"}}}},"position":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"}}},"schedule":{"type":"object","properties":{"events":{"type":"array","items":{"$ref":"#/components/schemas/SchedulingEventSerializer"}},"id":{"type":"integer"},"name":{"type":"string"}}},"campus":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"}}},"team":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"},"organizers":{"type":"array","items":{"$ref":"#/components/schemas/Organizer"}}}}}},"OrganizerAdvanceSearchSerializer":{"type":"object","properties":{"type":{"type":"string"},"id":{"type":"integer"},"schedule":{"type":"object","properties":{"events":{"type":"array","items":{"$ref":"#/components/schemas/SchedulingEventSerializer"}},"id":{"type":"integer"}}},"organizer":{"type":"object","properties":{"id":{"type":"integer"},"first_name":{"type":"string"},"last_name":{"type":"string"},"name":{"type":"string"}}},"category":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"}}},"campus":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"}}},"team":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"}}}}},"PositionAdvanceSearchSerializer":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"},"status":{"type":"string"},"status_date":{"type":"string","format":"date-time"},"description":{"type":"string"},"needed":{"type":"integer"},"filling":{"type":"integer"},"percentage":{"type":"number"},"category":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"},"organizers":{"type":"array","items":{"$ref":"#/components/schemas/Organizer"}}}},"campus":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"}}},"team":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"},"organizers":{"type":"array","items":{"$ref":"#/components/schemas/Organizer"}}}}}},"ScheduleAdvanceSearchSerializer":{"type":"object","properties":{"id":{"type":"integer"},"accepted":{"type":"integer"},"still_needed":{"type":"integer"},"checked_in":{"type":"integer"},"pending":{"type":"integer"},"events":{"type":"array","items":{"$ref":"#/components/schemas/SchedulingEventSerializer"}},"category":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"},"organizers":{"type":"array","items":{"$ref":"#/components/schemas/Organizer"}}}},"campus":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"}}}}},"ScheduleTotalsAdvanceSearchSerializer":{"type":"object","properties":{"still_needed":{"type":"integer"},"needed":{"type":"integer"},"accepted":{"type":"integer"},"checked_in":{"type":"integer"},"declined":{"type":"integer"},"pending":{"type":"integer"}}},"VolunteerAdvanceSearchSerializer":{"type":"object","properties":{"id":{"type":"integer"},"blockout_dates":{"type":"array","items":{"$ref":"#/components/schemas/IndividualBlockoutDateSerializer"}},"serving_preferences":{"type":"object","properties":{"individual_id":{"type":"integer"},"preference_type":{"type":"string"},"preference":{"type":"array","items":{"type":"number"}}}},"serving_preference_times":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer"},"individual_id":{"type":"integer"},"position_id":{"type":"integer"},"category_id":{"type":"integer"},"start":{"type":"string","format":"date-time"},"end":{"type":"string","format":"date-time"}}}},"serving_rotations":{"type":"array","items":{"type":"string"}},"status":{"type":"object","properties":{"name":{"type":"string"}}},"volunteer":{"type":"object","properties":{"id":{"type":"integer"}}},"individual":{"type":"object","properties":{"id":{"type":"integer"},"first_name":{"type":"string"},"last_name":{"type":"string"},"name":{"type":"string"},"phone_mobile":{"type":"string"},"email_primary":{"type":"string"},"mailing_street":{"type":"string"},"mailing_city":{"type":"string"},"mailing_state":{"type":"string"},"mailing_zip":{"type":"string"}}},"category":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"}}},"position":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"},"history":{"type":"array","items":{"type":"object","properties":{"position_id":{"type":"integer"},"status":{"type":"string"},"date_created":{"type":"string","format":"date-time"}}}}}},"campus":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"}}},"team":{"type":"object","properties":{"id":{"type":"integer"},"organizers":{"type":"array","items":{"$ref":"#/components/schemas/Organizer"}},"name":{"type":"string"}}},"assignment":{"type":"object","properties":{"assignment":{"type":"object","properties":{"name":{"type":"string"}}}}}}},"ScheduleAssignmentMetric":{"type":"object","properties":{"status":{"type":"string","enum":["PENDING","ACCEPTED","DECLINED","CHECKED_IN"]},"total":{"type":"integer"},"not_notified_count":{"type":"integer"},"notified_count":{"type":"integer"}}},"TeamRequestBody":{"type":"object","properties":{"name":{"type":"string"},"positions":{"type":"array","items":{"$ref":"#/components/schemas/PositionRequestBody"}}}},"PositionRequestBody":{"type":"object","properties":{"name":{"type":"string"}}},"ScheduleEventRequestBody":{"type":"object","properties":{"name":{"type":"string"},"start":{"type":"string","format":"date-time"},"end":{"type":"string","format":"date-time"}}},"AssignmentRequestBody":{"type":"object","properties":{"status":{"type":"string","enum":["PENDING","ACCEPTED","DECLINED","CHECKED_IN"]}}},"AssignmentSwapRequestBody":{"type":"object","properties":{"status":{"type":"string","enum":["PENDING","ACCEPTED","DECLINED"]}}},"ScheduleServingReminderTimesRequestBody":{"type":"object","properties":{"days_before":{"type":"integer"},"time_of_day":{"type":"string","description":"hh:mm:ss"}}},"AssignmentStatus":{"type":"string","enum":["PENDING","ACCEPTED","DECLINED","CHECKED_IN"]},"ServicePlanItemLinkRequest":{"type":"object","properties":{"url":{"type":"string"},"label":{"type":"string"}}},"Organizer":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"}}},"SearchDomains":{"type":"string","enum":["assignments","categories","department_detail","groups","individual_event_attendance","individual_groups","individuals","organizers","permission_individuals","positions","schedules","schedules_totals","scheduling_files","scheduling_individuals","songs","volunteers"]},"SearchResultsSerializer":{"type":"object","description":"The search result object will be different for each domain.\nWhen the domain is 'assignment', refer to the AssignmentAdvanceSearchSerializer definition.\nWhen the domain is 'categories', refer to the CategorySerializer definition.\nWhen the domain is 'department_detail', refer to the DepartmentDetailsSearchDomainSerializer definition.\nWhen the domain is 'groups', refer to the BasicGroupSerializer definition.\nWhen the domain is 'individual_event_attendance', refer to the EventAttendanceSummarySerializer definition.\nWhen the domain is 'individual_groups', refer to the BasicIndividualGroupsProfileWithGroupSerializer definition.\nWhen the domain is 'individuals', refer to the IndividualDetailsSerializer definition.\nWhen the domain is 'permission_individuals', refer to the PermissionIndividualDetailsSerializer definition.\nWhen the domain is 'organizers', refer to the OrganizerAdvanceSearchSerializer definition.\nWhen the domain is 'positions', refer to the PositionAdvancedSearchSerializer definition.\nWhen the domain is 'schedules', refer to the ScheduleAdvanceSearchSerializer definition.\nWhen the domain is 'schedules_totals', refer to the ScheduleTotalsAdvanceSearchSerializer definition.\nWhen the domain is 'scheduling_files', refer to the SearchFileDetailSerializer definition.\nWhen the domain is 'scheduling_individuals', refer to the SchedulingIndividualSerializer definition.\nWhen the domain is 'songs', refer to the SongSearchSerializer definition.\nWhen the domain is 'volunteers', refer to the VolunteerAdvanceSearchSerializer definition.\n"},"BasicCriteriaSerializer":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string"}}},"BasicResultsActionSerializer":{"type":"object","properties":{"result_message":{"type":"object","properties":{}},"result_data":{"type":"object","properties":{}},"status":{"type":"string"},"send_completion_message":{"type":"boolean"}}},"PerformUnsavedAdvancedSearchRequestDeprecated":{"type":"object","properties":{"domain":{"$ref":"#/components/schemas/SearchDomains"},"filters":{"type":"object","properties":{},"description":"A search filter tree as described [here](/documentation/documents/search_overview.html)"},"settings":{"$ref":"#/components/schemas/SearchConfiguration"}}},"ColumnOrder":{"type":"object","required":["column"],"properties":{"column":{"type":"string","minLength":1,"pattern":"\\S","description":"A domain-specific sortable column. Unknown columns are rejected by domains that support sorting."},"direction":{"type":"string","description":"Sort direction. Matching is case-insensitive.","default":"asc","pattern":"^(?:[aA][sS][cC]|[dD][eE][sS][cC])$"}}},"SearchConfiguration":{"type":"object","properties":{"columns":{"type":"array","description":"The columns to be returned in the output. Currently only used by the export action","items":{"type":"string"}},"order_by":{"type":"array","description":"Domain-specific ordering for the search results, in precedence order","items":{"$ref":"#/components/schemas/ColumnOrder"}}}},"IndividualSearchConfiguration":{"allOf":[{"$ref":"#/components/schemas/SearchConfiguration"},{"type":"object","properties":{"filter_profile_type":{"type":"array","description":"Specify which profile types to include in the search results. The default is [‘active’] if no values are provided.","items":{"type":"string","enum":["active","inactive","deceased"]}},"include_unlisted":{"type":"boolean","description":"Whether or not to include unlisted in the search results. Not available to all users"},"include_lau":{"type":"boolean","description":"Whether or not to include limited access users in the search results. Not available to all users"},"include_pending":{"type":"boolean","description":"Whether or not to include pending profiles in the search results. Not available to all users"},"return_search_results":{"type":"boolean","description":"Whether or not the results of the search should be returned. This may be set to false\nwhen return_family_positions has a value. Defaults to true\n"},"return_family_positions":{"type":"array","description":"family members related to search results to return","items":{"type":"string","enum":["PRIMARY_CONTACT","SPOUSE","CHILD","OTHER"]}}}}]},"EventAttendanceSummarySerializer":{"type":"object","properties":{"id":{"type":"integer"},"type":{"type":"string"},"name":{"type":"string"},"leaders":{"type":"integer"},"total_leaders":{"type":"integer"},"members":{"type":"integer"},"total_members":{"type":"integer"},"visitors":{"type":"integer"},"children":{"type":"integer"}}},"MeDetailsSerializer":{"allOf":[{"$ref":"#/components/schemas/BasicIndividualProfileSerializer"},{"type":"object","properties":{"analytics_user_types":{"type":"array","description":"Deprecated","items":{"type":"string"}},"user_types":{"type":"array","items":{"type":"string"}},"username":{"type":"string"}}}]},"BasicFinancialSettingsSerializer":{"type":"object","properties":{"organization_id":{"type":"integer"},"system_wide_financials":{"type":"string","enum":["ADMIN"]},"allow_credit_card":{"type":"boolean"},"allow_public_giving":{"type":"boolean"}}},"TemplateEntityType":{"type":"string","format":"enum - FORM - MAIL_MERGE"},"TemplateSharingLevel":{"type":"string","format":"enum - ORGANIZATION - CAMPUSES"},"Template":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"},"description":{"type":"string"},"entity_type":{"$ref":"#/components/schemas/TemplateEntityType"},"sharing_level":{"$ref":"#/components/schemas/TemplateSharingLevel"},"campus_id":{"type":"integer"},"shared_campus_ids":{"type":"array","items":{"type":"integer"}},"backing_entity_id":{"type":"integer"},"originating_entity_id":{"type":"integer"},"usage_count":{"type":"integer"},"last_used_date":{"type":"string","format":"date-time"},"is_system_defined":{"type":"boolean"},"creator":{"$ref":"#/components/schemas/MinimalIndividualProfileSerializer"},"date_created":{"type":"string","format":"date-time"},"date_modified":{"type":"string","format":"date-time"},"actions":{"type":"object","properties":{"can_edit":{"$ref":"#/components/schemas/Action"},"can_share":{"$ref":"#/components/schemas/Action"},"can_delete":{"$ref":"#/components/schemas/Action"},"can_duplicate":{"$ref":"#/components/schemas/Action"}}}}},"PaginatedList":{"type":"object","properties":{"total":{"type":"integer"},"page":{"type":"integer"},"per_page":{"type":"integer"}}},"StepOutput":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"},"description":{"type":"string"},"instructions":{"type":"string"},"due_date_absolute_date":{"type":"string","format":"date-time","nullable":true},"due_date_days_later":{"type":"integer"},"due_date_type":{"type":"string","enum":["A","MT","MD","Q","R","W"]},"due_date_weekday":{"type":"string"},"due_date_week_number":{"type":"string"},"notify_managers_days":{"type":"integer"},"pref_notify_managers_assigned":{"type":"boolean"},"pref_notify_managers_unassigned":{"type":"boolean"},"campus":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"}}},"workflow":{"type":"object","properties":{"archived":{"type":"boolean"},"id":{"type":"integer"},"name":{"type":"string"},"public":{"type":"boolean"}}},"actions":{"type":"array","items":{"type":"object","properties":{"apply_mode":{"type":"string","enum":["OPTIONAL","REQUIRED","SUGGESTED"]},"entity":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"}}},"entity_type":{"type":"string","enum":["EVENT","GROUP","MAIL_MERGE","POSITION","PROFILE","STEP"]},"filter_ids":{"type":"array","items":{"type":"integer"}},"id":{"type":"integer"},"type":{"type":"string","enum":["ASSIGN","BAPTISM","MEMBERSHIP"]},"value":{"type":"string"}}}},"integrations":{"type":"array","items":{"type":"object","properties":{"entity":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"}}},"entity_type":{"type":"string","enum":["FORM"]}}}},"managers":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"}}}},"status_counts":{"type":"object","properties":{"done":{"type":"integer"},"in_process":{"type":"integer"},"not_started":{"type":"integer"},"overdue":{"type":"integer"},"unassigned":{"type":"integer"},"waiting":{"type":"integer"}}},"weekday":{"type":"string"},"week_number":{"type":"string"}}},"CreateStepInput":{"type":"object","required":["name"],"properties":{"description":{"type":"string","maxLength":65535},"due_date_absolute_date":{"type":"string","format":"date"},"due_date_days_later":{"type":"integer"},"due_date_type":{"type":"string","enum":["A","MD","MT","Q","R","W"]},"due_date_weekday":{"type":"string"},"due_date_week_number":{"type":"string","maxLength":25},"instructions":{"type":"string","maxLength":65535},"name":{"type":"string","minLength":1,"maxLength":50},"notify_managers_days":{"type":"integer","minimum":0,"maximum":999},"pref_notify_managers_assigned":{"type":"boolean"},"pref_notify_managers_unassigned":{"type":"boolean"}}},"UpdateStepInput":{"type":"object","properties":{"description":{"type":"string","maxLength":65535,"nullable":true},"due_date_absolute_date":{"type":"string","format":"date","nullable":true},"due_date_days_later":{"type":"integer","nullable":true},"due_date_type":{"type":"string","enum":["A","MD","MT","Q","R","W"],"nullable":true},"due_date_weekday":{"type":"string","nullable":true},"due_date_week_number":{"type":"string","maxLength":25,"nullable":true},"instructions":{"type":"string","maxLength":65535,"nullable":true},"name":{"type":"string","minLength":1,"maxLength":50,"nullable":true},"notify_managers_days":{"type":"integer","minimum":0,"maximum":999,"nullable":true},"pref_notify_managers_assigned":{"type":"boolean","nullable":true},"pref_notify_managers_unassigned":{"type":"boolean","nullable":true}}},"IdWithName":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"}}},"StepManagerOutput":{"type":"object","properties":{"id":{"type":"integer"},"individual":{"type":"object","properties":{"id":{"type":"integer"},"first_name":{"type":"string"},"last_name":{"type":"string"},"name":{"type":"string"},"email_primary":{"type":"string"}}},"step_id":{"type":"integer"},"status":{"type":"integer"}}},"StepIntegrationInput":{"type":"object","required":["entity_id","entity_type"],"properties":{"entity_id":{"type":"integer"},"entity_type":{"type":"string","enum":["FORM"]}}},"DeleteStepManager":{"type":"object","properties":{"new_step_manager_id":{"type":"integer","description":"The ID of an existing step manager (for the same step) to reassign the removed manager's individuals to"}}},"UpdateStepIntegrationRequest":{"type":"object","required":["step_id","entity_id","entity_type"],"properties":{"step_id":{"type":"integer"},"entity_id":{"type":"integer"},"entity_type":{"type":"string","enum":["FORM"]}}},"StepIntegrationOutput":{"type":"object","properties":{"id":{"type":"integer"},"step_id":{"type":"integer"},"entity_id":{"type":"integer"},"entity_type":{"type":"string","enum":["FORM"]}}},"WorkflowManagerOutput":{"type":"object","properties":{"id":{"type":"integer"},"individual":{"type":"object","properties":{"id":{"type":"integer"},"first_name":{"type":"string"},"last_name":{"type":"string"},"name":{"type":"string"},"email_primary":{"type":"string"}}},"workflow_id":{"type":"integer"},"status":{"type":"integer"}}},"IndividualOutput":{"type":"object","properties":{"id":{"type":"integer"},"first_name":{"type":"string"},"last_name":{"type":"string"},"name":{"type":"string"},"email_primary":{"type":"string","nullable":true},"campus_id":{"type":"integer"},"phones":{"type":"array","items":{"$ref":"#/components/schemas/PhoneOutput"}},"images":{"$ref":"#/components/schemas/Images"}}},"MinimalIndividualOutput":{"type":"object","properties":{"id":{"type":"integer"},"first_name":{"type":"string"},"last_name":{"type":"string"},"name":{"type":"string"}}},"PhoneOutput":{"type":"object","properties":{"number":{"type":"string"},"type":{"type":"string","enum":["CONTACT","EMERGENCY","FAX","HOME","MOBILE","PAGER","WORK"]}}},"StepIndividualHistoryEntry":{"type":"object","properties":{"date_time_stamp":{"type":"string","format":"date-time"},"activity_type":{"type":"string","enum":["ASSIGN_MANAGER","CHANGE_DUE_DATE","CHANGE_STATUS","EGRESS","INGRESS","UNASSIGN_MANAGER"]},"change":{"type":"object","nullable":true,"allOf":[{"$ref":"#/components/schemas/StepActivityChange"}]},"entity":{"type":"object","nullable":true,"allOf":[{"$ref":"#/components/schemas/StepActivityEntity"}]},"actor":{"$ref":"#/components/schemas/StepActivityActor"},"source":{"type":"object","nullable":true,"allOf":[{"$ref":"#/components/schemas/StepActivitySource"}]}}},"StepActivityChange":{"type":"object","properties":{"from":{"oneOf":[{"type":"string","nullable":true},{"type":"integer","nullable":true}]},"to":{"oneOf":[{"type":"string"},{"type":"integer"}]}}},"StepActivityEntity":{"type":"object","properties":{"id":{"type":"integer"},"type":{"type":"string","enum":["EVENT","GROUP","MAIL_MERGE","POSITION","PROFILE","STEP","FORM"]},"name":{"type":"string"}}},"StepActivityActor":{"type":"object","properties":{"id":{"type":"integer"},"type":{"type":"string","enum":["SYSTEM","USER"]},"name":{"type":"string"}}},"StepActivitySource":{"type":"object","properties":{"id":{"type":"integer"},"type":{"type":"string","enum":["AD_HOC","FORM_RESPONSE","PEOPLE_SEARCH","PROFILE","STEP"]},"name":{"type":"string","nullable":true}}},"StepIndividualOutput":{"type":"object","properties":{"id":{"type":"integer"},"creator_id":{"type":"integer","nullable":true},"modifier_id":{"type":"integer","nullable":true},"date_created":{"type":"string","format":"date-time","nullable":true},"date_modified":{"type":"string","format":"date-time","nullable":true},"date_completed":{"type":"string","format":"date-time","nullable":true},"due_date":{"type":"string","format":"date-time","nullable":true},"status":{"type":"string","enum":["NOT_STARTED","IN_PROCESS","WAITING","DONE"]},"individual":{"$ref":"#/components/schemas/IndividualOutput"},"manager":{"type":"object","nullable":true,"allOf":[{"$ref":"#/components/schemas/MinimalIndividualOutput"}]},"step":{"$ref":"#/components/schemas/IdWithName"},"workflow":{"type":"object","properties":{"archived":{"type":"boolean"},"id":{"type":"integer"},"name":{"type":"string"},"public":{"type":"boolean"}}},"history":{"type":"array","items":{"$ref":"#/components/schemas/StepIndividualHistoryEntry"}}}},"WorkflowOutput":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"},"public":{"type":"boolean"},"archived":{"type":"boolean"},"campus":{"$ref":"#/components/schemas/IdWithName"},"description":{"type":"string","nullable":true},"instructions":{"type":"string","nullable":true},"steps":{"type":"array","items":{"$ref":"#/components/schemas/IdWithName"}},"managers":{"type":"array","items":{"$ref":"#/components/schemas/IdWithName"}}}},"StepActionInput":{"type":"object","required":["apply_mode","entity_type","type","value"],"properties":{"apply_mode":{"type":"string","enum":["OPTIONAL","REQUIRED","SUGGESTED"]},"entity_type":{"type":"string","enum":["EVENT","GROUP","MAIL_MERGE","POSITION","PROFILE","STEP"]},"filter_ids":{"type":"array","items":{"type":"integer"}},"type":{"type":"string","enum":["ASSIGN","BAPTISM","MEMBERSHIP"]},"value":{"oneOf":[{"type":"integer"},{"type":"string"}]}}},"StepActionInputWithKey":{"type":"object","required":["apply_mode","entity_type","type","value"],"properties":{"apply_mode":{"type":"string","enum":["OPTIONAL","REQUIRED","SUGGESTED"]},"entity_type":{"type":"string","enum":["EVENT","GROUP","MAIL_MERGE","POSITION","PROFILE","STEP"]},"filter_ids":{"type":"array","items":{"type":"integer"}},"id":{"type":"integer","nullable":true,"description":"The ID of an existing action to update. Omit to insert a new action."},"type":{"type":"string","enum":["ASSIGN","BAPTISM","MEMBERSHIP"]},"value":{"oneOf":[{"type":"integer"},{"type":"string"}]}}},"StepActionOutput":{"type":"object","properties":{"apply_mode":{"type":"string","enum":["OPTIONAL","REQUIRED","SUGGESTED"]},"entity":{"$ref":"#/components/schemas/IdWithName"},"entity_type":{"type":"string","enum":["EVENT","GROUP","MAIL_MERGE","POSITION","PROFILE","STEP"]},"filter_ids":{"type":"array","items":{"type":"integer"}},"id":{"type":"integer"},"type":{"type":"string","enum":["ASSIGN","BAPTISM","MEMBERSHIP"]},"value":{"oneOf":[{"type":"integer","nullable":true},{"type":"string","nullable":true}]}}},"StepManagerNotificationInput":{"type":"object","required":["step_individual_ids"],"properties":{"step_individual_ids":{"type":"array","minItems":1,"maxItems":100,"items":{"type":"integer","description":"List of step individual IDs to notify"}},"type":{"type":"string","enum":["EMAIL"],"default":"EMAIL","description":"Type of notification to send"}}},"StepManagerNotificationOutput":{"type":"object","properties":{"notifications_sent":{"type":"integer"},"skipped_step_manager_ids":{"type":"array","items":{"type":"integer"},"description":"IDs of step managers (wf_step_manager) who were not notified because they have no email address on file"}}},"StepActionTypeOutput":{"type":"object","properties":{"type":{"type":"string","enum":["EVENT","GROUP","MAIL_MERGE","POSITION","PROFILE","STEP"]},"status":{"type":"string","enum":["ALLOWED","RESTRICTED"]}}},"AddWorkflowManager":{"type":"object","required":["workflow_manager_id"],"properties":{"workflow_manager_id":{"type":"integer","description":"The ID of the individual to add as a workflow manager"}}},"AddStepIndividualInput":{"type":"object","required":["individual_id"],"properties":{"individual_id":{"type":"integer","description":"The ID of the individual to add to the step"},"wf_step_manager_id":{"type":"integer","nullable":true,"description":"The ID of the step manager to assign to this individual"},"source":{"type":"object","nullable":true,"description":"The source of the addition","properties":{"id":{"type":"integer"},"type":{"type":"string","enum":["AD_HOC","FORM_RESPONSE","PEOPLE_SEARCH","PROFILE","STEP"]}}},"status_id":{"type":"integer","nullable":true,"description":"Initial status (0=WAITING, 1=IN_PROCESS, 2=DONE, 3=NOT_STARTED). Defaults to NOT_STARTED."}}},"CreateStepMessageInput":{"type":"object","required":["subject","body","recipients"],"properties":{"subject":{"type":"string","minLength":1,"maxLength":50,"description":"The message subject"},"body":{"type":"string","maxLength":65535,"description":"The message body"},"recipients":{"type":"array","minItems":1,"description":"The wf_step_individual IDs to send the message to","items":{"type":"integer","description":"A wf_step_individual ID"}}}},"WorkflowTemplateSummaryOutput":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The template UUID"},"name":{"type":"string","description":"The template name"},"description":{"type":"string","description":"The template description"},"step_count":{"type":"integer","description":"The number of steps in the template"},"target_count":{"type":"integer","description":"The number of targets (prompts) the wizard will ask for"},"is_system_defined":{"type":"boolean","description":"Whether the template is Pushpay-provided (system-defined)"},"last_used_date":{"type":"string","format":"date-time","nullable":true,"description":"When the template was last used to create a workflow, or null if never used"},"date_modified":{"type":"string","format":"date-time","nullable":true,"description":"When the template was last modified"}}},"WorkflowTemplateManifestActionOutput":{"type":"object","properties":{"action_ref":{"type":"string","description":"The stable action ID for client-side plan tracking"},"entity_type":{"type":"string","enum":["EVENT","GROUP","MAIL_MERGE","POSITION","PROFILE","STEP"],"description":"The target entity type for this action"},"locked":{"type":"boolean","description":"Whether this action is restricted (locked) for the current user"}}},"WorkflowTemplateManifestStepOutput":{"type":"object","properties":{"step_ref":{"type":"string","description":"The stable step ID for client-side plan tracking"},"actions":{"type":"array","items":{"$ref":"#/components/schemas/WorkflowTemplateManifestActionOutput"},"description":"The promptable actions in this step"}}},"WorkflowTemplateStepActionOutput":{"type":"object","properties":{"action_ref":{"type":"string","description":"The stable action ID for client-side plan tracking"},"type":{"type":"string","enum":["ASSIGN","BAPTISM","MEMBERSHIP"],"description":"The action type"},"apply_mode":{"type":"string","enum":["OPTIONAL","REQUIRED","SUGGESTED"],"description":"The apply mode for this action"},"entity_type":{"type":"string","enum":["EVENT","GROUP","MAIL_MERGE","POSITION","PROFILE","STEP"],"description":"The target entity type for this action"},"target_step_ref":{"type":"string","nullable":true,"description":"For STEP-typed actions, the target step ID; null otherwise"}}},"WorkflowTemplateStepOutput":{"type":"object","properties":{"step_ref":{"type":"string","description":"The stable step ID"},"name":{"type":"string","description":"The step name"},"description":{"type":"string","description":"The step description"},"instructions":{"type":"string","description":"The step instructions"},"due_date_days_later":{"type":"integer","description":"Days after step creation when it's due"},"due_date_type":{"type":"string","enum":["A","MT","MD","Q","R","W"],"description":"The type of due date"},"due_date_weekday":{"type":"string","description":"The weekday for weekly due dates"},"due_date_week_number":{"type":"string","description":"The week number for weekly due dates"},"notify_managers_days":{"type":"integer","description":"Days before due date to notify managers"},"pref_notify_managers_assigned":{"type":"boolean","description":"Whether to notify managers when individuals are assigned"},"pref_notify_managers_unassigned":{"type":"boolean","description":"Whether to notify managers when individuals are unassigned"},"actions":{"type":"array","items":{"$ref":"#/components/schemas/WorkflowTemplateStepActionOutput"},"description":"The actions in this step (all types, including non-promptable)"}}},"WorkflowTemplatePreviewOutput":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The template UUID"},"name":{"type":"string","description":"The template name"},"description":{"type":"string","description":"The template description"},"revision":{"type":"string","format":"date-time","nullable":true,"description":"The template's revision timestamp (sync date)"},"steps":{"type":"array","items":{"$ref":"#/components/schemas/WorkflowTemplateStepOutput"},"description":"The template's step list with actions in display language"},"manifest":{"type":"array","items":{"$ref":"#/components/schemas/WorkflowTemplateManifestStepOutput"},"description":"The step-shaped manifest describing what the wizard will prompt for"}}},"InstantiateWorkflowTemplateInput":{"type":"object","required":["campus_id","name","revision","steps"],"properties":{"campus_id":{"type":"integer","description":"The campus where the workflow will be created"},"name":{"type":"string","minLength":1,"maxLength":50,"description":"The name for the created workflow"},"public":{"type":"boolean","default":true,"description":"Whether the created workflow is public"},"add_me_as_workflow_manager":{"type":"boolean","default":true,"description":"Whether to add the current user as a workflow manager"},"revision":{"type":"string","format":"date-time","description":"The template's revision timestamp (must match current template revision)"},"steps":{"type":"array","minItems":1,"items":{"type":"object","required":["step_ref","actions"],"properties":{"step_ref":{"type":"string","description":"The manifest step reference (step ID from template)"},"managers":{"type":"array","items":{"type":"integer"},"description":"Individual IDs to assign as managers for this step"},"actions":{"type":"array","items":{"type":"object","required":["action_ref"],"properties":{"action_ref":{"type":"string","description":"The manifest action reference (action ID from template)"},"entity_id":{"type":"integer","nullable":true,"description":"The org entity ID to resolve this action to (for resolved actions)"},"blank":{"type":"boolean","description":"Whether this action should be left as Any (unresolved)"}}},"description":"Actions for this step - must specify either entity_id or blank=true, not both"}}},"description":"The steps with their resolved targets and managers"}}}},"parameters":{"IndividualIds":{"description":"The ids of the individuals","name":"individual_ids","in":"query","style":"form","explode":true,"schema":{"type":"array","items":{"type":"integer"}},"required":true},"PerPage":{"name":"per_page","in":"query","description":"The size of a page","schema":{"type":"integer","default":25,"enum":[25,50,75,100]}},"Page":{"name":"page","in":"query","description":"The page number to return","schema":{"type":"integer","default":1}},"UsedByGroupsFilter":{"name":"used_by_groups_filter","in":"query","description":"Filter groups using the entity, such as public or listed","schema":{"type":"string"}},"PerformUnsavedAdvancedSearchRequestDeprecated":{"description":"The individuals advanced search __filters__ can be found [here](/documentation/documents/search_params_individuals.html)\nThe groups advanced search __filters__ can be found [here](/documentation/documents/search_params_groups.html)\n","in":"query","name":"deprecated_unsaved_advanced_search","schema":{"$ref":"#/components/schemas/PerformUnsavedAdvancedSearchRequestDeprecated"},"required":false}},"headers":{"X-Offset":{"description":"The offset from the start of the collection","schema":{"type":"integer"}},"X-Per-Page":{"description":"The number of items per page","schema":{"type":"integer"}},"X-Total-Pages":{"description":"The total number of pages available","schema":{"type":"integer"}},"X-Page":{"description":"The current page number","schema":{"type":"integer"}}},"requestBodies":{"GroupTextMessageRequest":{"description":"The group text message to send","content":{"*/*":{"schema":{"$ref":"#/components/schemas/GroupTextMessageRequestSerializer"}}},"required":false},"UpdateIndividualGroupsRequest":{"description":"The list of group ids to remove the individual from. Each group change request is validated one by one, independently of others, and the response contains each result. For example, the user may be allowed to remove one requested group, but not another — in this case, only the allowed group is removed.","content":{"*/*":{"schema":{"type":"array","items":{"type":"object","properties":{"groupId":{"type":"integer","example":42},"action":{"type":"string","enum":["REMOVE"]}}}}}}},"SavedSearchParams":{"description":"The search parameters","content":{"*/*":{"schema":{"type":"object","properties":{"id":{"type":"integer","description":"ID for the saved search"},"name":{"type":"string","description":"Name of the saved search"},"insight_id":{"type":"string","description":"ID for the insight for this saved search","enum":["individuals:search"]},"is_owner":{"type":"boolean","description":"Whether or not the current user is the owner of the search being saved"},"is_editor":{"type":"boolean","description":"Whether or not the current user is the editor the saved search"},"can_edit":{"type":"boolean","description":"Whether or not the current user can edit the saved search"},"domain":{"type":"string","description":"Domain of where the search exists","enum":["individuals"]},"filters":{"type":"object","properties":{"conditions":{"type":"array","items":{"type":"object","properties":{"conditions":{"type":"object","properties":{"id":{"type":"string"},"include_value":{"type":"object","properties":{"include_value":{"type":"array","items":{"type":"string"}}}},"is_complete":{"type":"boolean"},"is_initialized":{"type":"boolean"},"is_saved":{"type":"boolean"},"operator":{"type":"string"},"type":{"type":"string"},"uid":{"type":"string"},"value":{"type":"string"}}}},"description":"Information for the filters applied"}},"formula":{"type":"string","description":"The formula defines how multiple filter sets should be used in constructing the search."},"operator":{"type":"string","description":"Operator to use for the filter","enum":["contains","does_not_contain","ends_with","equal","greater_than","in","not_in","not_equal","is_not_set","is_set","less_than","greater_than_or_equal","in_the_last","in_the_next","in_the_previous","in_the_current","in_the_upcoming","between","not_between","less_than_or_equal","not_in_the_last","not_in_the_next","not_in_the_previous","not_in_the_current","not_in_the_upcoming","starts_with"]},"type":{"type":"string","description":"Determines whether the filter is a single filter or a group of filters","enum":["group","single"]}},"description":"Information related to the search conditions"},"columns":{"type":"object","properties":{"age":{"type":"object","properties":{"index":{"type":"integer"},"visible":{"type":"boolean"}}},"allergies":{"type":"object","properties":{"index":{"type":"integer"},"visible":{"type":"boolean"}}},"anniversary":{"type":"object","properties":{"index":{"type":"integer"},"visible":{"type":"boolean"}}},"avatar":{"type":"object","properties":{"index":{"type":"integer"},"visible":{"type":"boolean"}}},"baptized":{"type":"object","properties":{"index":{"type":"integer"},"visible":{"type":"boolean"}},"description":"If you are using the Sacraments feature, then the Sacraments API would be more effective and up-to-date alternative for surfacing baptism data"},"baptized_date":{"type":"object","properties":{"index":{"type":"integer"},"visible":{"type":"boolean"}},"description":"If you are using the Sacraments feature, then the Sacraments API would be more effective and up-to-date alternative for surfacing baptism data"},"baptized_note":{"type":"object","properties":{"index":{"type":"integer"},"visible":{"type":"boolean"}},"description":"If you are using the Sacraments feature, then the Sacraments API would be more effective and up-to-date alternative for surfacing baptism data"},"barcode":{"type":"object","properties":{"index":{"type":"integer"},"visible":{"type":"boolean"}}},"birthday":{"type":"object","properties":{"index":{"type":"integer"},"visible":{"type":"boolean"}}},"campus_name":{"type":"object","properties":{"index":{"type":"integer"},"visible":{"type":"boolean"}}},"commitment_date":{"type":"object","properties":{"index":{"type":"integer"},"visible":{"type":"boolean"}}},"commitment_story":{"type":"object","properties":{"index":{"type":"integer"},"visible":{"type":"boolean"}}},"created":{"type":"object","properties":{"index":{"type":"integer"},"visible":{"type":"boolean"}}},"current_story":{"type":"object","properties":{"index":{"type":"integer"},"visible":{"type":"boolean"}}},"date_anyone_run_giving_statement":{"type":"object","properties":{"index":{"type":"integer"},"visible":{"type":"boolean"}}},"date_child_work_start":{"type":"object","properties":{"index":{"type":"integer"},"visible":{"type":"boolean"}}},"date_child_work_stop":{"type":"object","properties":{"index":{"type":"integer"},"visible":{"type":"boolean"}}},"date_family_run_giving_statement":{"type":"object","properties":{"index":{"type":"integer"},"visible":{"type":"boolean"}}},"deceased":{"type":"object","properties":{"index":{"type":"integer"},"visible":{"type":"boolean"}}},"email":{"type":"object","properties":{"index":{"type":"integer"},"visible":{"type":"boolean"}}},"emergency_contact_name":{"type":"object","properties":{"index":{"type":"integer"},"visible":{"type":"boolean"}}},"emergency_phone_number":{"type":"object","properties":{"index":{"type":"integer"},"visible":{"type":"boolean"}}},"family_id":{"type":"object","properties":{"index":{"type":"integer"},"visible":{"type":"boolean"}}},"family_position":{"type":"object","properties":{"index":{"type":"integer"},"visible":{"type":"boolean"}}},"fax_phone_number":{"type":"object","properties":{"index":{"type":"integer"},"visible":{"type":"boolean"}}},"floating_action_button":{"type":"object","properties":{"index":{"type":"integer"},"visible":{"type":"boolean"}}},"gender":{"type":"object","properties":{"index":{"type":"integer"},"visible":{"type":"boolean"}}},"giving_number":{"type":"object","properties":{"index":{"type":"integer"},"visible":{"type":"boolean"}}},"home_city":{"type":"object","properties":{"index":{"type":"integer"},"visible":{"type":"boolean"}}},"home_country_iso":{"type":"object","properties":{"index":{"type":"integer"},"visible":{"type":"boolean"}}},"home_phone_number":{"type":"object","properties":{"index":{"type":"integer"},"visible":{"type":"boolean"}}},"home_state":{"type":"object","properties":{"index":{"type":"integer"},"visible":{"type":"boolean"}}},"home_street":{"type":"object","properties":{"index":{"type":"integer"},"visible":{"type":"boolean"}}},"home_zip":{"type":"object","properties":{"index":{"type":"integer"},"visible":{"type":"boolean"}}},"how_they_heard":{"type":"object","properties":{"index":{"type":"integer"},"visible":{"type":"boolean"}}},"how_they_joined":{"type":"object","properties":{"index":{"type":"integer"},"visible":{"type":"boolean"}}},"id":{"type":"object","properties":{"index":{"type":"integer"},"visible":{"type":"boolean"}}},"last_attended_date":{"type":"object","properties":{"index":{"type":"integer"},"visible":{"type":"boolean"}}},"last_giving_date":{"type":"object","properties":{"index":{"type":"integer"},"visible":{"type":"boolean"}}},"last_login":{"type":"object","properties":{"index":{"type":"integer"},"visible":{"type":"boolean"}}},"legal_first_name":{"type":"object","properties":{"index":{"type":"integer"},"visible":{"type":"boolean"}}},"mailing_carrier_route":{"type":"object","properties":{"index":{"type":"integer"},"visible":{"type":"boolean"}}},"mailing_city":{"type":"object","properties":{"index":{"type":"integer"},"visible":{"type":"boolean"}}},"mailing_country_iso":{"type":"object","properties":{"index":{"type":"integer"},"visible":{"type":"boolean"}}},"mailing_state":{"type":"object","properties":{"index":{"type":"integer"},"visible":{"type":"boolean"}}},"mailing_zip":{"type":"object","properties":{"index":{"type":"integer"},"visible":{"type":"boolean"}}},"marital_status":{"type":"object","properties":{"index":{"type":"integer"},"visible":{"type":"boolean"}}},"membership_date":{"type":"object","properties":{"index":{"type":"integer"},"visible":{"type":"boolean"}}},"membership_date_stop":{"type":"object","properties":{"index":{"type":"integer"},"visible":{"type":"boolean"}}},"membership_type_name":{"type":"object","properties":{"index":{"type":"integer"},"visible":{"type":"boolean"}}},"middle_name":{"type":"object","properties":{"index":{"type":"integer"},"visible":{"type":"boolean"}}},"military":{"type":"object","properties":{"index":{"type":"integer"},"visible":{"type":"boolean"}}},"mobile_carrier":{"type":"object","properties":{"index":{"type":"integer"},"visible":{"type":"boolean"}}},"mobile_phone_number":{"type":"object","properties":{"index":{"type":"integer"},"visible":{"type":"boolean"}}},"modified":{"type":"object","properties":{"index":{"type":"integer"},"visible":{"type":"boolean"}}},"name":{"type":"object","properties":{"index":{"type":"integer"},"visible":{"type":"boolean"}}},"name_prefix":{"type":"object","properties":{"index":{"type":"integer"},"visible":{"type":"boolean"}}},"name_suffix":{"type":"object","properties":{"index":{"type":"integer"},"visible":{"type":"boolean"}}},"other_city":{"type":"object","properties":{"index":{"type":"integer"},"visible":{"type":"boolean"}}},"other_country_iso":{"type":"object","properties":{"index":{"type":"integer"},"visible":{"type":"boolean"}}},"other_state":{"type":"object","properties":{"index":{"type":"integer"},"visible":{"type":"boolean"}}},"other_zip":{"type":"object","properties":{"index":{"type":"integer"},"visible":{"type":"boolean"}}},"preferred_number":{"type":"object","properties":{"index":{"type":"integer"},"visible":{"type":"boolean"}}},"school_grade":{"type":"object","properties":{"index":{"type":"integer"},"visible":{"type":"boolean"}}},"work_city":{"type":"object","properties":{"index":{"type":"integer"},"visible":{"type":"boolean"}}},"work_country_iso":{"type":"object","properties":{"index":{"type":"integer"},"visible":{"type":"boolean"}}},"work_phone_number":{"type":"object","properties":{"index":{"type":"integer"},"visible":{"type":"boolean"}}},"work_state":{"type":"object","properties":{"index":{"type":"integer"},"visible":{"type":"boolean"}}},"work_title":{"type":"object","properties":{"index":{"type":"integer"},"visible":{"type":"boolean"}}},"work_zip":{"type":"object","properties":{"index":{"type":"integer"},"visible":{"type":"boolean"}}}},"description":"Information related to the columns visible on the search Page"},"settings":{"type":"object","properties":{"exclude_children":{"type":"boolean"},"filter_profile_type":{"type":"array","items":{"type":"string","enum":["active","inactive","deceased"]}},"group_by":{"type":"array","items":{"type":"string"}},"include_campuses":{"type":"array","items":{"type":"integer"}},"include_unlisted":{"type":"boolean"},"only_search_when_filtered":{"type":"boolean"},"order_by":{"type":"array","items":{"type":"object","properties":{"column":{"type":"string"},"direction":{"type":"string"}}}},"return_family_positions":{"type":"array","items":{"type":"string"}},"return_search_results":{"type":"boolean"}},"description":"Information related to settings for the search configuration"}}}}},"required":false},"UpdateTemplateRequest":{"description":"The updated template properties","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"template_sharing_level":{"$ref":"#/components/schemas/TemplateSharingLevel"},"shared_campus_ids":{"type":"array","items":{"type":"integer"}}}}}}},"CreateTemplateRequest":{"description":"Create a new template","content":{"application/json":{"schema":{"type":"object","properties":{"campus_id":{"type":"integer"},"description":{"type":"string"},"entity_type":{"$ref":"#/components/schemas/TemplateEntityType"},"name":{"type":"string"},"originating_entity_id":{"type":"integer"},"shared_campus_ids":{"type":"array","items":{"type":"integer"}},"sharing_level":{"$ref":"#/components/schemas/TemplateSharingLevel"}}}}}},"UseTemplateRequest":{"description":"Create a new form or mail merge using a template.","content":{"application/json":{"schema":{"type":"object","properties":{"title":{"type":"string"},"campus_id":{"type":"integer"}}}}}}}}}