{ "openapi": "3.0.3", "info": { "title": "Raklet API", "version": "v1 (spec 1.0.0)", "description": "Raklet is an all-in-one membership management and community platform for associations, nonprofits, clubs, chambers and alumni organizations. This API lets you manage an organization's contacts and members, membership plans and payments, events, tags, donations and settings programmatically.\n\n## Authentication\n\nEvery endpoint except `POST /token` requires a bearer token. Obtain one with the OAuth 2.0 password grant, using the email and password of a Raklet admin user:\n\n```\ncurl -X POST https://api.raklet.com/token \\\n -H \"Content-Type: application/x-www-form-urlencoded\" \\\n -d \"grant_type=password&username=admin@example.org&password=...\"\n```\n\nThen send `Authorization: Bearer ` on every request. Tokens expire after about one hour; request a new one the same way. The token carries the admin user's own permissions: it can do exactly what that user can do in the Raklet admin panel for the organizations they administer, and nothing more. There are no narrower OAuth scopes today.\n\n## Finding your organisation id\n\nMost paths take `{organisationId}`. Find it in the Raklet admin panel under Settings, or call `GET /public/account/me` with your token.\n\n## Plans and access\n\nAPI access is included in the Premium plan (see https://www.raklet.com/pricing/). A free organization (up to 100 contacts) is the recommended sandbox for development.\n\n## Conventions\n\n- Base URL: `https://api.raklet.com`\n- Request and response bodies are JSON unless an operation says otherwise.\n- List endpoints accept `pageSize` and `offset`; filtered lists accept `q`, a base64-encoded JSON query (see https://help.raklet.com/en/articles/5998452-how-to-search-organisation-contacts).\n- Most responses wrap their payload in `{ \"data\": ..., \"isValid\": true, \"errors\": [] }`.\n\n## More\n\n- Developer portal: https://www.raklet.com/developers/\n- Interactive reference (Swagger UI): https://api.raklet.com/swagger/ui/index/\n- Help center API collection: https://help.raklet.com/en/collections/13838830-api\n", "termsOfService": "https://www.raklet.com/legal/", "contact": { "name": "Raklet support", "url": "https://www.raklet.com/contact/" }, "x-logo": { "url": "https://www.raklet.com/wp-content/uploads/2020/05/raklet.png", "altText": "Raklet" }, "x-summary": "Membership management, CRM, events, payments and community for member-based organizations." }, "externalDocs": { "description": "Raklet developer portal", "url": "https://www.raklet.com/developers/" }, "servers": [ { "url": "https://api.raklet.com", "description": "Production" } ], "security": [ { "bearerAuth": [] } ], "tags": [ { "name": "Auth", "description": "Authentication" }, { "name": "ActionLogs", "description": "Action logs" }, { "name": "AdminApplications", "description": "Membership applications (admin)" }, { "name": "AdminDebts", "description": "Debts (admin)" }, { "name": "AdminDonations", "description": "Donations (admin)" }, { "name": "AdminPayments", "description": "Payments (admin)" }, { "name": "AdminPlans", "description": "Membership plans (admin)" }, { "name": "AdminTag", "description": "Tags (admin)" }, { "name": "ApiAccount", "description": "Account" }, { "name": "Boards", "description": "Boards" }, { "name": "Cities", "description": "Cities" }, { "name": "Companies", "description": "Companies" }, { "name": "Contact", "description": "Contact" }, { "name": "ContactAddress", "description": "Contact addresses" }, { "name": "ContactEducation", "description": "Contact education history" }, { "name": "ContactEmail", "description": "Contact emails" }, { "name": "ContactPhone", "description": "Contact phones" }, { "name": "ContactWork", "description": "Contact work history" }, { "name": "CorporateMembers", "description": "Corporate members" }, { "name": "Countries", "description": "Countries" }, { "name": "CreditCard", "description": "Credit cards" }, { "name": "DonationCampaigns", "description": "Donation campaigns" }, { "name": "Donations", "description": "Donations" }, { "name": "Events", "description": "Events" }, { "name": "JobPostings", "description": "Job postings" }, { "name": "JobSeekers", "description": "Job seekers" }, { "name": "MemberEventSubmissions", "description": "Member event submissions" }, { "name": "MembershipFees", "description": "Membership fees" }, { "name": "OrganisationSettings", "description": "Organisation settings" }, { "name": "Page", "description": "Page" }, { "name": "PaymentTickets", "description": "Payment tickets" }, { "name": "Payments", "description": "Payments" }, { "name": "Posts", "description": "Posts" }, { "name": "Schools", "description": "Schools" }, { "name": "Search", "description": "Search" }, { "name": "Sectors", "description": "Sectors" }, { "name": "SelectList", "description": "Select lists" }, { "name": "Settings", "description": "Settings" }, { "name": "Subscription", "description": "Subscription" }, { "name": "Tags", "description": "Tags" } ], "paths": { "/token": { "post": { "tags": [ "Auth" ], "operationId": "Auth_GetAccessToken", "summary": "Get an access token (OAuth 2.0 password grant)", "description": "Exchange a Raklet admin user's email and password for a bearer token. Send the fields as application/x-www-form-urlencoded with grant_type=password. The response is `{\"access_token\": \"...\", \"token_type\": \"bearer\", \"expires_in\": 3600}`; put the access_token in an `Authorization: Bearer` header on every other request. Tokens expire after about an hour and can be re-requested at any time.", "requestBody": { "required": true, "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "required": [ "grant_type", "username", "password" ], "properties": { "grant_type": { "type": "string", "enum": [ "password" ], "default": "password", "description": "Always `password`." }, "username": { "type": "string", "format": "email", "description": "Email address of a Raklet admin user." }, "password": { "type": "string", "format": "password", "description": "That user's Raklet password." } } } } } }, "responses": { "200": { "description": "A bearer token.", "content": { "application/json": { "schema": { "type": "object", "required": [ "access_token", "token_type", "expires_in" ], "properties": { "access_token": { "type": "string" }, "token_type": { "type": "string", "enum": [ "bearer" ] }, "expires_in": { "type": "integer", "description": "Lifetime in seconds." }, "userName": { "type": "string" } } } } } }, "400": { "description": "invalid_grant: the credentials were not accepted." } }, "security": [], "x-raklet-access": "No token required" } }, "/app/actionlogs": { "get": { "tags": [ "ActionLogs" ], "operationId": "ActionLogs_GetActionLogs", "summary": "List actionlogs", "description": "List actionlogs. App-scoped endpoint under `app/`. Belongs to the Action logs group. HTTP GET /app/actionlogs.", "parameters": [ { "name": "pageSize", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "requestContinuation", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "actionKeys", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "organisationMembershipId", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid" } }, { "name": "startDate", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "endDate", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RakletListResponse_ActionLogApiDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RakletListResponse_ActionLogApiDto" } } } }, "401": { "description": "Missing or expired bearer token." }, "403": { "description": "The token's user cannot access this organisation or resource." } }, "security": [ { "bearerAuth": [] }, { "oauth2Password": [] } ], "x-raklet-access": "Premium plan (API access); token inherits the admin user's role permissions" } }, "/organisations/{organisationId}/applications": { "get": { "tags": [ "AdminApplications" ], "operationId": "AdminApplications_GetApplications", "summary": "List applications", "description": "List applications for an organisation. Belongs to the Membership applications (admin) group. HTTP GET /organisations/{organisationId}/applications.", "parameters": [ { "name": "organisationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "pageSize", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "searchText", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RakletListResponse_Dictionary_String" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RakletListResponse_Dictionary_String" } } } }, "401": { "description": "Missing or expired bearer token." }, "403": { "description": "The token's user cannot access this organisation or resource." } }, "security": [ { "bearerAuth": [] }, { "oauth2Password": [] } ], "x-raklet-access": "Premium plan (API access); token inherits the admin user's role permissions" } }, "/organisations/{organisationId}/debts": { "get": { "tags": [ "AdminDebts" ], "operationId": "AdminDebts_GetDebts", "summary": "List debts", "description": "List debts for an organisation. Belongs to the Debts (admin) group. HTTP GET /organisations/{organisationId}/debts.", "parameters": [ { "name": "organisationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DebtDto" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DebtDto" } } } } }, "401": { "description": "Missing or expired bearer token." }, "403": { "description": "The token's user cannot access this organisation or resource." } }, "security": [ { "bearerAuth": [] }, { "oauth2Password": [] } ], "x-raklet-access": "Premium plan (API access); token inherits the admin user's role permissions" }, "post": { "tags": [ "AdminDebts" ], "operationId": "AdminDebts_PostDebts", "summary": "Create debt", "description": "Create debt for an organisation. Belongs to the Debts (admin) group. HTTP POST /organisations/{organisationId}/debts.", "parameters": [ { "name": "organisationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DebtPostDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DebtPostDto" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DebtDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DebtDto" } } } }, "401": { "description": "Missing or expired bearer token." }, "403": { "description": "The token's user cannot access this organisation or resource." } }, "security": [ { "bearerAuth": [] }, { "oauth2Password": [] } ], "x-raklet-access": "Premium plan (API access); token inherits the admin user's role permissions" } }, "/organisations/{organisationId}/debts/{id}": { "get": { "tags": [ "AdminDebts" ], "operationId": "AdminDebts_GetDebt", "summary": "Get debt", "description": "Get debt for an organisation. Belongs to the Debts (admin) group. HTTP GET /organisations/{organisationId}/debts/{id}.", "parameters": [ { "name": "organisationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DebtDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DebtDto" } } } }, "401": { "description": "Missing or expired bearer token." }, "403": { "description": "The token's user cannot access this organisation or resource." } }, "security": [ { "bearerAuth": [] }, { "oauth2Password": [] } ], "x-raklet-access": "Premium plan (API access); token inherits the admin user's role permissions" }, "put": { "tags": [ "AdminDebts" ], "operationId": "AdminDebts_PutDebts", "summary": "Update debt", "description": "Update debt for an organisation. Belongs to the Debts (admin) group. HTTP PUT /organisations/{organisationId}/debts/{id}.", "parameters": [ { "name": "organisationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DebtPostDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DebtPostDto" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } }, "text/json": { "schema": { "type": "object" } } } }, "401": { "description": "Missing or expired bearer token." }, "403": { "description": "The token's user cannot access this organisation or resource." } }, "security": [ { "bearerAuth": [] }, { "oauth2Password": [] } ], "x-raklet-access": "Premium plan (API access); token inherits the admin user's role permissions" }, "delete": { "tags": [ "AdminDebts" ], "operationId": "AdminDebts_DeleteDebts", "summary": "Delete debt", "description": "Delete debt for an organisation. Belongs to the Debts (admin) group. HTTP DELETE /organisations/{organisationId}/debts/{id}.", "parameters": [ { "name": "organisationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } }, "text/json": { "schema": { "type": "object" } } } }, "401": { "description": "Missing or expired bearer token." }, "403": { "description": "The token's user cannot access this organisation or resource." } }, "security": [ { "bearerAuth": [] }, { "oauth2Password": [] } ], "x-raklet-access": "Premium plan (API access); token inherits the admin user's role permissions" } }, "/organisations/{organisationId}/donations": { "get": { "tags": [ "AdminDonations" ], "operationId": "AdminDonations_GetDonations", "summary": "List donations", "description": "List donations for an organisation. Belongs to the Donations (admin) group. HTTP GET /organisations/{organisationId}/donations.", "parameters": [ { "name": "organisationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DonationDto" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DonationDto" } } } } }, "401": { "description": "Missing or expired bearer token." }, "403": { "description": "The token's user cannot access this organisation or resource." } }, "security": [ { "bearerAuth": [] }, { "oauth2Password": [] } ], "x-raklet-access": "Premium plan (API access); token inherits the admin user's role permissions" }, "post": { "tags": [ "AdminDonations" ], "operationId": "AdminDonations_PostDonations", "summary": "Create donation", "description": "Create donation for an organisation. Belongs to the Donations (admin) group. HTTP POST /organisations/{organisationId}/donations.", "parameters": [ { "name": "organisationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DonationPostDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DonationPostDto" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DonationDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DonationDto" } } } }, "401": { "description": "Missing or expired bearer token." }, "403": { "description": "The token's user cannot access this organisation or resource." } }, "security": [ { "bearerAuth": [] }, { "oauth2Password": [] } ], "x-raklet-access": "Premium plan (API access); token inherits the admin user's role permissions" } }, "/organisations/{organisationId}/donations/{id}": { "get": { "tags": [ "AdminDonations" ], "operationId": "AdminDonations_GetDonation", "summary": "Get donation", "description": "Get donation for an organisation. Belongs to the Donations (admin) group. HTTP GET /organisations/{organisationId}/donations/{id}.", "parameters": [ { "name": "organisationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DonationDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DonationDto" } } } }, "401": { "description": "Missing or expired bearer token." }, "403": { "description": "The token's user cannot access this organisation or resource." } }, "security": [ { "bearerAuth": [] }, { "oauth2Password": [] } ], "x-raklet-access": "Premium plan (API access); token inherits the admin user's role permissions" }, "put": { "tags": [ "AdminDonations" ], "operationId": "AdminDonations_PutDonations", "summary": "Update donation", "description": "Update donation for an organisation. Belongs to the Donations (admin) group. HTTP PUT /organisations/{organisationId}/donations/{id}.", "parameters": [ { "name": "organisationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DonationPostDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DonationPostDto" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } }, "text/json": { "schema": { "type": "object" } } } }, "401": { "description": "Missing or expired bearer token." }, "403": { "description": "The token's user cannot access this organisation or resource." } }, "security": [ { "bearerAuth": [] }, { "oauth2Password": [] } ], "x-raklet-access": "Premium plan (API access); token inherits the admin user's role permissions" }, "delete": { "tags": [ "AdminDonations" ], "operationId": "AdminDonations_DeleteDonations", "summary": "Delete donation", "description": "Delete donation for an organisation. Belongs to the Donations (admin) group. HTTP DELETE /organisations/{organisationId}/donations/{id}.", "parameters": [ { "name": "organisationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } }, "text/json": { "schema": { "type": "object" } } } }, "401": { "description": "Missing or expired bearer token." }, "403": { "description": "The token's user cannot access this organisation or resource." } }, "security": [ { "bearerAuth": [] }, { "oauth2Password": [] } ], "x-raklet-access": "Premium plan (API access); token inherits the admin user's role permissions" } }, "/organisations/{organisationId}/payments": { "get": { "tags": [ "AdminPayments" ], "operationId": "AdminPayments_GetPayments", "summary": "List payments", "description": "List payments for an organisation. Belongs to the Payments (admin) group. HTTP GET /organisations/{organisationId}/payments.", "parameters": [ { "name": "organisationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AdminPaymentsController_AdminPaymentDto" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AdminPaymentsController_AdminPaymentDto" } } } } }, "401": { "description": "Missing or expired bearer token." }, "403": { "description": "The token's user cannot access this organisation or resource." } }, "security": [ { "bearerAuth": [] }, { "oauth2Password": [] } ], "x-raklet-access": "Premium plan (API access); token inherits the admin user's role permissions" }, "post": { "tags": [ "AdminPayments" ], "operationId": "AdminPayments_PostPayments", "summary": "Create payment", "description": "Create payment for an organisation. Belongs to the Payments (admin) group. HTTP POST /organisations/{organisationId}/payments.", "parameters": [ { "name": "organisationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdminPaymentsController_AdminPaymentPostDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AdminPaymentsController_AdminPaymentPostDto" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdminPaymentsController_AdminPaymentDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AdminPaymentsController_AdminPaymentDto" } } } }, "401": { "description": "Missing or expired bearer token." }, "403": { "description": "The token's user cannot access this organisation or resource." } }, "security": [ { "bearerAuth": [] }, { "oauth2Password": [] } ], "x-raklet-access": "Premium plan (API access); token inherits the admin user's role permissions" } }, "/organisations/{organisationId}/payments/{id}": { "get": { "tags": [ "AdminPayments" ], "operationId": "AdminPayments_GetAdminPayment", "summary": "Get payment", "description": "Get payment for an organisation. Belongs to the Payments (admin) group. HTTP GET /organisations/{organisationId}/payments/{id}.", "parameters": [ { "name": "organisationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdminPaymentsController_AdminPaymentDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AdminPaymentsController_AdminPaymentDto" } } } }, "401": { "description": "Missing or expired bearer token." }, "403": { "description": "The token's user cannot access this organisation or resource." } }, "security": [ { "bearerAuth": [] }, { "oauth2Password": [] } ], "x-raklet-access": "Premium plan (API access); token inherits the admin user's role permissions" }, "put": { "tags": [ "AdminPayments" ], "operationId": "AdminPayments_PutPayments", "summary": "Update payment", "description": "Update payment for an organisation. Belongs to the Payments (admin) group. HTTP PUT /organisations/{organisationId}/payments/{id}.", "parameters": [ { "name": "organisationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdminPaymentsController_AdminPaymentPostDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AdminPaymentsController_AdminPaymentPostDto" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } }, "text/json": { "schema": { "type": "object" } } } }, "401": { "description": "Missing or expired bearer token." }, "403": { "description": "The token's user cannot access this organisation or resource." } }, "security": [ { "bearerAuth": [] }, { "oauth2Password": [] } ], "x-raklet-access": "Premium plan (API access); token inherits the admin user's role permissions" }, "delete": { "tags": [ "AdminPayments" ], "operationId": "AdminPayments_DeletePayments", "summary": "Delete payment", "description": "Delete payment for an organisation. Belongs to the Payments (admin) group. HTTP DELETE /organisations/{organisationId}/payments/{id}.", "parameters": [ { "name": "organisationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdminPaymentsController_AdminPaymentDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AdminPaymentsController_AdminPaymentDto" } } } }, "401": { "description": "Missing or expired bearer token." }, "403": { "description": "The token's user cannot access this organisation or resource." } }, "security": [ { "bearerAuth": [] }, { "oauth2Password": [] } ], "x-raklet-access": "Premium plan (API access); token inherits the admin user's role permissions" } }, "/organisations/{organisationId}/plans": { "get": { "tags": [ "AdminPlans" ], "operationId": "AdminPlans_GetPlans", "summary": "List plans", "description": "List plans for an organisation. Belongs to the Membership plans (admin) group. HTTP GET /organisations/{organisationId}/plans.", "parameters": [ { "name": "organisationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RakletListResponse_CustomPlanDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RakletListResponse_CustomPlanDto" } } } }, "401": { "description": "Missing or expired bearer token." }, "403": { "description": "The token's user cannot access this organisation or resource." } }, "security": [ { "bearerAuth": [] }, { "oauth2Password": [] } ], "x-raklet-access": "Premium plan (API access); token inherits the admin user's role permissions" } }, "/organisations/{organisationId}/plans/{id}": { "get": { "tags": [ "AdminPlans" ], "operationId": "AdminPlans_GetPlan", "summary": "Get plan", "description": "Get plan for an organisation. Belongs to the Membership plans (admin) group. HTTP GET /organisations/{organisationId}/plans/{id}.", "parameters": [ { "name": "organisationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RakletActionResponse_CustomPlanDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RakletActionResponse_CustomPlanDto" } } } }, "401": { "description": "Missing or expired bearer token." }, "403": { "description": "The token's user cannot access this organisation or resource." } }, "security": [ { "bearerAuth": [] }, { "oauth2Password": [] } ], "x-raklet-access": "Premium plan (API access); token inherits the admin user's role permissions" } }, "/admin/organisations/{organisationId}/tags": { "get": { "tags": [ "AdminTag" ], "operationId": "AdminTag_GetTags", "summary": "List tags", "description": "List tags for an organisation. Admin-scoped endpoint under `admin/`. Belongs to the Tags (admin) group. HTTP GET /admin/organisations/{organisationId}/tags.", "parameters": [ { "name": "organisationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "text", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AdminTagController_AdminTagDto" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AdminTagController_AdminTagDto" } } } } }, "401": { "description": "Missing or expired bearer token." }, "403": { "description": "The token's user cannot access this organisation or resource." } }, "security": [ { "bearerAuth": [] }, { "oauth2Password": [] } ], "x-raklet-access": "Premium plan (API access); token inherits the admin user's role permissions" }, "post": { "tags": [ "AdminTag" ], "operationId": "AdminTag_PostTag", "summary": "Create tag", "description": "Create tag for an organisation. Admin-scoped endpoint under `admin/`. Belongs to the Tags (admin) group. HTTP POST /admin/organisations/{organisationId}/tags.", "parameters": [ { "name": "organisationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdminTagController_AdminPostTagDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AdminTagController_AdminPostTagDto" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdminTagController_AdminPostTagDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AdminTagController_AdminPostTagDto" } } } }, "401": { "description": "Missing or expired bearer token." }, "403": { "description": "The token's user cannot access this organisation or resource." } }, "security": [ { "bearerAuth": [] }, { "oauth2Password": [] } ], "x-raklet-access": "Premium plan (API access); token inherits the admin user's role permissions" } }, "/admin/organisations/{organisationId}/tags/{id}": { "get": { "tags": [ "AdminTag" ], "operationId": "AdminTag_GetTag", "summary": "Get tag", "description": "Get tag for an organisation. Admin-scoped endpoint under `admin/`. Belongs to the Tags (admin) group. HTTP GET /admin/organisations/{organisationId}/tags/{id}.", "parameters": [ { "name": "organisationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdminTagController_AdminTagDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AdminTagController_AdminTagDto" } } } }, "401": { "description": "Missing or expired bearer token." }, "403": { "description": "The token's user cannot access this organisation or resource." } }, "security": [ { "bearerAuth": [] }, { "oauth2Password": [] } ], "x-raklet-access": "Premium plan (API access); token inherits the admin user's role permissions" }, "put": { "tags": [ "AdminTag" ], "operationId": "AdminTag_PutTag", "summary": "Update tag", "description": "Update tag for an organisation. Admin-scoped endpoint under `admin/`. Belongs to the Tags (admin) group. HTTP PUT /admin/organisations/{organisationId}/tags/{id}.", "parameters": [ { "name": "organisationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdminTagController_AdminPostTagDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AdminTagController_AdminPostTagDto" } } } }, "responses": { "204": { "description": "No Content" }, "401": { "description": "Missing or expired bearer token." }, "403": { "description": "The token's user cannot access this organisation or resource." } }, "security": [ { "bearerAuth": [] }, { "oauth2Password": [] } ], "x-raklet-access": "Premium plan (API access); token inherits the admin user's role permissions" }, "delete": { "tags": [ "AdminTag" ], "operationId": "AdminTag_DeleteTag", "summary": "Delete tag", "description": "Delete tag for an organisation. Admin-scoped endpoint under `admin/`. Belongs to the Tags (admin) group. HTTP DELETE /admin/organisations/{organisationId}/tags/{id}.", "parameters": [ { "name": "organisationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdminTagController_AdminTagDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AdminTagController_AdminTagDto" } } } }, "401": { "description": "Missing or expired bearer token." }, "403": { "description": "The token's user cannot access this organisation or resource." } }, "security": [ { "bearerAuth": [] }, { "oauth2Password": [] } ], "x-raklet-access": "Premium plan (API access); token inherits the admin user's role permissions" } }, "/admin/organisations/{organisationId}/tags/{id}/AddMembers": { "post": { "tags": [ "AdminTag" ], "operationId": "AdminTag_PostAddMembersTag", "summary": "Add Members", "description": "Add Members for an organisation. Admin-scoped endpoint under `admin/`. Belongs to the Tags (admin) group. HTTP POST /admin/organisations/{organisationId}/tags/{id}/AddMembers.", "parameters": [ { "name": "organisationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdminTagController_AdminPostTagMemberListDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AdminTagController_AdminPostTagMemberListDto" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdminTagController_AdminPostTagMemberListDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AdminTagController_AdminPostTagMemberListDto" } } } }, "401": { "description": "Missing or expired bearer token." }, "403": { "description": "The token's user cannot access this organisation or resource." } }, "security": [ { "bearerAuth": [] }, { "oauth2Password": [] } ], "x-raklet-access": "Premium plan (API access); token inherits the admin user's role permissions" } }, "/admin/organisations/{organisationId}/tags/{id}/RemoveMembers": { "post": { "tags": [ "AdminTag" ], "operationId": "AdminTag_PostRemoveMembersTag", "summary": "Remove Members", "description": "Remove Members for an organisation. Admin-scoped endpoint under `admin/`. Belongs to the Tags (admin) group. HTTP POST /admin/organisations/{organisationId}/tags/{id}/RemoveMembers.", "parameters": [ { "name": "organisationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdminTagController_AdminPostTagMemberListDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AdminTagController_AdminPostTagMemberListDto" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdminTagController_AdminPostTagMemberListDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AdminTagController_AdminPostTagMemberListDto" } } } }, "401": { "description": "Missing or expired bearer token." }, "403": { "description": "The token's user cannot access this organisation or resource." } }, "security": [ { "bearerAuth": [] }, { "oauth2Password": [] } ], "x-raklet-access": "Premium plan (API access); token inherits the admin user's role permissions" } }, "/admin/organisations/{organisationId}/tags/{id}/members": { "get": { "tags": [ "AdminTag" ], "operationId": "AdminTag_GetTagMembers", "summary": "List members", "description": "List members for an organisation. Admin-scoped endpoint under `admin/`. Belongs to the Tags (admin) group. HTTP GET /admin/organisations/{organisationId}/tags/{id}/members.", "parameters": [ { "name": "organisationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdminTagController_AdminTagMembersDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AdminTagController_AdminTagMembersDto" } } } }, "401": { "description": "Missing or expired bearer token." }, "403": { "description": "The token's user cannot access this organisation or resource." } }, "security": [ { "bearerAuth": [] }, { "oauth2Password": [] } ], "x-raklet-access": "Premium plan (API access); token inherits the admin user's role permissions" } }, "/public/account/auth": { "post": { "tags": [ "ApiAccount" ], "operationId": "ApiAccount_Auth", "summary": "Create auth", "description": "Create auth. Public-scoped endpoint under `public/`. Belongs to the Account group. HTTP POST /public/account/auth.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AuthModel" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } }, "text/json": { "schema": { "type": "object" } } } }, "401": { "description": "Missing or expired bearer token." }, "403": { "description": "The token's user cannot access this organisation or resource." } }, "security": [ { "bearerAuth": [] }, { "oauth2Password": [] } ], "x-raklet-access": "Premium plan (API access); token inherits the admin user's role permissions" } }, "/public/account/me": { "get": { "tags": [ "ApiAccount" ], "operationId": "ApiAccount_Me", "summary": "Get me", "description": "Get me. Public-scoped endpoint under `public/`. Belongs to the Account group. HTTP GET /public/account/me.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } }, "text/json": { "schema": { "type": "object" } } } }, "401": { "description": "Missing or expired bearer token." }, "403": { "description": "The token's user cannot access this organisation or resource." } }, "security": [ { "bearerAuth": [] }, { "oauth2Password": [] } ], "x-raklet-access": "Premium plan (API access); token inherits the admin user's role permissions" } }, "/organisations/{organisationId}/boards": { "get": { "tags": [ "Boards" ], "operationId": "Boards_GetList", "summary": "List boards", "description": "List boards for an organisation. Belongs to the Boards group. HTTP GET /organisations/{organisationId}/boards.", "parameters": [ { "name": "organisationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "s", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } }, "text/json": { "schema": { "type": "object" } } } }, "401": { "description": "Missing or expired bearer token." }, "403": { "description": "The token's user cannot access this organisation or resource." } }, "security": [ { "bearerAuth": [] }, { "oauth2Password": [] } ], "x-raklet-access": "Premium plan (API access); token inherits the admin user's role permissions" }, "post": { "tags": [ "Boards" ], "operationId": "Boards_Post", "summary": "Create board", "description": "Create board for an organisation. Belongs to the Boards group. HTTP POST /organisations/{organisationId}/boards.", "parameters": [ { "name": "organisationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CategoryDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CategoryDto" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } }, "text/json": { "schema": { "type": "object" } } } }, "401": { "description": "Missing or expired bearer token." }, "403": { "description": "The token's user cannot access this organisation or resource." } }, "security": [ { "bearerAuth": [] }, { "oauth2Password": [] } ], "x-raklet-access": "Premium plan (API access); token inherits the admin user's role permissions" } }, "/organisations/{organisationId}/boards/{boardId}": { "get": { "tags": [ "Boards" ], "operationId": "Boards_Get", "summary": "Get board", "description": "Get board for an organisation. Belongs to the Boards group. HTTP GET /organisations/{organisationId}/boards/{boardId}.", "parameters": [ { "name": "organisationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "boardId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } }, "text/json": { "schema": { "type": "object" } } } }, "401": { "description": "Missing or expired bearer token." }, "403": { "description": "The token's user cannot access this organisation or resource." } }, "security": [ { "bearerAuth": [] }, { "oauth2Password": [] } ], "x-raklet-access": "Premium plan (API access); token inherits the admin user's role permissions" }, "put": { "tags": [ "Boards" ], "operationId": "Boards_Put", "summary": "Update board", "description": "Update board for an organisation. Belongs to the Boards group. HTTP PUT /organisations/{organisationId}/boards/{boardId}.", "parameters": [ { "name": "organisationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "boardId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CategoryDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CategoryDto" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } }, "text/json": { "schema": { "type": "object" } } } }, "401": { "description": "Missing or expired bearer token." }, "403": { "description": "The token's user cannot access this organisation or resource." } }, "security": [ { "bearerAuth": [] }, { "oauth2Password": [] } ], "x-raklet-access": "Premium plan (API access); token inherits the admin user's role permissions" }, "delete": { "tags": [ "Boards" ], "operationId": "Boards_Delete", "summary": "Delete board", "description": "Delete board for an organisation. Belongs to the Boards group. HTTP DELETE /organisations/{organisationId}/boards/{boardId}.", "parameters": [ { "name": "organisationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "boardId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } }, "text/json": { "schema": { "type": "object" } } } }, "401": { "description": "Missing or expired bearer token." }, "403": { "description": "The token's user cannot access this organisation or resource." } }, "security": [ { "bearerAuth": [] }, { "oauth2Password": [] } ], "x-raklet-access": "Premium plan (API access); token inherits the admin user's role permissions" } }, "/organisations/{organisationId}/boards/{boardId}/posts": { "get": { "tags": [ "Boards" ], "operationId": "Boards_GetPost", "summary": "List posts", "description": "List posts for an organisation. Belongs to the Boards group. HTTP GET /organisations/{organisationId}/boards/{boardId}/posts.", "parameters": [ { "name": "organisationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "boardId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "pageSize", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } }, "text/json": { "schema": { "type": "object" } } } }, "401": { "description": "Missing or expired bearer token." }, "403": { "description": "The token's user cannot access this organisation or resource." } }, "security": [ { "bearerAuth": [] }, { "oauth2Password": [] } ], "x-raklet-access": "Premium plan (API access); token inherits the admin user's role permissions" } }, "/app/organisations/{organisationId}/cities": { "get": { "tags": [ "Cities" ], "operationId": "Cities_GetCities", "summary": "List cities", "description": "List cities for an organisation. App-scoped endpoint under `app/`. Belongs to the Cities group. HTTP GET /app/organisations/{organisationId}/cities.", "parameters": [ { "name": "organisationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "startIndex", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "s", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CityDto" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CityDto" } } } } }, "401": { "description": "Missing or expired bearer token." }, "403": { "description": "The token's user cannot access this organisation or resource." } }, "security": [ { "bearerAuth": [] }, { "oauth2Password": [] } ], "x-raklet-access": "Premium plan (API access); token inherits the admin user's role permissions" } }, "/app/organisations/{organisationId}/cities/details": { "get": { "tags": [ "Cities" ], "operationId": "Cities_GetCity", "summary": "Get details", "description": "Get details for an organisation. App-scoped endpoint under `app/`. Belongs to the Cities group. HTTP GET /app/organisations/{organisationId}/cities/details.", "parameters": [ { "name": "organisationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "name", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CityDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CityDto" } } } }, "401": { "description": "Missing or expired bearer token." }, "403": { "description": "The token's user cannot access this organisation or resource." } }, "security": [ { "bearerAuth": [] }, { "oauth2Password": [] } ], "x-raklet-access": "Premium plan (API access); token inherits the admin user's role permissions" } }, "/app/organisations/{organisationId}/cities/count": { "get": { "tags": [ "Cities" ], "operationId": "Cities_GetCitiesCount", "summary": "Count cities", "description": "Count cities for an organisation. App-scoped endpoint under `app/`. Belongs to the Cities group. HTTP GET /app/organisations/{organisationId}/cities/count.", "parameters": [ { "name": "organisationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "format": "int32", "type": "integer" } }, "text/json": { "schema": { "format": "int32", "type": "integer" } } } }, "401": { "description": "Missing or expired bearer token." }, "403": { "description": "The token's user cannot access this organisation or resource." } }, "security": [ { "bearerAuth": [] }, { "oauth2Password": [] } ], "x-raklet-access": "Premium plan (API access); token inherits the admin user's role permissions" } }, "/app/organisations/{organisationId}/companies": { "get": { "tags": [ "Companies" ], "operationId": "Companies_GetCompanies", "summary": "List companies", "description": "List companies for an organisation. App-scoped endpoint under `app/`. Belongs to the Companies group. HTTP GET /app/organisations/{organisationId}/companies.", "parameters": [ { "name": "organisationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "startIndex", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "s", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CompanyDto" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CompanyDto" } } } } }, "401": { "description": "Missing or expired bearer token." }, "403": { "description": "The token's user cannot access this organisation or resource." } }, "security": [ { "bearerAuth": [] }, { "oauth2Password": [] } ], "x-raklet-access": "Premium plan (API access); token inherits the admin user's role permissions" } }, "/app/organisations/{organisationId}/companies/details": { "get": { "tags": [ "Companies" ], "operationId": "Companies_GetCompanyDetails", "summary": "Get details", "description": "Get details for an organisation. App-scoped endpoint under `app/`. Belongs to the Companies group. HTTP GET /app/organisations/{organisationId}/companies/details.", "parameters": [ { "name": "organisationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "name", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CompanyDto" } } } }, "401": { "description": "Missing or expired bearer token." }, "403": { "description": "The token's user cannot access this organisation or resource." } }, "security": [ { "bearerAuth": [] }, { "oauth2Password": [] } ], "x-raklet-access": "Premium plan (API access); token inherits the admin user's role permissions" } }, "/app/organisations/{organisationId}/companies/count": { "get": { "tags": [ "Companies" ], "operationId": "Companies_GetCompaniesCount", "summary": "Count companies", "description": "Count companies for an organisation. App-scoped endpoint under `app/`. Belongs to the Companies group. HTTP GET /app/organisations/{organisationId}/companies/count.", "parameters": [ { "name": "organisationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "format": "int32", "type": "integer" } }, "text/json": { "schema": { "format": "int32", "type": "integer" } } } }, "401": { "description": "Missing or expired bearer token." }, "403": { "description": "The token's user cannot access this organisation or resource." } }, "security": [ { "bearerAuth": [] }, { "oauth2Password": [] } ], "x-raklet-access": "Premium plan (API access); token inherits the admin user's role permissions" } }, "/organisations/{organisationId}/contacts": { "get": { "tags": [ "Contact" ], "operationId": "Contact_GetContacts", "summary": "This method allows you to filter out your contacts", "description": "For more information, see https://help.raklet.com/en/articles/5998452-how-to-search-organisation-contacts", "parameters": [ { "name": "organisationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "pageSize", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "q", "in": "query", "required": false, "description": "json to base64 query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResult_GenericFilterListDto_UpsertContactDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiResult_GenericFilterListDto_UpsertContactDto" } } } }, "401": { "description": "Missing or expired bearer token." }, "403": { "description": "The token's user cannot access this organisation or resource." } }, "security": [ { "bearerAuth": [] }, { "oauth2Password": [] } ], "x-raklet-access": "Premium plan (API access); token inherits the admin user's role permissions" }, "post": { "tags": [ "Contact" ], "operationId": "Contact_Post", "summary": "Create contact", "description": "Create contact for an organisation. Belongs to the Contact group. HTTP POST /organisations/{organisationId}/contacts.", "parameters": [ { "name": "organisationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateContactDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateContactDto" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiResult" } } } }, "401": { "description": "Missing or expired bearer token." }, "403": { "description": "The token's user cannot access this organisation or resource." } }, "security": [ { "bearerAuth": [] }, { "oauth2Password": [] } ], "x-raklet-access": "Premium plan (API access); token inherits the admin user's role permissions" } }, "/organisations/{organisationId}/contacts/{organisationMembershipId}/details": { "get": { "tags": [ "Contact" ], "operationId": "Contact_GetDetails", "summary": "Get details", "description": "Get details for an organisation. Belongs to the Contact group. HTTP GET /organisations/{organisationId}/contacts/{organisationMembershipId}/details.", "parameters": [ { "name": "organisationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "organisationMembershipId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResult_UpsertContactDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiResult_UpsertContactDto" } } } }, "401": { "description": "Missing or expired bearer token." }, "403": { "description": "The token's user cannot access this organisation or resource." } }, "security": [ { "bearerAuth": [] }, { "oauth2Password": [] } ], "x-raklet-access": "Premium plan (API access); token inherits the admin user's role permissions" } }, "/organisations/{organisationId}/contacts/{organisationMembershipId}": { "put": { "tags": [ "Contact" ], "operationId": "Contact_Put", "summary": "Update contact", "description": "Update contact for an organisation. Belongs to the Contact group. HTTP PUT /organisations/{organisationId}/contacts/{organisationMembershipId}.", "parameters": [ { "name": "organisationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "organisationMembershipId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateContactDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateContactDto" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiResult" } } } }, "401": { "description": "Missing or expired bearer token." }, "403": { "description": "The token's user cannot access this organisation or resource." } }, "security": [ { "bearerAuth": [] }, { "oauth2Password": [] } ], "x-raklet-access": "Premium plan (API access); token inherits the admin user's role permissions" }, "delete": { "tags": [ "Contact" ], "operationId": "Contact_Delete", "summary": "Delete contact", "description": "Delete contact for an organisation. Belongs to the Contact group. HTTP DELETE /organisations/{organisationId}/contacts/{organisationMembershipId}.", "parameters": [ { "name": "organisationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "organisationMembershipId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiResult" } } } }, "401": { "description": "Missing or expired bearer token." }, "403": { "description": "The token's user cannot access this organisation or resource." } }, "security": [ { "bearerAuth": [] }, { "oauth2Password": [] } ], "x-raklet-access": "Premium plan (API access); token inherits the admin user's role permissions" } }, "/organisations/{organisationId}/contacts/{organisationMembershipId}/update": { "put": { "tags": [ "Contact" ], "operationId": "Contact_PutContact", "summary": "Update update", "description": "Update update for an organisation. Belongs to the Contact group. HTTP PUT /organisations/{organisationId}/contacts/{organisationMembershipId}/update.", "parameters": [ { "name": "organisationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "organisationMembershipId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpsertContactDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpsertContactDto" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiResult" } } } }, "401": { "description": "Missing or expired bearer token." }, "403": { "description": "The token's user cannot access this organisation or resource." } }, "security": [ { "bearerAuth": [] }, { "oauth2Password": [] } ], "x-raklet-access": "Premium plan (API access); token inherits the admin user's role permissions" } }, "/organisations/{organisationId}/contacts/{organisationMembershipId}/PhotoUrl": { "post": { "tags": [ "Contact" ], "operationId": "Contact_PostPhoto", "summary": "Photo Url", "description": "Photo Url for an organisation. Belongs to the Contact group. HTTP POST /organisations/{organisationId}/contacts/{organisationMembershipId}/PhotoUrl.", "parameters": [ { "name": "organisationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "organisationMembershipId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactPhoto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ContactPhoto" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResult_UpsertContactDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiResult_UpsertContactDto" } } } }, "401": { "description": "Missing or expired bearer token." }, "403": { "description": "The token's user cannot access this organisation or resource." } }, "security": [ { "bearerAuth": [] }, { "oauth2Password": [] } ], "x-raklet-access": "Premium plan (API access); token inherits the admin user's role permissions" } }, "/organisations/{organisationId}/contacts/{organisationMembershipId}/photo": { "post": { "tags": [ "Contact" ], "operationId": "Contact_PostPhoto_2", "summary": "Create photo", "description": "Create photo for an organisation. Belongs to the Contact group. HTTP POST /organisations/{organisationId}/contacts/{organisationMembershipId}/photo.", "parameters": [ { "name": "organisationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "organisationMembershipId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResult_UpsertContactDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiResult_UpsertContactDto" } } } }, "401": { "description": "Missing or expired bearer token." }, "403": { "description": "The token's user cannot access this organisation or resource." } }, "security": [ { "bearerAuth": [] }, { "oauth2Password": [] } ], "x-raklet-access": "Premium plan (API access); token inherits the admin user's role permissions" } }, "/organisations/{organisationId}/contacts/{organisationMembershipId}/addresses/{id}": { "put": { "tags": [ "ContactAddress" ], "operationId": "ContactAddress_Put", "summary": "Update addresse", "description": "Update addresse for an organisation. Belongs to the Contact addresses group. HTTP PUT /organisations/{organisationId}/contacts/{organisationMembershipId}/addresses/{id}.", "parameters": [ { "name": "organisationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "organisationMembershipId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddressDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AddressDto" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResult_AddressDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiResult_AddressDto" } } } }, "401": { "description": "Missing or expired bearer token." }, "403": { "description": "The token's user cannot access this organisation or resource." } }, "security": [ { "bearerAuth": [] }, { "oauth2Password": [] } ], "x-raklet-access": "Premium plan (API access); token inherits the admin user's role permissions" }, "delete": { "tags": [ "ContactAddress" ], "operationId": "ContactAddress_Delete", "summary": "Delete addresse", "description": "Delete addresse for an organisation. Belongs to the Contact addresses group. HTTP DELETE /organisations/{organisationId}/contacts/{organisationMembershipId}/addresses/{id}.", "parameters": [ { "name": "organisationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "organisationMembershipId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResult_AddressDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiResult_AddressDto" } } } }, "401": { "description": "Missing or expired bearer token." }, "403": { "description": "The token's user cannot access this organisation or resource." } }, "security": [ { "bearerAuth": [] }, { "oauth2Password": [] } ], "x-raklet-access": "Premium plan (API access); token inherits the admin user's role permissions" } }, "/organisations/{organisationId}/contacts/{organisationMembershipId}/addresses": { "post": { "tags": [ "ContactAddress" ], "operationId": "ContactAddress_Post", "summary": "Create addresse", "description": "Create addresse for an organisation. Belongs to the Contact addresses group. HTTP POST /organisations/{organisationId}/contacts/{organisationMembershipId}/addresses.", "parameters": [ { "name": "organisationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "organisationMembershipId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddressDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AddressDto" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResult_AddressDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiResult_AddressDto" } } } }, "401": { "description": "Missing or expired bearer token." }, "403": { "description": "The token's user cannot access this organisation or resource." } }, "security": [ { "bearerAuth": [] }, { "oauth2Password": [] } ], "x-raklet-access": "Premium plan (API access); token inherits the admin user's role permissions" } }, "/organisations/{organisationId}/contacts/{organisationMembershipId}/addresses/{id}/SetPrimary": { "patch": { "tags": [ "ContactAddress" ], "operationId": "ContactAddress_SetPrimary", "summary": "Set Primary", "description": "Set Primary for an organisation. Belongs to the Contact addresses group. HTTP PATCH /organisations/{organisationId}/contacts/{organisationMembershipId}/addresses/{id}/SetPrimary.", "parameters": [ { "name": "organisationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "organisationMembershipId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiResult" } } } }, "401": { "description": "Missing or expired bearer token." }, "403": { "description": "The token's user cannot access this organisation or resource." } }, "security": [ { "bearerAuth": [] }, { "oauth2Password": [] } ], "x-raklet-access": "Premium plan (API access); token inherits the admin user's role permissions" } }, "/organisations/{organisationId}/contacts/{organisationMembershipId}/educations/{id}": { "put": { "tags": [ "ContactEducation" ], "operationId": "ContactEducation_PutEducation", "summary": "Update education", "description": "Update education for an organisation. Belongs to the Contact education history group. HTTP PUT /organisations/{organisationId}/contacts/{organisationMembershipId}/educations/{id}.", "parameters": [ { "name": "organisationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "organisationMembershipId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EducationDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EducationDto" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResult_EducationDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiResult_EducationDto" } } } }, "401": { "description": "Missing or expired bearer token." }, "403": { "description": "The token's user cannot access this organisation or resource." } }, "security": [ { "bearerAuth": [] }, { "oauth2Password": [] } ], "x-raklet-access": "Premium plan (API access); token inherits the admin user's role permissions" }, "delete": { "tags": [ "ContactEducation" ], "operationId": "ContactEducation_DeleteEducation", "summary": "Delete education", "description": "Delete education for an organisation. Belongs to the Contact education history group. HTTP DELETE /organisations/{organisationId}/contacts/{organisationMembershipId}/educations/{id}.", "parameters": [ { "name": "organisationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "organisationMembershipId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResult_EducationDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiResult_EducationDto" } } } }, "401": { "description": "Missing or expired bearer token." }, "403": { "description": "The token's user cannot access this organisation or resource." } }, "security": [ { "bearerAuth": [] }, { "oauth2Password": [] } ], "x-raklet-access": "Premium plan (API access); token inherits the admin user's role permissions" } }, "/organisations/{organisationId}/contacts/{organisationMembershipId}/educations": { "post": { "tags": [ "ContactEducation" ], "operationId": "ContactEducation_PostEducation", "summary": "Create education", "description": "Create education for an organisation. Belongs to the Contact education history group. HTTP POST /organisations/{organisationId}/contacts/{organisationMembershipId}/educations.", "parameters": [ { "name": "organisationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "organisationMembershipId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EducationDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EducationDto" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResult_EducationDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiResult_EducationDto" } } } }, "401": { "description": "Missing or expired bearer token." }, "403": { "description": "The token's user cannot access this organisation or resource." } }, "security": [ { "bearerAuth": [] }, { "oauth2Password": [] } ], "x-raklet-access": "Premium plan (API access); token inherits the admin user's role permissions" } }, "/organisations/{organisationId}/contacts/{organisationMembershipId}/emails/{id}": { "put": { "tags": [ "ContactEmail" ], "operationId": "ContactEmail_Put", "summary": "Update email", "description": "Update email for an organisation. Belongs to the Contact emails group. HTTP PUT /organisations/{organisationId}/contacts/{organisationMembershipId}/emails/{id}.", "parameters": [ { "name": "organisationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "organisationMembershipId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmailDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EmailDto" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResult_EmailDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiResult_EmailDto" } } } }, "401": { "description": "Missing or expired bearer token." }, "403": { "description": "The token's user cannot access this organisation or resource." } }, "security": [ { "bearerAuth": [] }, { "oauth2Password": [] } ], "x-raklet-access": "Premium plan (API access); token inherits the admin user's role permissions" }, "delete": { "tags": [ "ContactEmail" ], "operationId": "ContactEmail_Delete", "summary": "Delete email", "description": "Delete email for an organisation. Belongs to the Contact emails group. HTTP DELETE /organisations/{organisationId}/contacts/{organisationMembershipId}/emails/{id}.", "parameters": [ { "name": "organisationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "organisationMembershipId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResult_EmailDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiResult_EmailDto" } } } }, "401": { "description": "Missing or expired bearer token." }, "403": { "description": "The token's user cannot access this organisation or resource." } }, "security": [ { "bearerAuth": [] }, { "oauth2Password": [] } ], "x-raklet-access": "Premium plan (API access); token inherits the admin user's role permissions" } }, "/organisations/{organisationId}/contacts/{organisationMembershipId}/emails": { "post": { "tags": [ "ContactEmail" ], "operationId": "ContactEmail_Post", "summary": "Create email", "description": "Create email for an organisation. Belongs to the Contact emails group. HTTP POST /organisations/{organisationId}/contacts/{organisationMembershipId}/emails.", "parameters": [ { "name": "organisationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "organisationMembershipId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmailDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EmailDto" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResult_EmailDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiResult_EmailDto" } } } }, "401": { "description": "Missing or expired bearer token." }, "403": { "description": "The token's user cannot access this organisation or resource." } }, "security": [ { "bearerAuth": [] }, { "oauth2Password": [] } ], "x-raklet-access": "Premium plan (API access); token inherits the admin user's role permissions" } }, "/organisations/{organisationId}/contacts/{organisationMembershipId}/emails/{id}/SendActivation": { "patch": { "tags": [ "ContactEmail" ], "operationId": "ContactEmail_SendActivation", "summary": "Send Activation", "description": "Send Activation for an organisation. Belongs to the Contact emails group. HTTP PATCH /organisations/{organisationId}/contacts/{organisationMembershipId}/emails/{id}/SendActivation.", "parameters": [ { "name": "organisationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "organisationMembershipId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiResult" } } } }, "401": { "description": "Missing or expired bearer token." }, "403": { "description": "The token's user cannot access this organisation or resource." } }, "security": [ { "bearerAuth": [] }, { "oauth2Password": [] } ], "x-raklet-access": "Premium plan (API access); token inherits the admin user's role permissions" } }, "/organisations/{organisationId}/contacts/{organisationMembershipId}/emails/{id}/SetPrimary": { "patch": { "tags": [ "ContactEmail" ], "operationId": "ContactEmail_SetPrimary", "summary": "Set Primary", "description": "Set Primary for an organisation. Belongs to the Contact emails group. HTTP PATCH /organisations/{organisationId}/contacts/{organisationMembershipId}/emails/{id}/SetPrimary.", "parameters": [ { "name": "organisationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "organisationMembershipId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiResult" } } } }, "401": { "description": "Missing or expired bearer token." }, "403": { "description": "The token's user cannot access this organisation or resource." } }, "security": [ { "bearerAuth": [] }, { "oauth2Password": [] } ], "x-raklet-access": "Premium plan (API access); token inherits the admin user's role permissions" } }, "/organisations/{organisationId}/contacts/{organisationMembershipId}/phones/{id}": { "put": { "tags": [ "ContactPhone" ], "operationId": "ContactPhone_Put", "summary": "Update phone", "description": "Update phone for an organisation. Belongs to the Contact phones group. HTTP PUT /organisations/{organisationId}/contacts/{organisationMembershipId}/phones/{id}.", "parameters": [ { "name": "organisationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "organisationMembershipId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PhoneDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PhoneDto" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResult_PhoneDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiResult_PhoneDto" } } } }, "401": { "description": "Missing or expired bearer token." }, "403": { "description": "The token's user cannot access this organisation or resource." } }, "security": [ { "bearerAuth": [] }, { "oauth2Password": [] } ], "x-raklet-access": "Premium plan (API access); token inherits the admin user's role permissions" }, "delete": { "tags": [ "ContactPhone" ], "operationId": "ContactPhone_Delete", "summary": "Delete phone", "description": "Delete phone for an organisation. Belongs to the Contact phones group. HTTP DELETE /organisations/{organisationId}/contacts/{organisationMembershipId}/phones/{id}.", "parameters": [ { "name": "organisationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "organisationMembershipId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResult_PhoneDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiResult_PhoneDto" } } } }, "401": { "description": "Missing or expired bearer token." }, "403": { "description": "The token's user cannot access this organisation or resource." } }, "security": [ { "bearerAuth": [] }, { "oauth2Password": [] } ], "x-raklet-access": "Premium plan (API access); token inherits the admin user's role permissions" } }, "/organisations/{organisationId}/contacts/{organisationMembershipId}/phones": { "post": { "tags": [ "ContactPhone" ], "operationId": "ContactPhone_Post", "summary": "Create phone", "description": "Create phone for an organisation. Belongs to the Contact phones group. HTTP POST /organisations/{organisationId}/contacts/{organisationMembershipId}/phones.", "parameters": [ { "name": "organisationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "organisationMembershipId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PhoneDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PhoneDto" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResult_PhoneDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiResult_PhoneDto" } } } }, "401": { "description": "Missing or expired bearer token." }, "403": { "description": "The token's user cannot access this organisation or resource." } }, "security": [ { "bearerAuth": [] }, { "oauth2Password": [] } ], "x-raklet-access": "Premium plan (API access); token inherits the admin user's role permissions" } }, "/organisations/{organisationId}/contacts/{organisationMembershipId}/phones/{id}/SendActivation": { "patch": { "tags": [ "ContactPhone" ], "operationId": "ContactPhone_SendActivation", "summary": "Send Activation", "description": "Send Activation for an organisation. Belongs to the Contact phones group. HTTP PATCH /organisations/{organisationId}/contacts/{organisationMembershipId}/phones/{id}/SendActivation.", "parameters": [ { "name": "organisationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "organisationMembershipId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiResult" } } } }, "401": { "description": "Missing or expired bearer token." }, "403": { "description": "The token's user cannot access this organisation or resource." } }, "security": [ { "bearerAuth": [] }, { "oauth2Password": [] } ], "x-raklet-access": "Premium plan (API access); token inherits the admin user's role permissions" } }, "/organisations/{organisationId}/contacts/{organisationMembershipId}/phones/{id}/Activate/{code}": { "patch": { "tags": [ "ContactPhone" ], "operationId": "ContactPhone_Activate", "summary": "Update activate", "description": "Update activate for an organisation. Belongs to the Contact phones group. HTTP PATCH /organisations/{organisationId}/contacts/{organisationMembershipId}/phones/{id}/Activate/{code}.", "parameters": [ { "name": "organisationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "organisationMembershipId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "code", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiResult" } } } }, "401": { "description": "Missing or expired bearer token." }, "403": { "description": "The token's user cannot access this organisation or resource." } }, "security": [ { "bearerAuth": [] }, { "oauth2Password": [] } ], "x-raklet-access": "Premium plan (API access); token inherits the admin user's role permissions" } }, "/organisations/{organisationId}/contacts/{organisationMembershipId}/phones/{id}/SetPrimary": { "patch": { "tags": [ "ContactPhone" ], "operationId": "ContactPhone_SetPrimary", "summary": "Set Primary", "description": "Set Primary for an organisation. Belongs to the Contact phones group. HTTP PATCH /organisations/{organisationId}/contacts/{organisationMembershipId}/phones/{id}/SetPrimary.", "parameters": [ { "name": "organisationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "organisationMembershipId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiResult" } } } }, "401": { "description": "Missing or expired bearer token." }, "403": { "description": "The token's user cannot access this organisation or resource." } }, "security": [ { "bearerAuth": [] }, { "oauth2Password": [] } ], "x-raklet-access": "Premium plan (API access); token inherits the admin user's role permissions" } }, "/organisations/{organisationId}/contacts/{organisationMembershipId}/works/{id}": { "put": { "tags": [ "ContactWork" ], "operationId": "ContactWork_PutWork", "summary": "Update work", "description": "Update work for an organisation. Belongs to the Contact work history group. HTTP PUT /organisations/{organisationId}/contacts/{organisationMembershipId}/works/{id}.", "parameters": [ { "name": "organisationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "organisationMembershipId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/WorkDto" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResult_WorkDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiResult_WorkDto" } } } }, "401": { "description": "Missing or expired bearer token." }, "403": { "description": "The token's user cannot access this organisation or resource." } }, "security": [ { "bearerAuth": [] }, { "oauth2Password": [] } ], "x-raklet-access": "Premium plan (API access); token inherits the admin user's role permissions" }, "delete": { "tags": [ "ContactWork" ], "operationId": "ContactWork_DeleteWork", "summary": "Delete work", "description": "Delete work for an organisation. Belongs to the Contact work history group. HTTP DELETE /organisations/{organisationId}/contacts/{organisationMembershipId}/works/{id}.", "parameters": [ { "name": "organisationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "organisationMembershipId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResult_WorkDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiResult_WorkDto" } } } }, "401": { "description": "Missing or expired bearer token." }, "403": { "description": "The token's user cannot access this organisation or resource." } }, "security": [ { "bearerAuth": [] }, { "oauth2Password": [] } ], "x-raklet-access": "Premium plan (API access); token inherits the admin user's role permissions" } }, "/organisations/{organisationId}/contacts/{organisationMembershipId}/works": { "post": { "tags": [ "ContactWork" ], "operationId": "ContactWork_PostWork", "summary": "Create work", "description": "Create work for an organisation. Belongs to the Contact work history group. HTTP POST /organisations/{organisationId}/contacts/{organisationMembershipId}/works.", "parameters": [ { "name": "organisationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "organisationMembershipId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/WorkDto" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResult_WorkDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiResult_WorkDto" } } } }, "401": { "description": "Missing or expired bearer token." }, "403": { "description": "The token's user cannot access this organisation or resource." } }, "security": [ { "bearerAuth": [] }, { "oauth2Password": [] } ], "x-raklet-access": "Premium plan (API access); token inherits the admin user's role permissions" } }, "/app/organisations/{organisationId}/corporateMembers": { "get": { "tags": [ "CorporateMembers" ], "operationId": "CorporateMembers_GetCorporateMembers", "summary": "List corporate members", "description": "List corporate members for an organisation. App-scoped endpoint under `app/`. Belongs to the Corporate members group. HTTP GET /app/organisations/{organisationId}/corporateMembers.", "parameters": [ { "name": "organisationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "startIndex", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "s", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CorporateMemberDto" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CorporateMemberDto" } } } } }, "401": { "description": "Missing or expired bearer token." }, "403": { "description": "The token's user cannot access this organisation or resource." } }, "security": [ { "bearerAuth": [] }, { "oauth2Password": [] } ], "x-raklet-access": "Premium plan (API access); token inherits the admin user's role permissions" } }, "/app/organisations/{organisationId}/corporateMembers/{id}": { "get": { "tags": [ "CorporateMembers" ], "operationId": "CorporateMembers_GetCorporateMember", "summary": "Get corporate member", "description": "Get corporate member for an organisation. App-scoped endpoint under `app/`. Belongs to the Corporate members group. HTTP GET /app/organisations/{organisationId}/corporateMembers/{id}.", "parameters": [ { "name": "organisationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CorporateMemberDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CorporateMemberDto" } } } }, "401": { "description": "Missing or expired bearer token." }, "403": { "description": "The token's user cannot access this organisation or resource." } }, "security": [ { "bearerAuth": [] }, { "oauth2Password": [] } ], "x-raklet-access": "Premium plan (API access); token inherits the admin user's role permissions" } }, "/app/organisations/{organisationId}/corporateMembers/count": { "get": { "tags": [ "CorporateMembers" ], "operationId": "CorporateMembers_GetCorporateMembersCount", "summary": "Count corporate members", "description": "Count corporate members for an organisation. App-scoped endpoint under `app/`. Belongs to the Corporate members group. HTTP GET /app/organisations/{organisationId}/corporateMembers/count.", "parameters": [ { "name": "organisationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "format": "int32", "type": "integer" } }, "text/json": { "schema": { "format": "int32", "type": "integer" } } } }, "401": { "description": "Missing or expired bearer token." }, "403": { "description": "The token's user cannot access this organisation or resource." } }, "security": [ { "bearerAuth": [] }, { "oauth2Password": [] } ], "x-raklet-access": "Premium plan (API access); token inherits the admin user's role permissions" } }, "/app/organisations/{organisationId}/countries": { "get": { "tags": [ "Countries" ], "operationId": "Countries_GetCountries", "summary": "List countries", "description": "List countries for an organisation. App-scoped endpoint under `app/`. Belongs to the Countries group. HTTP GET /app/organisations/{organisationId}/countries.", "parameters": [ { "name": "organisationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "startIndex", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "s", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CountryDto" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CountryDto" } } } } }, "401": { "description": "Missing or expired bearer token." }, "403": { "description": "The token's user cannot access this organisation or resource." } }, "security": [ { "bearerAuth": [] }, { "oauth2Password": [] } ], "x-raklet-access": "Premium plan (API access); token inherits the admin user's role permissions" } }, "/app/organisations/{organisationId}/countries/details": { "get": { "tags": [ "Countries" ], "operationId": "Countries_GetCountry", "summary": "Get details", "description": "Get details for an organisation. App-scoped endpoint under `app/`. Belongs to the Countries group. HTTP GET /app/organisations/{organisationId}/countries/details.", "parameters": [ { "name": "organisationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "name", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CountryDto" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CountryDto" } } } } }, "401": { "description": "Missing or expired bearer token." }, "403": { "description": "The token's user cannot access this organisation or resource." } }, "security": [ { "bearerAuth": [] }, { "oauth2Password": [] } ], "x-raklet-access": "Premium plan (API access); token inherits the admin user's role permissions" } }, "/app/organisations/{organisationId}/countries/count": { "get": { "tags": [ "Countries" ], "operationId": "Countries_GetCountriesCount", "summary": "Count countries", "description": "Count countries for an organisation. App-scoped endpoint under `app/`. Belongs to the Countries group. HTTP GET /app/organisations/{organisationId}/countries/count.", "parameters": [ { "name": "organisationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "format": "int32", "type": "integer" } }, "text/json": { "schema": { "format": "int32", "type": "integer" } } } }, "401": { "description": "Missing or expired bearer token." }, "403": { "description": "The token's user cannot access this organisation or resource." } }, "security": [ { "bearerAuth": [] }, { "oauth2Password": [] } ], "x-raklet-access": "Premium plan (API access); token inherits the admin user's role permissions" } }, "/app/organisations/{organisationId}/creditCard/{organisationMembershipId}/InstallmentOptions": { "patch": { "tags": [ "CreditCard" ], "operationId": "CreditCard_PatchInstallmentOptions", "summary": "Installment Options", "description": "Installment Options for an organisation. App-scoped endpoint under `app/`. Belongs to the Credit cards group. HTTP PATCH /app/organisations/{organisationId}/creditCard/{organisationMembershipId}/InstallmentOptions.", "parameters": [ { "name": "organisationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "organisationMembershipId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreditCardInstallmentRequestDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreditCardInstallmentRequestDto" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CreditCardInstallmentResponseDto" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CreditCardInstallmentResponseDto" } } } } }, "401": { "description": "Missing or expired bearer token." }, "403": { "description": "The token's user cannot access this organisation or resource." } }, "security": [ { "bearerAuth": [] }, { "oauth2Password": [] } ], "x-raklet-access": "Premium plan (API access); token inherits the admin user's role permissions" } }, "/app/organisations/{organisationId}/creditCard/{organisationMembershipId}": { "post": { "tags": [ "CreditCard" ], "operationId": "CreditCard_PostChargeCreditCard", "summary": "Create credit card", "description": "Create credit card for an organisation. App-scoped endpoint under `app/`. Belongs to the Credit cards group. HTTP POST /app/organisations/{organisationId}/creditCard/{organisationMembershipId}.", "parameters": [ { "name": "organisationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "organisationMembershipId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreditCardChargeRequestDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreditCardChargeRequestDto" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreditCardChargeResponseDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreditCardChargeResponseDto" } } } }, "401": { "description": "Missing or expired bearer token." }, "403": { "description": "The token's user cannot access this organisation or resource." } }, "security": [ { "bearerAuth": [] }, { "oauth2Password": [] } ], "x-raklet-access": "Premium plan (API access); token inherits the admin user's role permissions" } }, "/app/organisations/{organisationId}/donationCampaigns": { "get": { "tags": [ "DonationCampaigns" ], "operationId": "DonationCampaigns_GetDonationCampaigns", "summary": "List donation campaigns", "description": "List donation campaigns for an organisation. App-scoped endpoint under `app/`. Belongs to the Donation campaigns group. HTTP GET /app/organisations/{organisationId}/donationCampaigns.", "parameters": [ { "name": "organisationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DonationCampaignDto" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DonationCampaignDto" } } } } }, "401": { "description": "Missing or expired bearer token." }, "403": { "description": "The token's user cannot access this organisation or resource." } }, "security": [ { "bearerAuth": [] }, { "oauth2Password": [] } ], "x-raklet-access": "Premium plan (API access); token inherits the admin user's role permissions" } }, "/app/organisations/{organisationId}/donationCampaigns/{id}": { "get": { "tags": [ "DonationCampaigns" ], "operationId": "DonationCampaigns_GetDonationCampaign", "summary": "Get donation campaign", "description": "Get donation campaign for an organisation. App-scoped endpoint under `app/`. Belongs to the Donation campaigns group. HTTP GET /app/organisations/{organisationId}/donationCampaigns/{id}.", "parameters": [ { "name": "organisationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DonationCampaignDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DonationCampaignDto" } } } }, "401": { "description": "Missing or expired bearer token." }, "403": { "description": "The token's user cannot access this organisation or resource." } }, "security": [ { "bearerAuth": [] }, { "oauth2Password": [] } ], "x-raklet-access": "Premium plan (API access); token inherits the admin user's role permissions" } }, "/app/organisations/{organisationId}/donationCampaigns/count": { "get": { "tags": [ "DonationCampaigns" ], "operationId": "DonationCampaigns_GetDonationCampaignsCount", "summary": "Count donation campaigns", "description": "Count donation campaigns for an organisation. App-scoped endpoint under `app/`. Belongs to the Donation campaigns group. HTTP GET /app/organisations/{organisationId}/donationCampaigns/count.", "parameters": [ { "name": "organisationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "format": "int32", "type": "integer" } }, "text/json": { "schema": { "format": "int32", "type": "integer" } } } }, "401": { "description": "Missing or expired bearer token." }, "403": { "description": "The token's user cannot access this organisation or resource." } }, "security": [ { "bearerAuth": [] }, { "oauth2Password": [] } ], "x-raklet-access": "Premium plan (API access); token inherits the admin user's role permissions" } }, "/app/organisations/{organisationId}/donationCampaigns/{organisationMembershipId}": { "post": { "tags": [ "DonationCampaigns" ], "operationId": "DonationCampaigns_PostTestDonationCampaign", "summary": "Create donation campaign", "description": "Create donation campaign for an organisation. App-scoped endpoint under `app/`. Belongs to the Donation campaigns group. HTTP POST /app/organisations/{organisationId}/donationCampaigns/{organisationMembershipId}.", "parameters": [ { "name": "organisationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "organisationMembershipId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DonationCampaignDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DonationCampaignDto" } } } }, "401": { "description": "Missing or expired bearer token." }, "403": { "description": "The token's user cannot access this organisation or resource." } }, "security": [ { "bearerAuth": [] }, { "oauth2Password": [] } ], "x-raklet-access": "Premium plan (API access); token inherits the admin user's role permissions" } }, "/app/organisations/{organisationId}/donations/{organisationMembershipId}": { "get": { "tags": [ "Donations" ], "operationId": "Donations_GetDonations", "summary": "Get donation", "description": "Get donation for an organisation. App-scoped endpoint under `app/`. Belongs to the Donations group. HTTP GET /app/organisations/{organisationId}/donations/{organisationMembershipId}.", "parameters": [ { "name": "organisationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "organisationMembershipId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DonationCampaignDto" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DonationCampaignDto" } } } } }, "401": { "description": "Missing or expired bearer token." }, "403": { "description": "The token's user cannot access this organisation or resource." } }, "security": [ { "bearerAuth": [] }, { "oauth2Password": [] } ], "x-raklet-access": "Premium plan (API access); token inherits the admin user's role permissions" } }, "/app/organisations/{organisationId}/events": { "get": { "tags": [ "Events" ], "operationId": "Events_GetEvents", "summary": "List events", "description": "List events for an organisation. App-scoped endpoint under `app/`. Belongs to the Events group. HTTP GET /app/organisations/{organisationId}/events.", "parameters": [ { "name": "organisationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "startDate", "in": "query", "required": true, "schema": { "type": "string", "format": "date-time" } }, { "name": "endDate", "in": "query", "required": true, "schema": { "type": "string", "format": "date-time" } }, { "name": "requestContinuation", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "s", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "isPublic", "in": "query", "required": false, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/EventDto" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/EventDto" } } } } }, "401": { "description": "Missing or expired bearer token." }, "403": { "description": "The token's user cannot access this organisation or resource." } }, "security": [ { "bearerAuth": [] }, { "oauth2Password": [] } ], "x-raklet-access": "Premium plan (API access); token inherits the admin user's role permissions" } }, "/app/organisations/{organisationId}/events/{id}": { "get": { "tags": [ "Events" ], "operationId": "Events_GetEvent", "summary": "Get event", "description": "Get event for an organisation. App-scoped endpoint under `app/`. Belongs to the Events group. HTTP GET /app/organisations/{organisationId}/events/{id}.", "parameters": [ { "name": "organisationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EventDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EventDto" } } } }, "401": { "description": "Missing or expired bearer token." }, "403": { "description": "The token's user cannot access this organisation or resource." } }, "security": [ { "bearerAuth": [] }, { "oauth2Password": [] } ], "x-raklet-access": "Premium plan (API access); token inherits the admin user's role permissions" } }, "/app/organisations/{organisationId}/events/{id}/ticketoptions": { "get": { "tags": [ "Events" ], "operationId": "Events_GetTicketOptions", "summary": "List ticketoptions", "description": "List ticketoptions for an organisation. App-scoped endpoint under `app/`. Belongs to the Events group. HTTP GET /app/organisations/{organisationId}/events/{id}/ticketoptions.", "parameters": [ { "name": "organisationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EventTicketOptionDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EventTicketOptionDto" } } } }, "401": { "description": "Missing or expired bearer token." }, "403": { "description": "The token's user cannot access this organisation or resource." } }, "security": [ { "bearerAuth": [] }, { "oauth2Password": [] } ], "x-raklet-access": "Premium plan (API access); token inherits the admin user's role permissions" } }, "/app/organisations/{organisationId}/events/{id}/tickets": { "post": { "tags": [ "Events" ], "operationId": "Events_PostTickets", "summary": "Create ticket", "description": "Create ticket for an organisation. App-scoped endpoint under `app/`. Belongs to the Events group. HTTP POST /app/organisations/{organisationId}/events/{id}/tickets.", "parameters": [ { "name": "organisationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EventTicketOrdersDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EventTicketOrdersDto" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EventTicketDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EventTicketDto" } } } }, "401": { "description": "Missing or expired bearer token." }, "403": { "description": "The token's user cannot access this organisation or resource." } }, "security": [ { "bearerAuth": [] }, { "oauth2Password": [] } ], "x-raklet-access": "Premium plan (API access); token inherits the admin user's role permissions" } }, "/app/organisations/{organisationId}/events/{id}/tickets/{ticketId}": { "get": { "tags": [ "Events" ], "operationId": "Events_GetTickets", "summary": "Get ticket", "description": "Get ticket for an organisation. App-scoped endpoint under `app/`. Belongs to the Events group. HTTP GET /app/organisations/{organisationId}/events/{id}/tickets/{ticketId}.", "parameters": [ { "name": "organisationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "ticketId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EventTicketDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EventTicketDto" } } } }, "401": { "description": "Missing or expired bearer token." }, "403": { "description": "The token's user cannot access this organisation or resource." } }, "security": [ { "bearerAuth": [] }, { "oauth2Password": [] } ], "x-raklet-access": "Premium plan (API access); token inherits the admin user's role permissions" } }, "/app/organisations/{organisationId}/events/{id}/tickets/{ticketId}/pay": { "post": { "tags": [ "Events" ], "operationId": "Events_PostChargeCreditCardTicket", "summary": "Create pay", "description": "Create pay for an organisation. App-scoped endpoint under `app/`. Belongs to the Events group. HTTP POST /app/organisations/{organisationId}/events/{id}/tickets/{ticketId}/pay.", "parameters": [ { "name": "organisationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "ticketId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreditCardChargeTicketRequestDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreditCardChargeTicketRequestDto" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreditCardChargeTicketResponseDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreditCardChargeTicketResponseDto" } } } }, "401": { "description": "Missing or expired bearer token." }, "403": { "description": "The token's user cannot access this organisation or resource." } }, "security": [ { "bearerAuth": [] }, { "oauth2Password": [] } ], "x-raklet-access": "Premium plan (API access); token inherits the admin user's role permissions" } }, "/app/organisations/{organisationId}/jobs": { "get": { "tags": [ "JobPostings" ], "operationId": "JobPostings_GetJobPostings", "summary": "List jobs", "description": "List jobs for an organisation. App-scoped endpoint under `app/`. Belongs to the Job postings group. HTTP GET /app/organisations/{organisationId}/jobs.", "parameters": [ { "name": "organisationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/JobPostingDto" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/JobPostingDto" } } } } }, "401": { "description": "Missing or expired bearer token." }, "403": { "description": "The token's user cannot access this organisation or resource." } }, "security": [ { "bearerAuth": [] }, { "oauth2Password": [] } ], "x-raklet-access": "Premium plan (API access); token inherits the admin user's role permissions" } }, "/app/organisations/{organisationId}/jobs/{id}": { "get": { "tags": [ "JobPostings" ], "operationId": "JobPostings_GetJobPosting", "summary": "Get job", "description": "Get job for an organisation. App-scoped endpoint under `app/`. Belongs to the Job postings group. HTTP GET /app/organisations/{organisationId}/jobs/{id}.", "parameters": [ { "name": "organisationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobPostingDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/JobPostingDto" } } } }, "401": { "description": "Missing or expired bearer token." }, "403": { "description": "The token's user cannot access this organisation or resource." } }, "security": [ { "bearerAuth": [] }, { "oauth2Password": [] } ], "x-raklet-access": "Premium plan (API access); token inherits the admin user's role permissions" } }, "/app/organisations/{organisationId}/jobs/count": { "get": { "tags": [ "JobPostings" ], "operationId": "JobPostings_GetJobPostingsCount", "summary": "Count jobs", "description": "Count jobs for an organisation. App-scoped endpoint under `app/`. Belongs to the Job postings group. HTTP GET /app/organisations/{organisationId}/jobs/count.", "parameters": [ { "name": "organisationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "format": "int32", "type": "integer" } }, "text/json": { "schema": { "format": "int32", "type": "integer" } } } }, "401": { "description": "Missing or expired bearer token." }, "403": { "description": "The token's user cannot access this organisation or resource." } }, "security": [ { "bearerAuth": [] }, { "oauth2Password": [] } ], "x-raklet-access": "Premium plan (API access); token inherits the admin user's role permissions" } }, "/app/organisations/{organisationId}/jobseekers": { "get": { "tags": [ "JobSeekers" ], "operationId": "JobSeekers_GetJobPostings", "summary": "List jobseekers", "description": "List jobseekers for an organisation. App-scoped endpoint under `app/`. Belongs to the Job seekers group. HTTP GET /app/organisations/{organisationId}/jobseekers.", "parameters": [ { "name": "organisationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "startIndex", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "s", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/JobSeekersController_JobSeekerDto" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/JobSeekersController_JobSeekerDto" } } } } }, "401": { "description": "Missing or expired bearer token." }, "403": { "description": "The token's user cannot access this organisation or resource." } }, "security": [ { "bearerAuth": [] }, { "oauth2Password": [] } ], "x-raklet-access": "Premium plan (API access); token inherits the admin user's role permissions" } }, "/app/organisations/{organisationId}/jobseekers/count": { "get": { "tags": [ "JobSeekers" ], "operationId": "JobSeekers_GetJobPostingsCount", "summary": "Count jobseekers", "description": "Count jobseekers for an organisation. App-scoped endpoint under `app/`. Belongs to the Job seekers group. HTTP GET /app/organisations/{organisationId}/jobseekers/count.", "parameters": [ { "name": "organisationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "format": "int32", "type": "integer" } }, "text/json": { "schema": { "format": "int32", "type": "integer" } } } }, "401": { "description": "Missing or expired bearer token." }, "403": { "description": "The token's user cannot access this organisation or resource." } }, "security": [ { "bearerAuth": [] }, { "oauth2Password": [] } ], "x-raklet-access": "Premium plan (API access); token inherits the admin user's role permissions" } }, "/app/organisations/{organisationId}/events/submissions": { "post": { "tags": [ "MemberEventSubmissions" ], "operationId": "MemberEventSubmissions_Submit", "summary": "POST /api/app/organisations/{orgId}/events/submissions", "description": "POST /api/app/organisations/{orgId}/events/submissions for an organisation. App-scoped endpoint under `app/`. Belongs to the Member event submissions group. HTTP POST /app/organisations/{organisationId}/events/submissions.", "parameters": [ { "name": "organisationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MemberEventSubmissionCommand" } }, "text/json": { "schema": { "$ref": "#/components/schemas/MemberEventSubmissionCommand" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } }, "text/json": { "schema": { "type": "object" } } } }, "401": { "description": "Missing or expired bearer token." }, "403": { "description": "The token's user cannot access this organisation or resource." } }, "security": [ { "bearerAuth": [] }, { "oauth2Password": [] } ], "x-raklet-access": "Premium plan (API access); token inherits the admin user's role permissions" } }, "/app/organisations/{organisationId}/events/submissions/{id}": { "patch": { "tags": [ "MemberEventSubmissions" ], "operationId": "MemberEventSubmissions_Edit", "summary": "PATCH /api/app/organisations/{orgId}/events/submissions/{id}", "description": "PATCH /api/app/organisations/{orgId}/events/submissions/{id} for an organisation. App-scoped endpoint under `app/`. Belongs to the Member event submissions group. HTTP PATCH /app/organisations/{organisationId}/events/submissions/{id}.", "parameters": [ { "name": "organisationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MemberEventEditCommand" } }, "text/json": { "schema": { "$ref": "#/components/schemas/MemberEventEditCommand" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } }, "text/json": { "schema": { "type": "object" } } } }, "401": { "description": "Missing or expired bearer token." }, "403": { "description": "The token's user cannot access this organisation or resource." } }, "security": [ { "bearerAuth": [] }, { "oauth2Password": [] } ], "x-raklet-access": "Premium plan (API access); token inherits the admin user's role permissions" } }, "/app/organisations/{organisationId}/events/submissions/mine": { "get": { "tags": [ "MemberEventSubmissions" ], "operationId": "MemberEventSubmissions_Mine", "summary": "GET /api/app/organisations/{orgId}/events/submissions/mine", "description": "GET /api/app/organisations/{orgId}/events/submissions/mine for an organisation. App-scoped endpoint under `app/`. Belongs to the Member event submissions group. HTTP GET /app/organisations/{organisationId}/events/submissions/mine.", "parameters": [ { "name": "organisationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } }, "text/json": { "schema": { "type": "object" } } } }, "401": { "description": "Missing or expired bearer token." }, "403": { "description": "The token's user cannot access this organisation or resource." } }, "security": [ { "bearerAuth": [] }, { "oauth2Password": [] } ], "x-raklet-access": "Premium plan (API access); token inherits the admin user's role permissions" } }, "/app/organisations/{organisationId}/payments/{organisationMembershipId}/membershipFees": { "get": { "tags": [ "MembershipFees" ], "operationId": "MembershipFees_GetMembershipFees", "summary": "List membership fees", "description": "List membership fees for an organisation. App-scoped endpoint under `app/`. Belongs to the Membership fees group. HTTP GET /app/organisations/{organisationId}/payments/{organisationMembershipId}/membershipFees.", "parameters": [ { "name": "organisationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "organisationMembershipId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MembershipFeeDto" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MembershipFeeDto" } } } } }, "401": { "description": "Missing or expired bearer token." }, "403": { "description": "The token's user cannot access this organisation or resource." } }, "security": [ { "bearerAuth": [] }, { "oauth2Password": [] } ], "x-raklet-access": "Premium plan (API access); token inherits the admin user's role permissions" } }, "/app/organisations/{organisationId}/settings": { "get": { "tags": [ "OrganisationSettings" ], "operationId": "OrganisationSettings_GetOrganisationSettings", "summary": "List settings", "description": "List settings for an organisation. App-scoped endpoint under `app/`. Belongs to the Organisation settings group. HTTP GET /app/organisations/{organisationId}/settings.", "parameters": [ { "name": "organisationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OrganisationSettingsDto" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OrganisationSettingsDto" } } } } }, "401": { "description": "Missing or expired bearer token." }, "403": { "description": "The token's user cannot access this organisation or resource." } }, "security": [ { "bearerAuth": [] }, { "oauth2Password": [] } ], "x-raklet-access": "Premium plan (API access); token inherits the admin user's role permissions" } }, "/{permalink}/pages/{slug}": { "get": { "tags": [ "Page" ], "operationId": "Page_GetPage", "summary": "Get page", "description": "Get page. Belongs to the Page group. HTTP GET /{permalink}/pages/{slug}.", "parameters": [ { "name": "permalink", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "slug", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResult_PageDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiResult_PageDto" } } } }, "401": { "description": "Missing or expired bearer token." }, "403": { "description": "The token's user cannot access this organisation or resource." } }, "security": [ { "bearerAuth": [] }, { "oauth2Password": [] } ], "x-raklet-access": "Premium plan (API access); token inherits the admin user's role permissions" } }, "/app/organisations/{organisationId}/payments/{organisationMembershipId}": { "get": { "tags": [ "Payments" ], "operationId": "Payments_GetPayments", "summary": "Get payment", "description": "Get payment for an organisation. App-scoped endpoint under `app/`. Belongs to the Payments group. HTTP GET /app/organisations/{organisationId}/payments/{organisationMembershipId}.", "parameters": [ { "name": "organisationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "organisationMembershipId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PaymentDto" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PaymentDto" } } } } }, "401": { "description": "Missing or expired bearer token." }, "403": { "description": "The token's user cannot access this organisation or resource." } }, "security": [ { "bearerAuth": [] }, { "oauth2Password": [] } ], "x-raklet-access": "Premium plan (API access); token inherits the admin user's role permissions" } }, "/app/organisations/{organisationId}/creditCard/{organisationMembershipId}/paymentTickets/{id}": { "get": { "tags": [ "PaymentTickets" ], "operationId": "PaymentTickets_GetPaymentTicket", "summary": "Get payment ticket", "description": "Get payment ticket for an organisation. App-scoped endpoint under `app/`. Belongs to the Payment tickets group. HTTP GET /app/organisations/{organisationId}/creditCard/{organisationMembershipId}/paymentTickets/{id}.", "parameters": [ { "name": "organisationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "organisationMembershipId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentTicketDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaymentTicketDto" } } } }, "401": { "description": "Missing or expired bearer token." }, "403": { "description": "The token's user cannot access this organisation or resource." } }, "security": [ { "bearerAuth": [] }, { "oauth2Password": [] } ], "x-raklet-access": "Premium plan (API access); token inherits the admin user's role permissions" } }, "/app/organisations/{organisationId}/creditCard/{organisationMembershipId}/paymentTickets": { "post": { "tags": [ "PaymentTickets" ], "operationId": "PaymentTickets_PostPaymentTicket", "summary": "Create payment ticket", "description": "Create payment ticket for an organisation. App-scoped endpoint under `app/`. Belongs to the Payment tickets group. HTTP POST /app/organisations/{organisationId}/creditCard/{organisationMembershipId}/paymentTickets.", "parameters": [ { "name": "organisationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "organisationMembershipId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentTicketDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaymentTicketDto" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentTicketDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaymentTicketDto" } } } }, "401": { "description": "Missing or expired bearer token." }, "403": { "description": "The token's user cannot access this organisation or resource." } }, "security": [ { "bearerAuth": [] }, { "oauth2Password": [] } ], "x-raklet-access": "Premium plan (API access); token inherits the admin user's role permissions" } }, "/organisations/{organisationId}/posts": { "get": { "tags": [ "Posts" ], "operationId": "Posts_GetPosts", "summary": "List posts", "description": "List posts for an organisation. Belongs to the Posts group. HTTP GET /organisations/{organisationId}/posts.", "parameters": [ { "name": "organisationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "pageSize", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "searchText", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FilterResultDto_AnnouncementDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/FilterResultDto_AnnouncementDto" } } } }, "401": { "description": "Missing or expired bearer token." }, "403": { "description": "The token's user cannot access this organisation or resource." } }, "security": [ { "bearerAuth": [] }, { "oauth2Password": [] } ], "x-raklet-access": "Premium plan (API access); token inherits the admin user's role permissions" }, "post": { "tags": [ "Posts" ], "operationId": "Posts_CreatePost", "summary": "Create post", "description": "Create post for an organisation. Belongs to the Posts group. HTTP POST /organisations/{organisationId}/posts.", "parameters": [ { "name": "organisationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AnnouncementDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AnnouncementDto" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AnnouncementDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AnnouncementDto" } } } }, "401": { "description": "Missing or expired bearer token." }, "403": { "description": "The token's user cannot access this organisation or resource." } }, "security": [ { "bearerAuth": [] }, { "oauth2Password": [] } ], "x-raklet-access": "Premium plan (API access); token inherits the admin user's role permissions" } }, "/organisations/{organisationId}/posts/{postId}": { "get": { "tags": [ "Posts" ], "operationId": "Posts_GetPost", "summary": "Get post", "description": "Get post for an organisation. Belongs to the Posts group. HTTP GET /organisations/{organisationId}/posts/{postId}.", "parameters": [ { "name": "organisationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "postId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AnnouncementDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AnnouncementDto" } } } }, "401": { "description": "Missing or expired bearer token." }, "403": { "description": "The token's user cannot access this organisation or resource." } }, "security": [ { "bearerAuth": [] }, { "oauth2Password": [] } ], "x-raklet-access": "Premium plan (API access); token inherits the admin user's role permissions" }, "put": { "tags": [ "Posts" ], "operationId": "Posts_PutPost", "summary": "Update post", "description": "Update post for an organisation. Belongs to the Posts group. HTTP PUT /organisations/{organisationId}/posts/{postId}.", "parameters": [ { "name": "organisationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "postId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AnnouncementDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AnnouncementDto" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AnnouncementDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AnnouncementDto" } } } }, "401": { "description": "Missing or expired bearer token." }, "403": { "description": "The token's user cannot access this organisation or resource." } }, "security": [ { "bearerAuth": [] }, { "oauth2Password": [] } ], "x-raklet-access": "Premium plan (API access); token inherits the admin user's role permissions" }, "delete": { "tags": [ "Posts" ], "operationId": "Posts_DeletePost", "summary": "Delete post", "description": "Delete post for an organisation. Belongs to the Posts group. HTTP DELETE /organisations/{organisationId}/posts/{postId}.", "parameters": [ { "name": "organisationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "postId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AnnouncementDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AnnouncementDto" } } } }, "401": { "description": "Missing or expired bearer token." }, "403": { "description": "The token's user cannot access this organisation or resource." } }, "security": [ { "bearerAuth": [] }, { "oauth2Password": [] } ], "x-raklet-access": "Premium plan (API access); token inherits the admin user's role permissions" } }, "/organisations/{organisationId}/posts/{postId}/attachments": { "post": { "tags": [ "Posts" ], "operationId": "Posts_PostAttachment", "summary": "Create attachment", "description": "Create attachment for an organisation. Belongs to the Posts group. HTTP POST /organisations/{organisationId}/posts/{postId}/attachments.", "parameters": [ { "name": "organisationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "postId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AnnouncementAttachmentDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AnnouncementAttachmentDto" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AnnouncementAttachmentDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AnnouncementAttachmentDto" } } } }, "401": { "description": "Missing or expired bearer token." }, "403": { "description": "The token's user cannot access this organisation or resource." } }, "security": [ { "bearerAuth": [] }, { "oauth2Password": [] } ], "x-raklet-access": "Premium plan (API access); token inherits the admin user's role permissions" } }, "/organisations/{organisationId}/posts/{postId}/attachments/{attachmentId}": { "delete": { "tags": [ "Posts" ], "operationId": "Posts_DeletePostAttachment", "summary": "Delete attachment", "description": "Delete attachment for an organisation. Belongs to the Posts group. HTTP DELETE /organisations/{organisationId}/posts/{postId}/attachments/{attachmentId}.", "parameters": [ { "name": "organisationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "postId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "attachmentId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AnnouncementAttachmentDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AnnouncementAttachmentDto" } } } }, "401": { "description": "Missing or expired bearer token." }, "403": { "description": "The token's user cannot access this organisation or resource." } }, "security": [ { "bearerAuth": [] }, { "oauth2Password": [] } ], "x-raklet-access": "Premium plan (API access); token inherits the admin user's role permissions" } }, "/app/organisations/{organisationId}/schools": { "get": { "tags": [ "Schools" ], "operationId": "Schools_GetSchools", "summary": "List schools", "description": "List schools for an organisation. App-scoped endpoint under `app/`. Belongs to the Schools group. HTTP GET /app/organisations/{organisationId}/schools.", "parameters": [ { "name": "organisationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "startIndex", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "s", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SchoolDto" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SchoolDto" } } } } }, "401": { "description": "Missing or expired bearer token." }, "403": { "description": "The token's user cannot access this organisation or resource." } }, "security": [ { "bearerAuth": [] }, { "oauth2Password": [] } ], "x-raklet-access": "Premium plan (API access); token inherits the admin user's role permissions" } }, "/app/organisations/{organisationId}/schools/details": { "get": { "tags": [ "Schools" ], "operationId": "Schools_GetSchool", "summary": "Get details", "description": "Get details for an organisation. App-scoped endpoint under `app/`. Belongs to the Schools group. HTTP GET /app/organisations/{organisationId}/schools/details.", "parameters": [ { "name": "organisationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "name", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SchoolDto" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SchoolDto" } } } } }, "401": { "description": "Missing or expired bearer token." }, "403": { "description": "The token's user cannot access this organisation or resource." } }, "security": [ { "bearerAuth": [] }, { "oauth2Password": [] } ], "x-raklet-access": "Premium plan (API access); token inherits the admin user's role permissions" } }, "/app/organisations/{organisationId}/schools/count": { "get": { "tags": [ "Schools" ], "operationId": "Schools_GetSchoolCount", "summary": "Count schools", "description": "Count schools for an organisation. App-scoped endpoint under `app/`. Belongs to the Schools group. HTTP GET /app/organisations/{organisationId}/schools/count.", "parameters": [ { "name": "organisationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "format": "int32", "type": "integer" } }, "text/json": { "schema": { "format": "int32", "type": "integer" } } } }, "401": { "description": "Missing or expired bearer token." }, "403": { "description": "The token's user cannot access this organisation or resource." } }, "security": [ { "bearerAuth": [] }, { "oauth2Password": [] } ], "x-raklet-access": "Premium plan (API access); token inherits the admin user's role permissions" } }, "/search/organisations": { "post": { "tags": [ "Search" ], "operationId": "Search_SearchOrganisations", "summary": "Create organisation", "description": "Create organisation. Belongs to the Search group. HTTP POST /search/organisations.", "parameters": [ { "name": "q", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "pageSize", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResult_List_OrganisationDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiResult_List_OrganisationDto" } } } }, "401": { "description": "Missing or expired bearer token." }, "403": { "description": "The token's user cannot access this organisation or resource." } }, "security": [ { "bearerAuth": [] }, { "oauth2Password": [] } ], "x-raklet-access": "Premium plan (API access); token inherits the admin user's role permissions" } }, "/app/organisations/{organisationId}/sectors": { "get": { "tags": [ "Sectors" ], "operationId": "Sectors_GetSectors", "summary": "List sectors", "description": "List sectors for an organisation. App-scoped endpoint under `app/`. Belongs to the Sectors group. HTTP GET /app/organisations/{organisationId}/sectors.", "parameters": [ { "name": "organisationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "startIndex", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "s", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SectorDto" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SectorDto" } } } } }, "401": { "description": "Missing or expired bearer token." }, "403": { "description": "The token's user cannot access this organisation or resource." } }, "security": [ { "bearerAuth": [] }, { "oauth2Password": [] } ], "x-raklet-access": "Premium plan (API access); token inherits the admin user's role permissions" } }, "/app/organisations/{organisationId}/sectors/details": { "get": { "tags": [ "Sectors" ], "operationId": "Sectors_GetSector", "summary": "Get details", "description": "Get details for an organisation. App-scoped endpoint under `app/`. Belongs to the Sectors group. HTTP GET /app/organisations/{organisationId}/sectors/details.", "parameters": [ { "name": "organisationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "name", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SectorDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SectorDto" } } } }, "401": { "description": "Missing or expired bearer token." }, "403": { "description": "The token's user cannot access this organisation or resource." } }, "security": [ { "bearerAuth": [] }, { "oauth2Password": [] } ], "x-raklet-access": "Premium plan (API access); token inherits the admin user's role permissions" } }, "/app/organisations/{organisationId}/sectors/count": { "get": { "tags": [ "Sectors" ], "operationId": "Sectors_GetSectorsCount", "summary": "Count sectors", "description": "Count sectors for an organisation. App-scoped endpoint under `app/`. Belongs to the Sectors group. HTTP GET /app/organisations/{organisationId}/sectors/count.", "parameters": [ { "name": "organisationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "format": "int32", "type": "integer" } }, "text/json": { "schema": { "format": "int32", "type": "integer" } } } }, "401": { "description": "Missing or expired bearer token." }, "403": { "description": "The token's user cannot access this organisation or resource." } }, "security": [ { "bearerAuth": [] }, { "oauth2Password": [] } ], "x-raklet-access": "Premium plan (API access); token inherits the admin user's role permissions" } }, "/common/countryCodes": { "get": { "tags": [ "SelectList" ], "operationId": "SelectList_GetCountryCodes", "summary": "List country codes", "description": "List country codes. Belongs to the Select lists group. HTTP GET /common/countryCodes.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResult_Dictionary_String" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiResult_Dictionary_String" } } } }, "401": { "description": "Missing or expired bearer token." }, "403": { "description": "The token's user cannot access this organisation or resource." } }, "security": [ { "bearerAuth": [] }, { "oauth2Password": [] } ], "x-raklet-access": "Premium plan (API access); token inherits the admin user's role permissions" } }, "/common/countries": { "get": { "tags": [ "SelectList" ], "operationId": "SelectList_GetCountries", "summary": "List countries", "description": "List countries. Belongs to the Select lists group. HTTP GET /common/countries.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResult_Dictionary_String" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiResult_Dictionary_String" } } } }, "401": { "description": "Missing or expired bearer token." }, "403": { "description": "The token's user cannot access this organisation or resource." } }, "security": [ { "bearerAuth": [] }, { "oauth2Password": [] } ], "x-raklet-access": "Premium plan (API access); token inherits the admin user's role permissions" } }, "/common/states": { "get": { "tags": [ "SelectList" ], "operationId": "SelectList_GetStates", "summary": "List states", "description": "List states. Belongs to the Select lists group. HTTP GET /common/states.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResult_Dictionary_String_2" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiResult_Dictionary_String_2" } } } }, "401": { "description": "Missing or expired bearer token." }, "403": { "description": "The token's user cannot access this organisation or resource." } }, "security": [ { "bearerAuth": [] }, { "oauth2Password": [] } ], "x-raklet-access": "Premium plan (API access); token inherits the admin user's role permissions" } }, "/common/educationLevels": { "get": { "tags": [ "SelectList" ], "operationId": "SelectList_GetEducationLevels", "summary": "List education levels", "description": "List education levels. Belongs to the Select lists group. HTTP GET /common/educationLevels.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResult_Dictionary_String" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiResult_Dictionary_String" } } } }, "401": { "description": "Missing or expired bearer token." }, "403": { "description": "The token's user cannot access this organisation or resource." } }, "security": [ { "bearerAuth": [] }, { "oauth2Password": [] } ], "x-raklet-access": "Premium plan (API access); token inherits the admin user's role permissions" } }, "/common/languages": { "get": { "tags": [ "SelectList" ], "operationId": "SelectList_GetLanguages", "summary": "List languages", "description": "List languages. Belongs to the Select lists group. HTTP GET /common/languages.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResult_Dictionary_String" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiResult_Dictionary_String" } } } }, "401": { "description": "Missing or expired bearer token." }, "403": { "description": "The token's user cannot access this organisation or resource." } }, "security": [ { "bearerAuth": [] }, { "oauth2Password": [] } ], "x-raklet-access": "Premium plan (API access); token inherits the admin user's role permissions" } }, "/common/jobTypes": { "get": { "tags": [ "SelectList" ], "operationId": "SelectList_GetJobTypes", "summary": "List job types", "description": "List job types. Belongs to the Select lists group. HTTP GET /common/jobTypes.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResult_Dictionary_String" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiResult_Dictionary_String" } } } }, "401": { "description": "Missing or expired bearer token." }, "403": { "description": "The token's user cannot access this organisation or resource." } }, "security": [ { "bearerAuth": [] }, { "oauth2Password": [] } ], "x-raklet-access": "Premium plan (API access); token inherits the admin user's role permissions" } }, "/common/months": { "get": { "tags": [ "SelectList" ], "operationId": "SelectList_GetMonths", "summary": "List months", "description": "List months. Belongs to the Select lists group. HTTP GET /common/months.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResult_Dictionary_String" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiResult_Dictionary_String" } } } }, "401": { "description": "Missing or expired bearer token." }, "403": { "description": "The token's user cannot access this organisation or resource." } }, "security": [ { "bearerAuth": [] }, { "oauth2Password": [] } ], "x-raklet-access": "Premium plan (API access); token inherits the admin user's role permissions" } }, "/common/genders": { "get": { "tags": [ "SelectList" ], "operationId": "SelectList_GetGenders", "summary": "List genders", "description": "List genders. Belongs to the Select lists group. HTTP GET /common/genders.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResult_Dictionary_String" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiResult_Dictionary_String" } } } }, "401": { "description": "Missing or expired bearer token." }, "403": { "description": "The token's user cannot access this organisation or resource." } }, "security": [ { "bearerAuth": [] }, { "oauth2Password": [] } ], "x-raklet-access": "Premium plan (API access); token inherits the admin user's role permissions" } }, "/common/bloodTypes": { "get": { "tags": [ "SelectList" ], "operationId": "SelectList_GetBloodTypes", "summary": "List blood types", "description": "List blood types. Belongs to the Select lists group. HTTP GET /common/bloodTypes.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResult_Dictionary_String" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiResult_Dictionary_String" } } } }, "401": { "description": "Missing or expired bearer token." }, "403": { "description": "The token's user cannot access this organisation or resource." } }, "security": [ { "bearerAuth": [] }, { "oauth2Password": [] } ], "x-raklet-access": "Premium plan (API access); token inherits the admin user's role permissions" } }, "/common/maritalStatusTypes": { "get": { "tags": [ "SelectList" ], "operationId": "SelectList_GetMaritalStatusTypes", "summary": "List marital status types", "description": "List marital status types. Belongs to the Select lists group. HTTP GET /common/maritalStatusTypes.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResult_Dictionary_String" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiResult_Dictionary_String" } } } }, "401": { "description": "Missing or expired bearer token." }, "403": { "description": "The token's user cannot access this organisation or resource." } }, "security": [ { "bearerAuth": [] }, { "oauth2Password": [] } ], "x-raklet-access": "Premium plan (API access); token inherits the admin user's role permissions" } }, "/common/years": { "get": { "tags": [ "SelectList" ], "operationId": "SelectList_GetYears", "summary": "List years", "description": "List years. Belongs to the Select lists group. HTTP GET /common/years.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResult_Dictionary_String" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiResult_Dictionary_String" } } } }, "401": { "description": "Missing or expired bearer token." }, "403": { "description": "The token's user cannot access this organisation or resource." } }, "security": [ { "bearerAuth": [] }, { "oauth2Password": [] } ], "x-raklet-access": "Premium plan (API access); token inherits the admin user's role permissions" } }, "/organisations/{organisationId}/settings/connection": { "get": { "tags": [ "Settings" ], "operationId": "Settings_GetConnectionSettings", "summary": "List connection", "description": "List connection for an organisation. Belongs to the Settings group. HTTP GET /organisations/{organisationId}/settings/connection.", "parameters": [ { "name": "organisationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrganisationSettingsSocialNetworkDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OrganisationSettingsSocialNetworkDto" } } } }, "401": { "description": "Missing or expired bearer token." }, "403": { "description": "The token's user cannot access this organisation or resource." } }, "security": [ { "bearerAuth": [] }, { "oauth2Password": [] } ], "x-raklet-access": "Premium plan (API access); token inherits the admin user's role permissions" } }, "/organisations/{organisationId}/settings/messaging": { "get": { "tags": [ "Settings" ], "operationId": "Settings_GetMessagingSettings", "summary": "List messaging", "description": "List messaging for an organisation. Belongs to the Settings group. HTTP GET /organisations/{organisationId}/settings/messaging.", "parameters": [ { "name": "organisationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrganisationSettingsMessagingDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OrganisationSettingsMessagingDto" } } } }, "401": { "description": "Missing or expired bearer token." }, "403": { "description": "The token's user cannot access this organisation or resource." } }, "security": [ { "bearerAuth": [] }, { "oauth2Password": [] } ], "x-raklet-access": "Premium plan (API access); token inherits the admin user's role permissions" } }, "/organisations/{organisationId}/settings/fields": { "get": { "tags": [ "Settings" ], "operationId": "Settings_GetFields", "summary": "List fields", "description": "List fields for an organisation. Belongs to the Settings group. HTTP GET /organisations/{organisationId}/settings/fields.", "parameters": [ { "name": "organisationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "onlyEditableAttributes", "in": "query", "required": false, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FieldObject" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FieldObject" } } } } }, "401": { "description": "Missing or expired bearer token." }, "403": { "description": "The token's user cannot access this organisation or resource." } }, "security": [ { "bearerAuth": [] }, { "oauth2Password": [] } ], "x-raklet-access": "Premium plan (API access); token inherits the admin user's role permissions" } }, "/organisations/{organisationId}/subscriptions": { "get": { "tags": [ "Subscription" ], "operationId": "Subscription_GetSubscriptions", "summary": "List subscriptions", "description": "List subscriptions for an organisation. Belongs to the Subscription group. HTTP GET /organisations/{organisationId}/subscriptions.", "parameters": [ { "name": "organisationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResult_List_CustomMembershipDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiResult_List_CustomMembershipDto" } } } }, "401": { "description": "Missing or expired bearer token." }, "403": { "description": "The token's user cannot access this organisation or resource." } }, "security": [ { "bearerAuth": [] }, { "oauth2Password": [] } ], "x-raklet-access": "Premium plan (API access); token inherits the admin user's role permissions" }, "post": { "tags": [ "Subscription" ], "operationId": "Subscription_AddSubscription", "summary": "Create subscription", "description": "Create subscription for an organisation. Belongs to the Subscription group. HTTP POST /organisations/{organisationId}/subscriptions.", "parameters": [ { "name": "organisationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomMembershipDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomMembershipDto" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResult_CustomMembershipDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiResult_CustomMembershipDto" } } } }, "401": { "description": "Missing or expired bearer token." }, "403": { "description": "The token's user cannot access this organisation or resource." } }, "security": [ { "bearerAuth": [] }, { "oauth2Password": [] } ], "x-raklet-access": "Premium plan (API access); token inherits the admin user's role permissions" } }, "/organisations/{organisationId}/subscriptions/{subscriptionId}": { "get": { "tags": [ "Subscription" ], "operationId": "Subscription_GetSubscriptionById", "summary": "Get subscription", "description": "Get subscription for an organisation. Belongs to the Subscription group. HTTP GET /organisations/{organisationId}/subscriptions/{subscriptionId}.", "parameters": [ { "name": "organisationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "subscriptionId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResult_CustomMembershipDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiResult_CustomMembershipDto" } } } }, "401": { "description": "Missing or expired bearer token." }, "403": { "description": "The token's user cannot access this organisation or resource." } }, "security": [ { "bearerAuth": [] }, { "oauth2Password": [] } ], "x-raklet-access": "Premium plan (API access); token inherits the admin user's role permissions" }, "put": { "tags": [ "Subscription" ], "operationId": "Subscription_UpdateSubscription", "summary": "Update subscription", "description": "Update subscription for an organisation. Belongs to the Subscription group. HTTP PUT /organisations/{organisationId}/subscriptions/{subscriptionId}.", "parameters": [ { "name": "organisationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "subscriptionId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomMembershipDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomMembershipDto" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiResult" } } } }, "401": { "description": "Missing or expired bearer token." }, "403": { "description": "The token's user cannot access this organisation or resource." } }, "security": [ { "bearerAuth": [] }, { "oauth2Password": [] } ], "x-raklet-access": "Premium plan (API access); token inherits the admin user's role permissions" }, "delete": { "tags": [ "Subscription" ], "operationId": "Subscription_DeleteSubscription", "summary": "Delete subscription", "description": "Delete subscription for an organisation. Belongs to the Subscription group. HTTP DELETE /organisations/{organisationId}/subscriptions/{subscriptionId}.", "parameters": [ { "name": "organisationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "subscriptionId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiResult" } } } }, "401": { "description": "Missing or expired bearer token." }, "403": { "description": "The token's user cannot access this organisation or resource." } }, "security": [ { "bearerAuth": [] }, { "oauth2Password": [] } ], "x-raklet-access": "Premium plan (API access); token inherits the admin user's role permissions" } }, "/app/organisations/{organisationId}/tags": { "get": { "tags": [ "Tags" ], "operationId": "Tags_GetTags", "summary": "Return all visible tags in organisation. Take element size defined at web configurations", "description": "Return all visible tags in organisation. Take element size defined at web configurations for an organisation. App-scoped endpoint under `app/`. Belongs to the Tags group. HTTP GET /app/organisations/{organisationId}/tags.", "parameters": [ { "name": "organisationId", "in": "path", "required": true, "description": "Tags organisaiton Id", "schema": { "type": "string", "format": "uuid" } }, { "name": "startIndex", "in": "query", "required": false, "description": "Skip parameters value", "schema": { "type": "integer", "format": "int32" } }, { "name": "s", "in": "query", "required": false, "description": "Searcg tags who start with s parameter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TagDto" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TagDto" } } } } }, "401": { "description": "Missing or expired bearer token." }, "403": { "description": "The token's user cannot access this organisation or resource." } }, "security": [ { "bearerAuth": [] }, { "oauth2Password": [] } ], "x-raklet-access": "Premium plan (API access); token inherits the admin user's role permissions" } }, "/app/organisations/{organisationId}/tags/{id}": { "get": { "tags": [ "Tags" ], "operationId": "Tags_GetTagDetail", "summary": "Return visible tag and related profile visible members", "description": "Return visible tag and related profile visible members for an organisation. App-scoped endpoint under `app/`. Belongs to the Tags group. HTTP GET /app/organisations/{organisationId}/tags/{id}.", "parameters": [ { "name": "organisationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TagDto" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TagDto" } } } } }, "401": { "description": "Missing or expired bearer token." }, "403": { "description": "The token's user cannot access this organisation or resource." } }, "security": [ { "bearerAuth": [] }, { "oauth2Password": [] } ], "x-raklet-access": "Premium plan (API access); token inherits the admin user's role permissions" } }, "/app/organisations/{organisationId}/tags/count": { "get": { "tags": [ "Tags" ], "operationId": "Tags_GetTagsCount", "summary": "Return visible tag counts in organisation", "description": "Return visible tag counts in organisation for an organisation. App-scoped endpoint under `app/`. Belongs to the Tags group. HTTP GET /app/organisations/{organisationId}/tags/count.", "parameters": [ { "name": "organisationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "format": "int32", "type": "integer" } }, "text/json": { "schema": { "format": "int32", "type": "integer" } } } }, "401": { "description": "Missing or expired bearer token." }, "403": { "description": "The token's user cannot access this organisation or resource." } }, "security": [ { "bearerAuth": [] }, { "oauth2Password": [] } ], "x-raklet-access": "Premium plan (API access); token inherits the admin user's role permissions" } } }, "components": { "securitySchemes": { "bearerAuth": { "type": "http", "scheme": "bearer", "bearerFormat": "opaque", "description": "Access token from POST /token. The token inherits the admin user's role-based permissions in Raklet; there are no narrower scopes." }, "oauth2Password": { "type": "oauth2", "description": "OAuth 2.0 resource owner password grant against POST /token, using a Raklet admin user's email and password. Raklet does not define named scopes: every token is granted the full role-based permissions of the user it was issued to, so `scopes` is empty by design.", "flows": { "password": { "tokenUrl": "https://api.raklet.com/token", "scopes": {} } } } }, "schemas": { "RakletListResponse_ActionLogApiDto": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ActionLogApiDto" } }, "continuation": { "type": "string" }, "totalCount": { "format": "int32", "type": "integer" }, "paging": { "$ref": "#/components/schemas/PagingDto" }, "isValid": { "type": "boolean" }, "lastCreatedOnUnix": { "format": "int32", "type": "integer" } } }, "ActionLogApiDto": { "type": "object", "properties": { "id": { "type": "string" }, "actionKey": { "type": "string" }, "actionGroup": { "type": "string" }, "beforeActionDetails": { "type": "object", "additionalProperties": { "type": "object" } }, "afterActionDetails": { "type": "object", "additionalProperties": { "type": "object" } }, "actorType": { "type": "string" }, "actorOrganisationMembershipId": { "format": "uuid", "type": "string" }, "actorOrganisationMembershipInfo": { "$ref": "#/components/schemas/OrganisationMembershipInfo" }, "organisationMembershipId": { "format": "uuid", "type": "string" }, "organisationMembershipInfo": { "$ref": "#/components/schemas/OrganisationMembershipInfo" }, "createdOn": { "format": "date-time", "type": "string" }, "createdOnUnix": { "format": "int32", "type": "integer" } } }, "PagingDto": { "type": "object", "properties": { "totalRowCount": { "format": "int64", "type": "integer" }, "showingRowCount": { "format": "int64", "type": "integer" }, "offset": { "format": "int32", "type": "integer" }, "pageSize": { "format": "int32", "type": "integer" } } }, "OrganisationMembershipInfo": { "type": "object", "properties": { "email": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" } } }, "RakletListResponse_Dictionary_String": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "additionalProperties": { "type": "object" } } }, "continuation": { "type": "string" }, "totalCount": { "format": "int32", "type": "integer" }, "paging": { "$ref": "#/components/schemas/PagingDto" }, "isValid": { "type": "boolean" }, "lastCreatedOnUnix": { "format": "int32", "type": "integer" } } }, "DebtDto": { "type": "object", "properties": { "id": { "format": "uuid", "type": "string" }, "status": { "format": "int32", "enum": [ 0, 1, -1 ], "type": "integer" }, "isManuelEntry": { "type": "boolean" }, "createdOn": { "format": "date-time", "type": "string" }, "organisationMembershipId": { "format": "uuid", "type": "string" }, "amount": { "format": "double", "type": "number" }, "currency": { "format": "int32", "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62, 63, 64, 65, 66, 67, 68, 69, 70, 71, 72, 73, 74, 75, 76, 77, 78, 79, 80, 81, 82, 83, 84, 85, 86, 87, 88, 89, 90, 91, 92, 93, 94, 95, 96, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 112, 113, 114, 115, 116, 117, 118, 119, 120, 121, 122, 123, 124, 125, 126, 127, 128, 129, 130, 131, 132, 133, 134, 135, 136, 137 ], "type": "integer" }, "debtType": { "format": "int32", "enum": [ 0, 1, 2 ], "type": "integer" }, "year": { "format": "int32", "type": "integer" }, "month": { "format": "int32", "type": "integer" }, "description": { "type": "string" } } }, "DebtPostDto": { "type": "object", "properties": { "organisationMembershipId": { "format": "uuid", "type": "string" }, "amount": { "format": "double", "type": "number" }, "currency": { "format": "int32", "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62, 63, 64, 65, 66, 67, 68, 69, 70, 71, 72, 73, 74, 75, 76, 77, 78, 79, 80, 81, 82, 83, 84, 85, 86, 87, 88, 89, 90, 91, 92, 93, 94, 95, 96, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 112, 113, 114, 115, 116, 117, 118, 119, 120, 121, 122, 123, 124, 125, 126, 127, 128, 129, 130, 131, 132, 133, 134, 135, 136, 137 ], "type": "integer" }, "debtType": { "format": "int32", "enum": [ 0, 1, 2 ], "type": "integer" }, "year": { "format": "int32", "type": "integer" }, "month": { "format": "int32", "type": "integer" }, "description": { "type": "string" } } }, "DonationDto": { "type": "object", "properties": { "id": { "format": "uuid", "type": "string" }, "fullName": { "type": "string" }, "isManualPayment": { "type": "boolean" }, "isPublicDonation": { "type": "boolean" }, "isRecurring": { "type": "boolean" }, "createdOn": { "format": "date-time", "type": "string" }, "organisationMembershipId": { "format": "uuid", "type": "string" }, "donationCampaignId": { "format": "uuid", "type": "string" }, "amount": { "format": "double", "type": "number" }, "currency": { "format": "int32", "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62, 63, 64, 65, 66, 67, 68, 69, 70, 71, 72, 73, 74, 75, 76, 77, 78, 79, 80, 81, 82, 83, 84, 85, 86, 87, 88, 89, 90, 91, 92, 93, 94, 95, 96, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 112, 113, 114, 115, 116, 117, 118, 119, 120, 121, 122, 123, 124, 125, 126, 127, 128, 129, 130, 131, 132, 133, 134, 135, 136, 137 ], "type": "integer" }, "referenceNumber": { "type": "string" }, "paymentMethod": { "format": "int32", "enum": [ 0, 1, 2, 3, 4, 5, 10 ], "type": "integer" }, "paymentDate": { "format": "date-time", "type": "string" }, "isDonorNameHidden": { "type": "boolean" } } }, "DonationPostDto": { "type": "object", "properties": { "organisationMembershipId": { "format": "uuid", "type": "string" }, "donationCampaignId": { "format": "uuid", "type": "string" }, "amount": { "format": "double", "type": "number" }, "currency": { "format": "int32", "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62, 63, 64, 65, 66, 67, 68, 69, 70, 71, 72, 73, 74, 75, 76, 77, 78, 79, 80, 81, 82, 83, 84, 85, 86, 87, 88, 89, 90, 91, 92, 93, 94, 95, 96, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 112, 113, 114, 115, 116, 117, 118, 119, 120, 121, 122, 123, 124, 125, 126, 127, 128, 129, 130, 131, 132, 133, 134, 135, 136, 137 ], "type": "integer" }, "referenceNumber": { "type": "string" }, "paymentMethod": { "format": "int32", "enum": [ 0, 1, 2, 3, 4, 5, 10 ], "type": "integer" }, "paymentDate": { "format": "date-time", "type": "string" }, "isDonorNameHidden": { "type": "boolean" } } }, "AdminPaymentsController_AdminPaymentDto": { "required": [ "amount", "currency", "paymentMethod" ], "type": "object", "properties": { "id": { "format": "uuid", "type": "string" }, "memberName": { "type": "string" }, "isManualPayment": { "type": "boolean" }, "createdOn": { "format": "date-time", "type": "string" }, "organisationMembershipId": { "format": "uuid", "type": "string" }, "amount": { "format": "double", "type": "number" }, "currency": { "format": "int32", "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62, 63, 64, 65, 66, 67, 68, 69, 70, 71, 72, 73, 74, 75, 76, 77, 78, 79, 80, 81, 82, 83, 84, 85, 86, 87, 88, 89, 90, 91, 92, 93, 94, 95, 96, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 112, 113, 114, 115, 116, 117, 118, 119, 120, 121, 122, 123, 124, 125, 126, 127, 128, 129, 130, 131, 132, 133, 134, 135, 136, 137 ], "type": "integer" }, "referenceNumber": { "type": "string" }, "paymentMethod": { "format": "int32", "enum": [ 0, 1, 2, 3, 4, 5, 10 ], "type": "integer" }, "isRecurringPayment": { "type": "boolean" }, "paymentDate": { "format": "date-time", "type": "string" } } }, "AdminPaymentsController_AdminPaymentPostDto": { "required": [ "amount", "currency", "paymentMethod" ], "type": "object", "properties": { "organisationMembershipId": { "format": "uuid", "type": "string" }, "amount": { "format": "double", "type": "number" }, "currency": { "format": "int32", "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62, 63, 64, 65, 66, 67, 68, 69, 70, 71, 72, 73, 74, 75, 76, 77, 78, 79, 80, 81, 82, 83, 84, 85, 86, 87, 88, 89, 90, 91, 92, 93, 94, 95, 96, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 112, 113, 114, 115, 116, 117, 118, 119, 120, 121, 122, 123, 124, 125, 126, 127, 128, 129, 130, 131, 132, 133, 134, 135, 136, 137 ], "type": "integer" }, "referenceNumber": { "type": "string" }, "paymentMethod": { "format": "int32", "enum": [ 0, 1, 2, 3, 4, 5, 10 ], "type": "integer" }, "isRecurringPayment": { "type": "boolean" }, "paymentDate": { "format": "date-time", "type": "string" } } }, "RakletListResponse_CustomPlanDto": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/CustomPlanDto" } }, "continuation": { "type": "string" }, "totalCount": { "format": "int32", "type": "integer" }, "paging": { "$ref": "#/components/schemas/PagingDto" }, "isValid": { "type": "boolean" }, "lastCreatedOnUnix": { "format": "int32", "type": "integer" } } }, "CustomPlanDto": { "type": "object", "properties": { "planName": { "type": "string" }, "amount": { "format": "double", "type": "number" }, "description": { "type": "string" }, "membershipFeeInterval": { "type": "string" }, "membershipFeeIntervalCode": { "format": "int32", "enum": [ 0, 1, 2, 3 ], "type": "integer" }, "activeSubscriptions": { "format": "int32", "type": "integer" }, "isMembershipAutomationEnabled": { "type": "boolean" }, "benefits": { "type": "string" }, "renewalInterval": { "format": "int32", "type": "integer" }, "groupMembershipEnabled": { "type": "boolean" }, "paymentAccountId": { "format": "uuid", "type": "string" }, "currency": { "format": "int32", "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62, 63, 64, 65, 66, 67, 68, 69, 70, 71, 72, 73, 74, 75, 76, 77, 78, 79, 80, 81, 82, 83, 84, 85, 86, 87, 88, 89, 90, 91, 92, 93, 94, 95, 96, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 112, 113, 114, 115, 116, 117, 118, 119, 120, 121, 122, 123, 124, 125, 126, 127, 128, 129, 130, 131, 132, 133, 134, 135, 136, 137 ], "type": "integer" }, "hasSpecificStartDate": { "type": "boolean" }, "monthOfStartDate": { "format": "int32", "type": "integer" }, "dayOfStartDate": { "format": "int32", "type": "integer" }, "canPublicApply": { "type": "boolean" }, "canSocialNetworkApply": { "type": "boolean" }, "removeDebtAfterCancellation": { "type": "boolean" }, "paymentFailAction": { "format": "int32", "enum": [ 0, 1 ], "type": "integer" }, "signupFormEnabled": { "type": "boolean" }, "signupFormAutoApproval": { "type": "boolean" }, "maxGroupMemberCount": { "format": "int32", "type": "integer" }, "gracePeriod": { "format": "int32", "type": "integer" }, "freePeriodInDays": { "format": "int32", "type": "integer" }, "id": { "format": "uuid", "type": "string" } } }, "RakletActionResponse_CustomPlanDto": { "type": "object", "properties": { "isValid": { "type": "boolean" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ValidationError" } }, "warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ValidationWarning" } }, "id": { "type": "string" }, "data": { "$ref": "#/components/schemas/CustomPlanDto" } } }, "ValidationError": { "type": "object", "properties": { "fieldName": { "type": "string" }, "errorMessage": { "type": "string" }, "value": { "type": "object" } } }, "ValidationWarning": { "type": "object", "properties": { "name": { "type": "string" }, "value": { "type": "object" } } }, "AdminTagController_AdminTagDto": { "type": "object", "properties": { "id": { "format": "uuid", "type": "string" }, "name": { "type": "string" }, "isVisible": { "type": "boolean" }, "isMemberSelectable": { "type": "boolean" }, "organisationMembershipIds": { "type": "array", "items": { "format": "uuid", "type": "string" } }, "memberCount": { "format": "int32", "type": "integer" }, "lastModifiedOn": { "format": "date-time", "type": "string" }, "createdOn": { "format": "date-time", "type": "string" } } }, "AdminTagController_AdminPostTagDto": { "required": [ "name", "isVisible", "isMemberSelectable" ], "type": "object", "properties": { "name": { "type": "string" }, "isVisible": { "type": "boolean" }, "isMemberSelectable": { "type": "boolean" }, "organisationMembershipIds": { "type": "array", "items": { "format": "uuid", "type": "string" } } } }, "AdminTagController_AdminPostTagMemberListDto": { "type": "object", "properties": { "organisationMembershipIds": { "type": "array", "items": { "format": "uuid", "type": "string" } } } }, "AdminTagController_AdminTagMembersDto": { "type": "object", "properties": { "totalCount": { "format": "int32", "type": "integer" }, "page": { "format": "int32", "type": "integer" }, "pageSize": { "format": "int32", "type": "integer" }, "memberIds": { "type": "array", "items": { "format": "uuid", "type": "string" } } } }, "AuthModel": { "required": [ "organisationId", "apiToken" ], "type": "object", "properties": { "organisationId": { "format": "uuid", "type": "string" }, "apiToken": { "format": "uuid", "type": "string" } } }, "CategoryDto": { "required": [ "name" ], "type": "object", "properties": { "name": { "type": "string" }, "slug": { "type": "string" }, "description": { "type": "string" }, "imageFile": { "type": "string" }, "imageUrl": { "type": "string" }, "imageUrlS100": { "type": "string" }, "imageUrlS200": { "type": "string" }, "imageUrlS400": { "type": "string" }, "imageUrlS800": { "type": "string" }, "isDefault": { "type": "boolean" }, "hasUserAccess": { "type": "boolean" }, "url": { "type": "string" }, "planStatus": { "type": "string" }, "accessType": { "format": "int32", "enum": [ 0, 1, 2, 3, 4, 5 ], "type": "integer" }, "postCreatePermission": { "format": "int32", "enum": [ 0, 1, 2, 3 ], "type": "integer" }, "postApprovalRequired": { "type": "boolean" }, "postCommentCreatePermission": { "format": "int32", "enum": [ 0, 1, 2, 3 ], "type": "integer" }, "postCommentApprovalRequired": { "type": "boolean" }, "visibility": { "format": "int32", "enum": [ 0, 1, 2, 3 ], "type": "integer" }, "plans": { "type": "object", "additionalProperties": { "type": "boolean" } }, "members": { "type": "array", "items": { "format": "uuid", "type": "string" } }, "selectedMembers": { "type": "array", "items": { "$ref": "#/components/schemas/CategoryDto_MemberInfo" } }, "postLike": { "format": "int32", "enum": [ 0, 1 ], "type": "integer" }, "postComment": { "format": "int32", "enum": [ 0, 1 ], "type": "integer" }, "postShare": { "format": "int32", "enum": [ 0, 1 ], "type": "integer" }, "subscriberCount": { "format": "int32", "type": "integer" }, "layout": { "format": "int32", "enum": [ 0, 1 ], "type": "integer" }, "columns": { "format": "int32", "enum": [ 1, 2, 3 ], "type": "integer" }, "isVisibleOnTheFeed": { "type": "boolean" }, "isAutoSubscribeMembers": { "type": "boolean" }, "isShowSubscribersOnBoardPage": { "type": "boolean" }, "isDeleted": { "type": "boolean" }, "id": { "format": "uuid", "type": "string" } } }, "CategoryDto_MemberInfo": { "type": "object", "properties": { "id": { "type": "string" }, "fullName": { "type": "string" }, "email": { "type": "string" }, "pictureUrl": { "type": "string" } } }, "CityDto": { "type": "object", "properties": { "name": { "type": "string" }, "count": { "format": "int32", "type": "integer" }, "members": { "type": "array", "items": { "$ref": "#/components/schemas/CityMemberDto" } } } }, "CityMemberDto": { "type": "object", "properties": { "id": { "format": "uuid", "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "pictureUrl": { "type": "string" }, "title": { "type": "string" }, "fullName": { "type": "string" }, "type": { "format": "int32", "enum": [ 0, 1, 2, 3, 4, 5, 6 ], "type": "integer" } } }, "CompanyDto": { "type": "object", "properties": { "name": { "type": "string" }, "count": { "format": "int32", "type": "integer" }, "slug": { "type": "string", "readOnly": true }, "members": { "type": "array", "items": { "$ref": "#/components/schemas/CompanyMemberDto" } } } }, "CompanyMemberDto": { "type": "object", "properties": { "id": { "format": "uuid", "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "pictureUrl": { "type": "string" }, "title": { "type": "string" }, "fullName": { "type": "string" }, "type": { "format": "int32", "enum": [ 0, 1, 2, 3, 4, 5, 6 ], "type": "integer" }, "company": { "type": "string" }, "position": { "type": "string" }, "startYear": { "format": "int32", "type": "integer" }, "endYear": { "format": "int32", "type": "integer" } } }, "ApiResult_GenericFilterListDto_UpsertContactDto": { "type": "object", "properties": { "code": { "format": "int32", "type": "integer" }, "message": { "type": "string" }, "internalMessage": { "type": "string" }, "data": { "$ref": "#/components/schemas/GenericFilterListDto_UpsertContactDto" }, "paging": { "$ref": "#/components/schemas/PagingDto" }, "isSuccess": { "type": "boolean" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ErrorItem" } } } }, "GenericFilterListDto_UpsertContactDto": { "type": "object", "properties": { "continuation": { "format": "int32", "type": "integer" }, "paging": { "$ref": "#/components/schemas/PagingDto" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/UpsertContactDto" } }, "count": { "format": "int64", "type": "integer" }, "searchQuery": { "$ref": "#/components/schemas/SearchQuery" }, "elasticQuery": { "type": "string" } } }, "ErrorItem": { "type": "object", "properties": { "message": { "type": "string" }, "internalMessage": { "type": "string" }, "name": { "type": "string" } } }, "UpsertContactDto": { "type": "object", "properties": { "id": { "type": "string" }, "rakletId": { "type": "string" }, "organisationId": { "type": "string" }, "attributes": { "type": "object", "additionalProperties": { "type": "object" } }, "parentOrganisationMembershipName": { "type": "string" }, "phones": { "type": "array", "items": { "$ref": "#/components/schemas/PhoneImportDto" } }, "emails": { "type": "array", "items": { "$ref": "#/components/schemas/EmailImportDto" } }, "addresses": { "type": "array", "items": { "$ref": "#/components/schemas/AddressImportDto" } }, "educations": { "type": "array", "items": { "$ref": "#/components/schemas/EducationImportDto" } }, "works": { "type": "array", "items": { "$ref": "#/components/schemas/WorkImportDto" } }, "tags": { "type": "array", "items": { "type": "string" } }, "subscriptions": { "type": "array", "items": { "$ref": "#/components/schemas/CustomPlanImportDto" } }, "roles": { "type": "array", "items": { "$ref": "#/components/schemas/ElasticRoleDto" } }, "boards": { "type": "array", "items": { "$ref": "#/components/schemas/ElasticBoardDto" } } } }, "SearchQuery": { "type": "object", "properties": { "fieldNames": { "type": "array", "items": { "type": "string" } }, "includedIds": { "type": "array", "items": { "type": "string" } }, "excludedIds": { "type": "array", "items": { "type": "string" } }, "orderBy": { "$ref": "#/components/schemas/OrderBy" }, "predicates": { "type": "array", "items": { "$ref": "#/components/schemas/Predicate" } }, "isOr": { "type": "boolean" } } }, "PhoneImportDto": { "type": "object", "properties": { "countryCode": { "type": "string" }, "number": { "type": "string" }, "fullPhone": { "type": "string" }, "isActivated": { "type": "boolean" }, "phoneStatus": { "type": "string" }, "id": { "type": "string" } } }, "EmailImportDto": { "type": "object", "properties": { "emailAddress": { "type": "string" }, "isActivated": { "type": "boolean" }, "isValid": { "type": "boolean" }, "id": { "type": "string" } } }, "AddressImportDto": { "type": "object", "properties": { "fullAddress": { "type": "string" }, "details": { "type": "string" }, "postalCode": { "type": "string" }, "city": { "type": "string" }, "county": { "type": "string" }, "state": { "type": "string" }, "country": { "type": "string" }, "latitude": { "format": "double", "type": "number" }, "longitude": { "format": "double", "type": "number" }, "id": { "type": "string" } } }, "EducationImportDto": { "type": "object", "properties": { "school": { "type": "string" }, "department": { "type": "string" }, "faculty": { "type": "string" }, "educationLevel": { "type": "string" }, "startYear": { "format": "int32", "type": "integer" }, "endYear": { "format": "int32", "type": "integer" }, "city": { "type": "string" }, "country": { "type": "string" }, "createdOn": { "format": "date-time", "type": "string" }, "isCurrent": { "type": "boolean" }, "isLocked": { "type": "boolean" }, "id": { "type": "string" } } }, "WorkImportDto": { "type": "object", "properties": { "company": { "type": "string" }, "position": { "type": "string" }, "sector": { "type": "string" }, "startYear": { "format": "int32", "type": "integer" }, "startMonth": { "format": "int32", "type": "integer" }, "endYear": { "format": "int32", "type": "integer" }, "endMonth": { "format": "int32", "type": "integer" }, "city": { "type": "string" }, "country": { "type": "string" }, "createdOn": { "format": "date-time", "type": "string" }, "isCurrent": { "type": "boolean" }, "website": { "type": "string" }, "id": { "type": "string" } } }, "CustomPlanImportDto": { "type": "object", "properties": { "planId": { "type": "string" }, "planName": { "type": "string" }, "groupMembershipEnabled": { "type": "boolean" }, "groupMembershipPriceType": { "format": "int32", "enum": [ 1, 2 ], "type": "integer" }, "maxGroupMemberCount": { "format": "int32", "type": "integer" }, "isMembershipAutomationEnabled": { "type": "boolean" }, "planMembershipFee": { "format": "double", "type": "number" }, "membershipFeeInterval": { "type": "string" }, "renewalInterval": { "format": "int32", "type": "integer" }, "discountedPlanMembershipFee": { "format": "double", "type": "number" }, "currency": { "format": "int32", "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62, 63, 64, 65, 66, 67, 68, 69, 70, 71, 72, 73, 74, 75, 76, 77, 78, 79, 80, 81, 82, 83, 84, 85, 86, 87, 88, 89, 90, 91, 92, 93, 94, 95, 96, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 112, 113, 114, 115, 116, 117, 118, 119, 120, 121, 122, 123, 124, 125, 126, 127, 128, 129, 130, 131, 132, 133, 134, 135, 136, 137 ], "type": "integer" }, "startDate": { "format": "date-time", "type": "string" }, "endDate": { "format": "date-time", "type": "string" }, "renewalDate": { "format": "date-time", "type": "string" }, "status": { "type": "string" }, "subscriptionDebtsTotal": { "format": "double", "type": "number" }, "subscriptionPaymentsTotal": { "format": "double", "type": "number" }, "subscriptionBalance": { "format": "double", "type": "number" }, "childSubscriptions": { "type": "array", "items": { "$ref": "#/components/schemas/CustomPlanImportDto" } }, "parentMembershipId": { "format": "uuid", "type": "string" }, "parentContactId": { "format": "uuid", "type": "string" }, "parentContactName": { "type": "string" }, "contactId": { "format": "uuid", "type": "string" }, "contactName": { "type": "string" }, "id": { "type": "string" } } }, "ElasticRoleDto": { "type": "object", "properties": { "roleId": { "type": "string" }, "roleName": { "type": "string" }, "id": { "type": "string" } } }, "ElasticBoardDto": { "type": "object", "properties": { "boardId": { "type": "string" }, "boardName": { "type": "string" }, "id": { "type": "string" } } }, "OrderBy": { "type": "object", "properties": { "name": { "type": "string" }, "direction": { "type": "string" } } }, "Predicate": { "required": [ "comparison", "value" ], "type": "object", "properties": { "attribute": { "type": "string" }, "dataType": { "type": "string" }, "comparison": { "format": "int32", "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22 ], "type": "integer" }, "value": { "type": "object" }, "isOr": { "type": "boolean" }, "predicates": { "type": "array", "items": { "$ref": "#/components/schemas/Predicate" } }, "predicateScript": { "$ref": "#/components/schemas/PredicateScript" } } }, "PredicateScript": { "type": "object", "properties": { "script": { "type": "string" }, "params": { "type": "object", "additionalProperties": { "type": "object" } } } }, "UpdateContactDto": { "required": [ "firstName", "lastName", "language" ], "type": "object", "properties": { "emailAddress": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "maidenName": { "type": "string" }, "memberNo": { "type": "string" }, "pictureUrl": { "type": "string" }, "membershipDateUnix": { "format": "int32", "type": "integer" }, "decisionNumber": { "type": "string" }, "decisionDateUnix": { "format": "int32", "type": "integer" }, "title": { "type": "string" }, "about": { "type": "string" }, "language": { "type": "string" }, "gender": { "type": "string" }, "bloodType": { "type": "string" }, "birthDateUnix": { "format": "int32", "type": "integer" }, "birthPlace": { "type": "string" }, "nationalId": { "type": "string" }, "maritalStatus": { "type": "string" }, "marriageDateUnix": { "format": "int32", "type": "integer" }, "isWorkShared": { "type": "boolean" }, "isEducationShared": { "type": "boolean" }, "isMessagingEnabled": { "type": "boolean" }, "profileVisibility": { "format": "int32", "enum": [ 0, 1, 2 ], "type": "integer" }, "isLookingForAJob": { "type": "boolean" }, "lookingForAJobType": { "type": "string" }, "lookingJobDescription": { "type": "string" }, "phoneCountryCode": { "type": "string" }, "phoneNumber": { "type": "string" }, "phoneIsMobile": { "type": "boolean" }, "isTermsOfUseAccepted": { "type": "boolean" }, "isTermsOfUse2Accepted": { "type": "boolean" }, "type": { "format": "int32", "enum": [ 0, 1, 2, 3, 4, 5, 6 ], "type": "integer" }, "password": { "type": "string" }, "sendWelcomeEmail": { "type": "boolean" } } }, "ApiResult": { "type": "object", "properties": { "code": { "format": "int32", "type": "integer" }, "message": { "type": "string" }, "internalMessage": { "type": "string" }, "data": { "type": "object" }, "paging": { "$ref": "#/components/schemas/PagingDto" }, "isSuccess": { "type": "boolean" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ErrorItem" } } } }, "ApiResult_UpsertContactDto": { "type": "object", "properties": { "code": { "format": "int32", "type": "integer" }, "message": { "type": "string" }, "internalMessage": { "type": "string" }, "data": { "$ref": "#/components/schemas/UpsertContactDto" }, "paging": { "$ref": "#/components/schemas/PagingDto" }, "isSuccess": { "type": "boolean" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ErrorItem" } } } }, "ContactPhoto": { "type": "object", "properties": { "url": { "type": "string" } } }, "AddressDto": { "required": [ "details", "city", "country" ], "type": "object", "properties": { "details": { "pattern": "^[^<>]*$", "type": "string" }, "county": { "pattern": "^[^<>]*$", "type": "string" }, "postalCode": { "pattern": "^[^<>]*$", "type": "string" }, "city": { "pattern": "^[^<>]*$", "type": "string" }, "country": { "pattern": "^[^<>]*$", "type": "string" }, "state": { "pattern": "^[^<>]*$", "type": "string" }, "fullAddress": { "type": "string" }, "id": { "format": "uuid", "type": "string" } } }, "ApiResult_AddressDto": { "type": "object", "properties": { "code": { "format": "int32", "type": "integer" }, "message": { "type": "string" }, "internalMessage": { "type": "string" }, "data": { "$ref": "#/components/schemas/AddressDto" }, "paging": { "$ref": "#/components/schemas/PagingDto" }, "isSuccess": { "type": "boolean" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ErrorItem" } } } }, "EducationDto": { "required": [ "school" ], "type": "object", "properties": { "school": { "type": "string" }, "department": { "type": "string" }, "faculty": { "type": "string" }, "educationLevel": { "format": "int32", "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11 ], "type": "integer" }, "startYear": { "format": "int32", "type": "integer" }, "endYear": { "format": "int32", "type": "integer" }, "city": { "type": "string" }, "country": { "type": "string" }, "isLocked": { "type": "boolean" }, "id": { "format": "uuid", "type": "string" } } }, "ApiResult_EducationDto": { "type": "object", "properties": { "code": { "format": "int32", "type": "integer" }, "message": { "type": "string" }, "internalMessage": { "type": "string" }, "data": { "$ref": "#/components/schemas/EducationDto" }, "paging": { "$ref": "#/components/schemas/PagingDto" }, "isSuccess": { "type": "boolean" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ErrorItem" } } } }, "EmailDto": { "required": [ "emailAddress" ], "type": "object", "properties": { "emailAddress": { "type": "string", "x-pattern-dotnet": "(?:[a-zA-Z0-9\\p{L}\\p{M}!#$%&'*+/=?^_`{|}~-]+(?:\\.[a-zA-Z0-9\\p{L}\\p{M}!#$%&'*+/=?^_`{|}~-]+)*|\"(?:[\\x01-\\x08\\x0b\\x0c\\x0e-\\x1f\\x21\\x23-\\x5b\\x5d-\\x7f]|\\\\[\\x01-\\x09\\x0b\\x0c\\x0e-\\x7f])*\")@(?:(?:[a-zA-Z0-9\\p{L}\\p{M}](?:[a-zA-Z0-9\\p{L}\\p{M}-]*[a-zA-Z0-9\\p{L}\\p{M}])?\\.)+[a-zA-Z0-9\\p{L}\\p{M}](?:[a-zA-Z0-9\\p{L}\\p{M}-]*[a-zA-Z0-9\\p{L}\\p{M}])?|\\[(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?|[a-zA-Z0-9-]*[a-z0-9]:(?:[\\x01-\\x08\\x0b\\x0c\\x0e-\\x1f\\x21-\\x5a\\x53-\\x7f]|\\\\[\\x01-\\x09\\x0b\\x0c\\x0e-\\x7f])+)\\])" }, "emailStatus": { "format": "int32", "enum": [ 0, -1 ], "type": "integer" }, "isActivated": { "type": "boolean" }, "isPrimary": { "type": "boolean" }, "id": { "format": "uuid", "type": "string" } } }, "ApiResult_EmailDto": { "type": "object", "properties": { "code": { "format": "int32", "type": "integer" }, "message": { "type": "string" }, "internalMessage": { "type": "string" }, "data": { "$ref": "#/components/schemas/EmailDto" }, "paging": { "$ref": "#/components/schemas/PagingDto" }, "isSuccess": { "type": "boolean" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ErrorItem" } } } }, "PhoneDto": { "required": [ "countryCode", "number" ], "type": "object", "properties": { "countryCode": { "type": "string" }, "number": { "type": "string" }, "fullPhone": { "type": "string" }, "isActivated": { "type": "boolean" }, "isMobile": { "type": "boolean" }, "phoneStatus": { "format": "int32", "enum": [ 0, -1 ], "type": "integer" }, "isPrimary": { "type": "boolean" }, "id": { "format": "uuid", "type": "string" } } }, "ApiResult_PhoneDto": { "type": "object", "properties": { "code": { "format": "int32", "type": "integer" }, "message": { "type": "string" }, "internalMessage": { "type": "string" }, "data": { "$ref": "#/components/schemas/PhoneDto" }, "paging": { "$ref": "#/components/schemas/PagingDto" }, "isSuccess": { "type": "boolean" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ErrorItem" } } } }, "WorkDto": { "required": [ "company" ], "type": "object", "properties": { "company": { "type": "string" }, "position": { "type": "string" }, "sector": { "type": "string" }, "startYear": { "format": "int32", "type": "integer" }, "startMonth": { "format": "int32", "type": "integer" }, "endYear": { "format": "int32", "type": "integer" }, "endMonth": { "format": "int32", "type": "integer" }, "city": { "type": "string" }, "country": { "type": "string" }, "id": { "format": "uuid", "type": "string" } } }, "ApiResult_WorkDto": { "type": "object", "properties": { "code": { "format": "int32", "type": "integer" }, "message": { "type": "string" }, "internalMessage": { "type": "string" }, "data": { "$ref": "#/components/schemas/WorkDto" }, "paging": { "$ref": "#/components/schemas/PagingDto" }, "isSuccess": { "type": "boolean" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ErrorItem" } } } }, "CorporateMemberDto": { "type": "object", "properties": { "id": { "format": "uuid", "type": "string" }, "name": { "type": "string" }, "pictureUrl": { "type": "string" }, "memberCount": { "format": "int32", "type": "integer" }, "members": { "type": "array", "items": { "$ref": "#/components/schemas/CorporateMemberSubMemberDto" } } } }, "CorporateMemberSubMemberDto": { "type": "object", "properties": { "id": { "format": "uuid", "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "pictureUrl": { "type": "string" }, "title": { "type": "string" }, "fullName": { "type": "string" } } }, "CountryDto": { "type": "object", "properties": { "name": { "type": "string" }, "code": { "type": "string" }, "count": { "format": "int32", "type": "integer" }, "members": { "type": "array", "items": { "$ref": "#/components/schemas/CountryMemberDto" } } } }, "CountryMemberDto": { "type": "object", "properties": { "id": { "format": "uuid", "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "pictureUrl": { "type": "string" }, "title": { "type": "string" }, "fullName": { "type": "string" }, "type": { "format": "int32", "enum": [ 0, 1, 2, 3, 4, 5, 6 ], "type": "integer" } } }, "CreditCardInstallmentRequestDto": { "type": "object", "properties": { "cardNumber": { "type": "string" }, "price": { "format": "double", "type": "number" }, "paymentObjectId": { "type": "string" } } }, "CreditCardInstallmentResponseDto": { "type": "object", "properties": { "count": { "format": "int32", "type": "integer" }, "originalPrice": { "format": "double", "type": "number" }, "priceToPay": { "format": "double", "type": "number" }, "text": { "type": "string" } } }, "CreditCardChargeRequestDto": { "required": [ "cardNumber", "name", "expireYear", "expireMonth", "securityCode" ], "type": "object", "properties": { "cardNumber": { "type": "string" }, "name": { "type": "string" }, "expireYear": { "type": "string" }, "expireMonth": { "type": "string" }, "securityCode": { "type": "string" }, "creditCardTokenId": { "type": "string" }, "installmentCount": { "format": "int32", "type": "integer" }, "paymentObjectId": { "format": "uuid", "type": "string" }, "currency": { "format": "int32", "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62, 63, 64, 65, 66, 67, 68, 69, 70, 71, 72, 73, 74, 75, 76, 77, 78, 79, 80, 81, 82, 83, 84, 85, 86, 87, 88, 89, 90, 91, 92, 93, 94, 95, 96, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 112, 113, 114, 115, 116, 117, 118, 119, 120, 121, 122, 123, 124, 125, 126, 127, 128, 129, 130, 131, 132, 133, 134, 135, 136, 137 ], "type": "integer" }, "isCardSaveEnabled": { "type": "boolean" } } }, "CreditCardChargeResponseDto": { "type": "object", "properties": { "transactionId": { "type": "string" }, "isSucceded": { "type": "boolean" }, "errorMessage": { "type": "string" } } }, "DonationCampaignDto": { "type": "object", "properties": { "id": { "format": "uuid", "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "shortDescription": { "type": "string" }, "thumbnailUrl": { "type": "string" }, "imageUrl": { "type": "string" }, "imageThumbnailUrl": { "type": "string" }, "url": { "type": "string" }, "startDate": { "format": "date-time", "type": "string" }, "endDate": { "format": "date-time", "type": "string" }, "goal": { "format": "double", "type": "number" }, "publishedOn": { "format": "date-time", "type": "string" }, "backersCount": { "format": "int32", "type": "integer" }, "percentage": { "format": "double", "type": "number" }, "daysLeft": { "format": "int32", "type": "integer" }, "organisation": { "$ref": "#/components/schemas/OrganisationBasicDto" }, "donorList": { "type": "array", "items": { "$ref": "#/components/schemas/DonorDto" } } } }, "OrganisationBasicDto": { "type": "object", "properties": { "id": { "format": "uuid", "type": "string" }, "permalink": { "type": "string" }, "name": { "type": "string" }, "logoUrl": { "type": "string" }, "customDomain": { "type": "string" } } }, "DonorDto": { "type": "object", "properties": { "organisationMembershipId": { "format": "uuid", "type": "string" }, "fullName": { "type": "string" } } }, "EventDto": { "type": "object", "properties": { "id": { "format": "uuid", "type": "string" }, "categoryIds": { "type": "array", "items": { "format": "uuid", "type": "string" } }, "name": { "type": "string" }, "shortDescription": { "type": "string" }, "description": { "type": "string" }, "organisationId": { "format": "uuid", "type": "string" }, "organisationName": { "type": "string" }, "organisationPermalink": { "type": "string" }, "organisationLogoUrl": { "type": "string" }, "organisationCustomDomain": { "type": "string" }, "eventImageUrl": { "type": "string" }, "eventThumbnailUrl": { "type": "string" }, "startDateTime": { "format": "date-time", "type": "string" }, "startDateTimeUnix": { "format": "int64", "type": "integer" }, "endDateTime": { "format": "date-time", "type": "string" }, "endDateTimeUnix": { "format": "int64", "type": "integer" }, "salesEndDateTime": { "format": "date-time", "type": "string" }, "salesEndDateTimeUnix": { "format": "int64", "type": "integer" }, "timeZone": { "type": "string" }, "isTimeZoneSameWithOrganisation": { "type": "boolean" }, "address": { "type": "string" }, "county": { "type": "string" }, "city": { "type": "string" }, "country": { "type": "string" }, "currency": { "type": "string" }, "isTicketInfoRequired": { "type": "boolean" }, "availableTicketCount": { "format": "int32", "type": "integer" }, "soldTicketCount": { "format": "int32", "type": "integer" }, "isPublic": { "type": "boolean" }, "eventTicketOptionCount": { "format": "int32", "type": "integer" }, "eventTicketOptionDtos": { "type": "array", "items": { "$ref": "#/components/schemas/EventTicketOptionDto" } } } }, "EventTicketOptionDto": { "type": "object", "properties": { "id": { "format": "uuid", "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "price": { "format": "double", "type": "number" }, "minPrice": { "format": "double", "type": "number" }, "salesEndDate": { "format": "date-time", "type": "string" }, "accessType": { "type": "string" }, "ticketType": { "type": "string" }, "maxQuantity": { "format": "int32", "type": "integer" }, "availableTicketCount": { "format": "int32", "type": "integer" } } }, "EventTicketOrdersDto": { "type": "object", "properties": { "organisationMembershipId": { "format": "uuid", "type": "string" }, "eventTicketOrderDtos": { "type": "array", "items": { "$ref": "#/components/schemas/EventTicketOrderItemDto" } } } }, "EventTicketOrderItemDto": { "type": "object", "properties": { "id": { "format": "uuid", "type": "string" }, "count": { "format": "int32", "type": "integer" }, "price": { "format": "double", "type": "number" } } }, "EventTicketDto": { "type": "object", "properties": { "id": { "format": "uuid", "type": "string" }, "organisationId": { "format": "uuid", "type": "string" }, "eventId": { "format": "uuid", "type": "string" }, "organisationMembershipId": { "format": "uuid", "type": "string" }, "billingInfoFirstName": { "type": "string" }, "billingInfoLastName": { "type": "string" }, "billingInfoEmail": { "type": "string" }, "billingInfoPhone": { "type": "string" }, "billingInfoTaxNumber": { "type": "string" }, "billingInfoAddressDetail": { "type": "string" }, "billingInfoCity": { "type": "string" }, "billingInfoCountry": { "type": "string" }, "otherInfo": { "type": "string" }, "ticketInfoDtos": { "type": "array", "items": { "$ref": "#/components/schemas/EventTicketItemDto" } } } }, "EventTicketItemDto": { "type": "object", "properties": { "id": { "format": "uuid", "type": "string" }, "ticketOptionId": { "type": "string" }, "ticketName": { "type": "string" }, "price": { "format": "double", "type": "number" }, "currency": { "format": "int32", "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62, 63, 64, 65, 66, 67, 68, 69, 70, 71, 72, 73, 74, 75, 76, 77, 78, 79, 80, 81, 82, 83, 84, 85, 86, 87, 88, 89, 90, 91, 92, 93, 94, 95, 96, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 112, 113, 114, 115, 116, 117, 118, 119, 120, 121, 122, 123, 124, 125, 126, 127, 128, 129, 130, 131, 132, 133, 134, 135, 136, 137 ], "type": "integer" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "email": { "type": "string" }, "phone": { "type": "string" }, "companyName": { "type": "string" }, "accessType": { "format": "int32", "enum": [ 0, 1, 2 ], "type": "integer" }, "ticketType": { "format": "int32", "enum": [ 0, 1, 2 ], "type": "integer" }, "ticketSalesType": { "format": "int32", "enum": [ 0, 1, 2 ], "type": "integer" }, "isCheckIn": { "type": "boolean" } } }, "CreditCardChargeTicketRequestDto": { "required": [ "createdOn" ], "type": "object", "properties": { "id": { "format": "uuid", "type": "string" }, "amount": { "format": "double", "type": "number" }, "currency": { "format": "int32", "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62, 63, 64, 65, 66, 67, 68, 69, 70, 71, 72, 73, 74, 75, 76, 77, 78, 79, 80, 81, 82, 83, 84, 85, 86, 87, 88, 89, 90, 91, 92, 93, 94, 95, 96, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 112, 113, 114, 115, 116, 117, 118, 119, 120, 121, 122, 123, 124, 125, 126, 127, 128, 129, 130, 131, 132, 133, 134, 135, 136, 137 ], "type": "integer" }, "organisationMembershipId": { "format": "uuid", "type": "string" }, "organisationMembership": { "$ref": "#/components/schemas/OrganisationMembership" }, "ticketPaymentId": { "format": "uuid", "type": "string" }, "paymentType": { "format": "int32", "enum": [ 0, 1, 2, 3 ], "type": "integer" }, "createdOn": { "format": "date-time", "type": "string" }, "installmentCount": { "format": "int32", "type": "integer" }, "name": { "type": "string" }, "cardNumber": { "type": "string" }, "ipAddress": { "type": "string" }, "expireMonth": { "type": "string" }, "expireYear": { "type": "string" }, "securityCode": { "type": "string" }, "isCardSaveEnabled": { "type": "boolean" } } }, "OrganisationMembership": { "required": [ "firstName", "lastName", "language", "organisationId", "createdOn", "lastModifiedOn" ], "type": "object", "properties": { "id": { "format": "uuid", "type": "string" }, "firstName": { "pattern": "^[^<>]*$", "type": "string" }, "lastName": { "pattern": "^[^<>]*$", "type": "string" }, "about": { "pattern": "^[^<>]*$", "type": "string" }, "language": { "type": "string" }, "nationalId": { "pattern": "^[^<>]*$", "type": "string" }, "taxNumber": { "pattern": "^[^<>]*$", "type": "string" }, "memberNo": { "type": "string" }, "memberNoInt": { "format": "int32", "type": "integer" }, "memberNoSortable": { "type": "string" }, "membershipDate": { "format": "date-time", "type": "string" }, "title": { "pattern": "^[^<>]*$", "type": "string" }, "pictureUrl": { "type": "string" }, "balance": { "format": "double", "type": "number" }, "paymentsTotal": { "format": "double", "type": "number" }, "debtTotal": { "format": "double", "type": "number" }, "status": { "format": "int32", "enum": [ 0, -4, -3, -2, -1 ], "type": "integer" }, "type": { "format": "int32", "enum": [ 0, 1, 2, 3, 4, 5, 6 ], "type": "integer" }, "state": { "format": "int32", "enum": [ 0, -9 ], "type": "integer" }, "profileViewCount": { "format": "int32", "type": "integer" }, "customAttributesValues": { "type": "string" }, "name": { "type": "string" }, "website": { "type": "string" }, "isCorporateResponsible": { "type": "boolean" }, "customMemberTypeId": { "format": "uuid", "type": "string" }, "organisationId": { "format": "uuid", "type": "string" }, "organisation": { "$ref": "#/components/schemas/Organisation" }, "primaryEmailId": { "format": "uuid", "type": "string" }, "emailAddress": { "type": "string", "x-pattern-dotnet": "(?:[a-zA-Z0-9\\p{L}\\p{M}!#$%&'*+/=?^_`{|}~-]+(?:\\.[a-zA-Z0-9\\p{L}\\p{M}!#$%&'*+/=?^_`{|}~-]+)*|\"(?:[\\x01-\\x08\\x0b\\x0c\\x0e-\\x1f\\x21\\x23-\\x5b\\x5d-\\x7f]|\\\\[\\x01-\\x09\\x0b\\x0c\\x0e-\\x7f])*\")@(?:(?:[a-zA-Z0-9\\p{L}\\p{M}](?:[a-zA-Z0-9\\p{L}\\p{M}-]*[a-zA-Z0-9\\p{L}\\p{M}])?\\.)+[a-zA-Z0-9\\p{L}\\p{M}](?:[a-zA-Z0-9\\p{L}\\p{M}-]*[a-zA-Z0-9\\p{L}\\p{M}])?|\\[(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?|[a-zA-Z0-9-]*[a-z0-9]:(?:[\\x01-\\x08\\x0b\\x0c\\x0e-\\x1f\\x21-\\x5a\\x53-\\x7f]|\\\\[\\x01-\\x09\\x0b\\x0c\\x0e-\\x7f])+)\\])" }, "primaryPhoneId": { "format": "uuid", "type": "string" }, "phoneCountryCode": { "type": "string" }, "phoneNumber": { "type": "string" }, "phoneIsMobile": { "type": "boolean" }, "primaryAddressId": { "format": "uuid", "type": "string" }, "addressDetails": { "type": "string" }, "addressCounty": { "type": "string" }, "addressPostalCode": { "type": "string" }, "addressCity": { "type": "string" }, "addressState": { "type": "string" }, "addressCountry": { "type": "string" }, "username": { "type": "string" }, "password": { "type": "string" }, "passwordSalt": { "type": "string" }, "decisionNumber": { "type": "string" }, "decisionDate": { "format": "date-time", "type": "string" }, "resignDate": { "format": "date-time", "type": "string" }, "resignReason": { "type": "string" }, "resignDecisionNumber": { "type": "string" }, "maritalStatus": { "format": "int32", "enum": [ 0, 1, 2, 3, 4, 5, 6 ], "type": "integer" }, "marriageDate": { "format": "date-time", "type": "string" }, "maidenName": { "type": "string" }, "isWorkShared": { "type": "boolean" }, "isEducationShared": { "type": "boolean" }, "isGroupShared": { "type": "boolean" }, "isMessagingEnabled": { "type": "boolean" }, "isProfileVisible": { "type": "boolean" }, "isLookingForAJob": { "type": "boolean" }, "lookingForAJobType": { "format": "int32", "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8 ], "type": "integer" }, "lookingJobDescription": { "maxLength": 60, "minLength": 0, "type": "string" }, "isEmailShared": { "type": "boolean" }, "isPhoneShared": { "type": "boolean" }, "isAddressShared": { "type": "boolean" }, "isProfileHelpShown": { "type": "boolean" }, "isContactInfoHelpShown": { "type": "boolean" }, "birthDate": { "format": "date-time", "type": "string" }, "birthPlace": { "pattern": "^[^<>]*$", "type": "string" }, "gender": { "format": "int32", "enum": [ 0, 1, 2, 3, 4 ], "type": "integer" }, "bloodType": { "format": "int32", "enum": [ 0, 1, 2, 3, 4, -4, -3, -2, -1 ], "type": "integer" }, "lastLoggedOn": { "format": "date-time", "type": "string" }, "createdOn": { "format": "date-time", "type": "string" }, "lastModifiedOn": { "format": "date-time", "type": "string" }, "statusOnDate": { "format": "date-time", "type": "string" }, "nuxId": { "format": "uuid", "type": "string" }, "isTermsOfUseAccepted": { "type": "boolean" }, "isTermsOfUse2Accepted": { "type": "boolean" }, "termsOfUseAcceptedDate": { "format": "date-time", "type": "string" }, "termsOfUseAcceptedIpAddress": { "type": "string" }, "addressCountrySlug": { "type": "string" }, "addressCitySlug": { "type": "string" }, "facebookUrl": { "type": "string" }, "linkedInUrl": { "type": "string" }, "twitterUrl": { "type": "string" }, "instagramUrl": { "type": "string" }, "segments": { "type": "array", "items": { "$ref": "#/components/schemas/Segment" } }, "customMemberships": { "type": "array", "items": { "$ref": "#/components/schemas/CustomMembership" } }, "emails": { "type": "array", "items": { "$ref": "#/components/schemas/Email" } }, "phones": { "type": "array", "items": { "$ref": "#/components/schemas/Phone" } }, "addresses": { "type": "array", "items": { "$ref": "#/components/schemas/Address" } }, "works": { "type": "array", "items": { "$ref": "#/components/schemas/Work" } }, "educations": { "type": "array", "items": { "$ref": "#/components/schemas/Education" } }, "groupMemberships": { "type": "array", "items": { "$ref": "#/components/schemas/GroupMembership" } }, "payments": { "type": "array", "items": { "$ref": "#/components/schemas/Payment" } }, "membershipFees": { "type": "array", "items": { "$ref": "#/components/schemas/MembershipFee" } }, "roles": { "type": "array", "items": { "$ref": "#/components/schemas/Role" } }, "smses": { "type": "array", "items": { "$ref": "#/components/schemas/Sms" } }, "mails": { "type": "array", "items": { "$ref": "#/components/schemas/Mail" } }, "paymentTickets": { "type": "array", "items": { "$ref": "#/components/schemas/PaymentTicket" } }, "tags": { "type": "array", "items": { "$ref": "#/components/schemas/Tag" } }, "newsletters": { "type": "array", "items": { "$ref": "#/components/schemas/Newsletter" } }, "activities": { "type": "array", "items": { "$ref": "#/components/schemas/OrganisationMembershipActivity" } }, "checkIns": { "type": "array", "items": { "$ref": "#/components/schemas/CheckIn" } }, "loginActivities": { "type": "array", "items": { "$ref": "#/components/schemas/LoginActivity" } }, "unsubscribes": { "type": "array", "items": { "$ref": "#/components/schemas/Unsubscribe" } }, "conversationMembers": { "type": "array", "items": { "$ref": "#/components/schemas/ConversationMember" } }, "notes": { "type": "array", "items": { "$ref": "#/components/schemas/Note" } }, "paymentMatches": { "type": "array", "items": { "$ref": "#/components/schemas/PaymentMatch" } }, "bulkEmails": { "type": "array", "items": { "$ref": "#/components/schemas/BulkEmail" } }, "jobPostings": { "type": "array", "items": { "$ref": "#/components/schemas/JobPosting" } }, "offeredServices": { "type": "array", "items": { "$ref": "#/components/schemas/OfferedService" } }, "supportTicketMessages": { "type": "array", "items": { "$ref": "#/components/schemas/SupportTicketMessage" } }, "parentOrganisationMembershipId": { "format": "uuid", "type": "string" }, "parentOrganisationMembership": { "$ref": "#/components/schemas/OrganisationMembership" }, "childOrganisationMemberships": { "type": "array", "items": { "$ref": "#/components/schemas/OrganisationMembership" } }, "organisationMembershipFiles": { "type": "array", "items": { "$ref": "#/components/schemas/OrganisationMembershipFile" } }, "familyMembers": { "type": "array", "items": { "$ref": "#/components/schemas/FamilyMember" } }, "debts": { "type": "array", "items": { "$ref": "#/components/schemas/Debt" } }, "eventV2Tickets": { "type": "array", "items": { "$ref": "#/components/schemas/EventV2Ticket" } }, "memberSelectors": { "type": "array", "items": { "$ref": "#/components/schemas/MemberSelector" } }, "isUnsubscribeFromAllSms": { "type": "boolean" }, "smsBlastCategoryUnsubscribes": { "type": "array", "items": { "$ref": "#/components/schemas/SmsBlastCategoryUnsubscribe" } }, "creditCardTokens": { "type": "array", "items": { "$ref": "#/components/schemas/CreditCardToken" } }, "creditCardSubscriptions": { "type": "array", "items": { "$ref": "#/components/schemas/CreditCardSubscription" } }, "contactCategories": { "type": "array", "items": { "$ref": "#/components/schemas/ContactCategory" } }, "dataExportLogs": { "type": "array", "items": { "$ref": "#/components/schemas/DataExportLog" } }, "dataImportLogs": { "type": "array", "items": { "$ref": "#/components/schemas/DataImportLog" } }, "smsCreditPurchases": { "type": "array", "items": { "$ref": "#/components/schemas/SmsCreditPurchase" } }, "announcements": { "type": "array", "items": { "$ref": "#/components/schemas/Announcement" } }, "categorySubscribers": { "type": "array", "items": { "$ref": "#/components/schemas/CategorySubscriber" } }, "announcementSubscribers": { "type": "array", "items": { "$ref": "#/components/schemas/AnnouncementSubscriber" } }, "announcementComments": { "type": "array", "items": { "$ref": "#/components/schemas/AnnouncementComment" } }, "announcementLikes": { "type": "array", "items": { "$ref": "#/components/schemas/AnnouncementLike" } }, "announcementCommentLikes": { "type": "array", "items": { "$ref": "#/components/schemas/AnnouncementCommentLike" } }, "announcementCommentAttachments": { "type": "array", "items": { "$ref": "#/components/schemas/AnnouncementCommentAttachment" } }, "profileVisibility": { "format": "int32", "enum": [ 0, 1, 2 ], "type": "integer" }, "fullName": { "type": "string", "readOnly": true }, "fullPhone": { "type": "string", "readOnly": true }, "fullAddress": { "type": "string", "readOnly": true }, "isSmsSendable": { "type": "boolean", "readOnly": true } } }, "Organisation": { "required": [ "name", "shortName", "permalink", "language", "timeZoneId" ], "type": "object", "properties": { "id": { "format": "uuid", "type": "string" }, "name": { "pattern": "^[^<>]*$", "type": "string" }, "shortName": { "pattern": "^[^<>]*$", "type": "string" }, "permalink": { "type": "string" }, "language": { "type": "string" }, "timeZoneId": { "type": "string" }, "dateFormat": { "type": "string" }, "timeFormat": { "type": "string" }, "stripeCustomerId": { "type": "string" }, "stripePlanId": { "type": "string" }, "activeUntil": { "format": "date-time", "type": "string" }, "systemAttributes": { "type": "string" }, "customAttributes": { "type": "string" }, "organisationColor1": { "type": "string" }, "organisationColor2": { "type": "string" }, "categoryPrimary": { "type": "string" }, "categorySecondary": { "type": "string" }, "companySize": { "type": "string" }, "howDidYouHearUs": { "type": "string" }, "currency": { "format": "int32", "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62, 63, 64, 65, 66, 67, 68, 69, 70, 71, 72, 73, 74, 75, 76, 77, 78, 79, 80, 81, 82, 83, 84, 85, 86, 87, 88, 89, 90, 91, 92, 93, 94, 95, 96, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 112, 113, 114, 115, 116, 117, 118, 119, 120, 121, 122, 123, 124, 125, 126, 127, 128, 129, 130, 131, 132, 133, 134, 135, 136, 137 ], "type": "integer" }, "state": { "format": "int32", "enum": [ 0, -9 ], "type": "integer" }, "logoUrl": { "type": "string" }, "logoWidth": { "format": "int32", "type": "integer" }, "logoHeight": { "format": "int32", "type": "integer" }, "loginPageTitle": { "pattern": "^[^<>]*$", "type": "string" }, "isDeleted": { "type": "boolean" }, "createdOn": { "format": "date-time", "type": "string" }, "smsProfit": { "format": "double", "type": "number" }, "invoiceAddress": { "type": "string" }, "invoiceText": { "type": "string" }, "isPaymentRequiredForAccess": { "type": "boolean" }, "isLoginSocialNetworkEnabled": { "type": "boolean" }, "isLoginSmsEnabled": { "type": "boolean" }, "isLoginPasswordEnabled": { "type": "boolean" }, "isLoginWithOneTimeLoginEnabled": { "type": "boolean" }, "isLoginTwoFactorEnabled": { "type": "boolean" }, "isMemberListVisible": { "type": "boolean" }, "isCompanyListVisible": { "type": "boolean" }, "isSectorListVisible": { "type": "boolean" }, "isSchoolListVisible": { "type": "boolean" }, "isCityListVisible": { "type": "boolean" }, "isCountryListVisible": { "type": "boolean" }, "isJobPostingsEnabled": { "type": "boolean" }, "isOfferedServicesEnabled": { "type": "boolean" }, "isApplicationFormEnabled": { "type": "boolean" }, "isSignupFormEnabled": { "type": "boolean" }, "applicationFormTitle": { "type": "string" }, "applicationFormHeader": { "type": "string" }, "applicationFormFooter": { "type": "string" }, "applicationFormBenefits": { "type": "string" }, "membershipTerms": { "type": "string" }, "termsOfUseApp": { "type": "string" }, "termsOfUse2App": { "type": "string" }, "applicationFormIsAddressEnabled": { "type": "boolean" }, "applicationFormIsCommentsEnabled": { "type": "boolean" }, "applicationFormIsGenderEnabled": { "type": "boolean" }, "applicationFormIsBirthDateEnabled": { "type": "boolean" }, "applicationFormIsBirthPlaceEnabled": { "type": "boolean" }, "applicationFormIsNationalityEnabled": { "type": "boolean" }, "applicationFormIsNationalIdEnabled": { "type": "boolean" }, "applicationFormIsTaxNumberEnabled": { "type": "boolean" }, "applicationFormIsUnder18ControlEnabled": { "type": "boolean" }, "applicationFormIsCreditCardFormEnabled": { "type": "boolean" }, "applicationFormRegistrationFee": { "format": "double", "type": "number" }, "applicationFormAgreement": { "type": "string" }, "applicationFormCustomAttributes": { "type": "string" }, "smsIsEnabled": { "type": "boolean" }, "isPaymentEnabled": { "type": "boolean" }, "isDonationEnabled": { "type": "boolean" }, "isCustomPaymentEnabled": { "type": "boolean" }, "paymentHeader": { "type": "string" }, "paymentFooter": { "type": "string" }, "isManualPayoutsEnabled": { "type": "boolean" }, "isPayUEnabled": { "type": "boolean" }, "isMikroOdemeEnabled": { "type": "boolean" }, "mikroOdemeUsername": { "pattern": "^[^<>]*$", "type": "string" }, "mikroOdemePassword": { "pattern": "^[^<>]*$", "type": "string" }, "isPayPalEnabled": { "type": "boolean" }, "paypalMerchantId": { "pattern": "^[^<>]*$", "type": "string" }, "isOnlineCreditCardEnabled": { "type": "boolean" }, "onlineCreditCardSubMerchantId": { "pattern": "^[^<>]*$", "type": "string" }, "creditCardProcessor": { "format": "int32", "enum": [ 0, 1, 2, 4, 5, 6 ], "type": "integer" }, "defaultPaymentAccountId": { "format": "uuid", "type": "string" }, "defaultDonationPaymentAccountId": { "format": "uuid", "type": "string" }, "commissionRate": { "format": "double", "type": "number" }, "commissionFee": { "format": "double", "type": "number" }, "commissionFeeCurrency": { "format": "int32", "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62, 63, 64, 65, 66, 67, 68, 69, 70, 71, 72, 73, 74, 75, 76, 77, 78, 79, 80, 81, 82, 83, 84, 85, 86, 87, 88, 89, 90, 91, 92, 93, 94, 95, 96, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 112, 113, 114, 115, 116, 117, 118, 119, 120, 121, 122, 123, 124, 125, 126, 127, 128, 129, 130, 131, 132, 133, 134, 135, 136, 137 ], "type": "integer" }, "isPublicDonationEnabled": { "type": "boolean" }, "organisationSupportEmail": { "type": "string", "x-pattern-dotnet": "(?:[a-zA-Z0-9\\p{L}\\p{M}!#$%&'*+/=?^_`{|}~-]+(?:\\.[a-zA-Z0-9\\p{L}\\p{M}!#$%&'*+/=?^_`{|}~-]+)*|\"(?:[\\x01-\\x08\\x0b\\x0c\\x0e-\\x1f\\x21\\x23-\\x5b\\x5d-\\x7f]|\\\\[\\x01-\\x09\\x0b\\x0c\\x0e-\\x7f])*\")@(?:(?:[a-zA-Z0-9\\p{L}\\p{M}](?:[a-zA-Z0-9\\p{L}\\p{M}-]*[a-zA-Z0-9\\p{L}\\p{M}])?\\.)+[a-zA-Z0-9\\p{L}\\p{M}](?:[a-zA-Z0-9\\p{L}\\p{M}-]*[a-zA-Z0-9\\p{L}\\p{M}])?|\\[(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?|[a-zA-Z0-9-]*[a-z0-9]:(?:[\\x01-\\x08\\x0b\\x0c\\x0e-\\x1f\\x21-\\x5a\\x53-\\x7f]|\\\\[\\x01-\\x09\\x0b\\x0c\\x0e-\\x7f])+)\\])" }, "organisationSupportPhone": { "type": "string" }, "welcomeImageUrl": { "type": "string" }, "welcomeSubject": { "type": "string" }, "welcomeText": { "type": "string" }, "defaultPhoneCountryCode": { "type": "string" }, "defaultAddressCountry": { "type": "string" }, "defaultSmsIdentityId": { "format": "uuid", "type": "string" }, "defaultEmailIdentityId": { "format": "uuid", "type": "string" }, "memberNoType": { "format": "int32", "enum": [ 0, 1, 2 ], "type": "integer" }, "legalEntityVerificationDocumentUrl": { "type": "string" }, "legalEntityOwnersVerificationDocumentUrl": { "type": "string" }, "isWeeklyNewsletterEnabled": { "type": "boolean" }, "isWeeklyNewsletterAnnouncements": { "type": "boolean" }, "isWeeklyNewsletterDonationCampaigns": { "type": "boolean" }, "isWeeklyNewsletterNewMembersEnabled": { "type": "boolean" }, "isWeeklyNewsletterJobOffers": { "type": "boolean" }, "isWeeklyNewsletterJobSeekers": { "type": "boolean" }, "isWeeklyNewsletterServices": { "type": "boolean" }, "isWeeklyNewsletterMemberUnreadMessages": { "type": "boolean" }, "isWeeklyNewsletterMemberDebt": { "type": "boolean" }, "googleAnalyticsTrackerId": { "type": "string" }, "otherDonationOptions": { "type": "string" }, "isMemberVisibilityHiddenForNewMembers": { "type": "boolean" }, "memberSmsEnabledNotification": { "type": "string" }, "memberEmailEnabledNotification": { "type": "string" }, "organisationMemberships": { "type": "array", "items": { "$ref": "#/components/schemas/OrganisationMembership" } }, "groups": { "type": "array", "items": { "$ref": "#/components/schemas/Group" } }, "groupCategories": { "type": "array", "items": { "$ref": "#/components/schemas/GroupCategory" } }, "emailIdentities": { "type": "array", "items": { "$ref": "#/components/schemas/EmailIdentity" } }, "smsIdentities": { "type": "array", "items": { "$ref": "#/components/schemas/SmsIdentity" } }, "bulkSmses": { "type": "array", "items": { "$ref": "#/components/schemas/BulkSms" } }, "bulkEmails": { "type": "array", "items": { "$ref": "#/components/schemas/BulkEmail" } }, "donationCampaigns": { "type": "array", "items": { "$ref": "#/components/schemas/DonationCampaign" } }, "memberLists": { "type": "array", "items": { "$ref": "#/components/schemas/MemberList" } }, "payments": { "type": "array", "items": { "$ref": "#/components/schemas/Payment" } }, "paymentTickets": { "type": "array", "items": { "$ref": "#/components/schemas/PaymentTicket" } }, "events": { "type": "array", "items": { "$ref": "#/components/schemas/Event" } }, "organisationMembershipActivities": { "type": "array", "items": { "$ref": "#/components/schemas/OrganisationMembershipActivity" } }, "loginActivities": { "type": "array", "items": { "$ref": "#/components/schemas/LoginActivity" } }, "announcements": { "type": "array", "items": { "$ref": "#/components/schemas/Announcement" } }, "jobPostings": { "type": "array", "items": { "$ref": "#/components/schemas/JobPosting" } }, "conversations": { "type": "array", "items": { "$ref": "#/components/schemas/Conversation" } }, "invoices": { "type": "array", "items": { "$ref": "#/components/schemas/Invoice" } }, "offeredServices": { "type": "array", "items": { "$ref": "#/components/schemas/OfferedService" } }, "customPaymentButtons": { "type": "array", "items": { "$ref": "#/components/schemas/CustomPaymentButton" } }, "mailTemplates": { "type": "array", "items": { "$ref": "#/components/schemas/MailTemplate" } }, "customMemberTypes": { "type": "array", "items": { "$ref": "#/components/schemas/CustomMemberType" } }, "customMemberships": { "type": "array", "items": { "$ref": "#/components/schemas/CustomMembership" } }, "socialNetworks": { "type": "array", "items": { "$ref": "#/components/schemas/SocialNetwork" } }, "annualMembershipFees": { "type": "array", "items": { "$ref": "#/components/schemas/AnnualMembershipFee" } }, "eventV2s": { "type": "array", "items": { "$ref": "#/components/schemas/EventV2" } }, "adminReportReceivers": { "type": "array", "items": { "$ref": "#/components/schemas/AdminReportReceiver" } }, "importJobs": { "type": "array", "items": { "$ref": "#/components/schemas/ImportJob" } }, "staticPages": { "type": "array", "items": { "$ref": "#/components/schemas/StaticPage" } }, "paymentAccounts": { "type": "array", "items": { "$ref": "#/components/schemas/PaymentAccount" } }, "publicDonations": { "type": "array", "items": { "$ref": "#/components/schemas/PublicDonation" } }, "dataExportLogs": { "type": "array", "items": { "$ref": "#/components/schemas/DataExportLog" } }, "dataImportLogs": { "type": "array", "items": { "$ref": "#/components/schemas/DataImportLog" } }, "organisationRakletApps": { "type": "array", "items": { "$ref": "#/components/schemas/OrganisationRakletApp" } }, "smsSettings": { "type": "array", "items": { "$ref": "#/components/schemas/SmsSetting" } }, "smsBalances": { "type": "array", "items": { "$ref": "#/components/schemas/SmsBalance" } }, "smsCreditPurchases": { "type": "array", "items": { "$ref": "#/components/schemas/SmsCreditPurchase" } }, "categories": { "type": "array", "items": { "$ref": "#/components/schemas/Category" } }, "parentOrganisationId": { "format": "uuid", "type": "string" }, "parentOrganisation": { "$ref": "#/components/schemas/Organisation" }, "childOrganisations": { "type": "array", "items": { "$ref": "#/components/schemas/Organisation" } }, "balance": { "format": "double", "type": "number" }, "totalCost": { "format": "double", "type": "number" }, "totalProfit": { "format": "double", "type": "number" }, "customDomain": { "type": "string" }, "rowVersion": { "format": "byte", "type": "string" }, "lastActivityDate": { "format": "date-time", "type": "string" }, "deletionDate": { "format": "date-time", "type": "string" }, "bypassInactivityChecks": { "type": "boolean" } } }, "Segment": { "required": [ "id", "name", "organisationId", "searchQueryJson", "createdOn", "lastModifiedOn" ], "type": "object", "properties": { "id": { "format": "uuid", "type": "string" }, "name": { "pattern": "^[^<>]*$", "type": "string" }, "organisationId": { "format": "uuid", "type": "string" }, "organisation": { "$ref": "#/components/schemas/Organisation" }, "searchQueryJson": { "type": "string" }, "createdOn": { "format": "date-time", "type": "string" }, "lastModifiedOn": { "format": "date-time", "type": "string" }, "isDeleted": { "type": "boolean" }, "contacts": { "type": "array", "items": { "$ref": "#/components/schemas/OrganisationMembership" } }, "memberSelectors": { "type": "array", "items": { "$ref": "#/components/schemas/MemberSelector" } } } }, "CustomMembership": { "required": [ "customMemberTypeId", "status", "startDate" ], "type": "object", "properties": { "customMemberTypeId": { "format": "uuid", "pattern": "^[^<>]*$", "type": "string" }, "customMemberType": { "$ref": "#/components/schemas/CustomMemberType" }, "organisationMembershipId": { "format": "uuid", "type": "string" }, "organisationMembership": { "$ref": "#/components/schemas/OrganisationMembership" }, "status": { "format": "int32", "pattern": "^[^<>]*$", "enum": [ 0, 4, -3, -2, -1 ], "type": "integer" }, "startDate": { "format": "date-time", "pattern": "^[^<>]*$", "type": "string" }, "endDate": { "format": "date-time", "type": "string" }, "renewalDate": { "format": "date-time", "type": "string" }, "nextReminderDate": { "format": "date-time", "type": "string" }, "gracePeriodEndDate": { "format": "date-time", "type": "string" }, "disableReminder": { "type": "boolean" }, "organisationId": { "format": "uuid", "type": "string" }, "organisation": { "$ref": "#/components/schemas/Organisation" }, "balance": { "format": "double", "type": "number" }, "paymentsTotal": { "format": "double", "type": "number" }, "debtsTotal": { "format": "double", "type": "number" }, "couponId": { "maxLength": 200, "minLength": 0, "type": "string" }, "parentMembershipId": { "format": "uuid", "type": "string" }, "parentMembership": { "$ref": "#/components/schemas/CustomMembership" }, "childMemberships": { "type": "array", "items": { "$ref": "#/components/schemas/CustomMembership" } }, "rowVersion": { "format": "byte", "type": "string" }, "id": { "format": "uuid", "type": "string" }, "isDeleted": { "type": "boolean" }, "createdOn": { "format": "date-time", "type": "string" }, "lastModifiedOn": { "format": "date-time", "type": "string" } } }, "Email": { "required": [ "emailAddress", "isActivated", "createdOn", "lastModifiedOn", "userIsValid" ], "type": "object", "properties": { "id": { "format": "uuid", "type": "string" }, "emailAddress": { "type": "string", "x-pattern-dotnet": "(?:[a-zA-Z0-9\\p{L}\\p{M}!#$%&'*+/=?^_`{|}~-]+(?:\\.[a-zA-Z0-9\\p{L}\\p{M}!#$%&'*+/=?^_`{|}~-]+)*|\"(?:[\\x01-\\x08\\x0b\\x0c\\x0e-\\x1f\\x21\\x23-\\x5b\\x5d-\\x7f]|\\\\[\\x01-\\x09\\x0b\\x0c\\x0e-\\x7f])*\")@(?:(?:[a-zA-Z0-9\\p{L}\\p{M}](?:[a-zA-Z0-9\\p{L}\\p{M}-]*[a-zA-Z0-9\\p{L}\\p{M}])?\\.)+[a-zA-Z0-9\\p{L}\\p{M}](?:[a-zA-Z0-9\\p{L}\\p{M}-]*[a-zA-Z0-9\\p{L}\\p{M}])?|\\[(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?|[a-zA-Z0-9-]*[a-z0-9]:(?:[\\x01-\\x08\\x0b\\x0c\\x0e-\\x1f\\x21-\\x5a\\x53-\\x7f]|\\\\[\\x01-\\x09\\x0b\\x0c\\x0e-\\x7f])+)\\])" }, "isActivated": { "type": "boolean" }, "organisationMembershipId": { "format": "uuid", "type": "string" }, "organisationMembership": { "$ref": "#/components/schemas/OrganisationMembership" }, "emailStatus": { "format": "int32", "enum": [ 0, -1 ], "type": "integer" }, "createdOn": { "format": "date-time", "type": "string" }, "lastModifiedOn": { "format": "date-time", "type": "string" }, "userIsValid": { "type": "boolean" } } }, "Phone": { "required": [ "countryCode", "number", "createdOn", "lastModifiedOn", "userIsValid" ], "type": "object", "properties": { "id": { "format": "uuid", "type": "string" }, "countryCode": { "type": "string" }, "number": { "type": "string" }, "isActivated": { "type": "boolean" }, "isMobile": { "type": "boolean" }, "phoneStatus": { "format": "int32", "enum": [ 0, -1 ], "type": "integer" }, "organisationMembershipId": { "format": "uuid", "type": "string" }, "organisationMembership": { "$ref": "#/components/schemas/OrganisationMembership" }, "activationCode": { "format": "int32", "type": "integer" }, "activationCodeSentOn": { "format": "date-time", "type": "string" }, "activationCodeTryCount": { "format": "int32", "type": "integer" }, "loginCode": { "format": "int32", "type": "integer" }, "loginCodeSentOn": { "format": "date-time", "type": "string" }, "loginCodeTryCount": { "format": "int32", "type": "integer" }, "createdOn": { "format": "date-time", "type": "string" }, "lastModifiedOn": { "format": "date-time", "type": "string" }, "userIsValid": { "type": "boolean" }, "countryCodeAndNumber": { "type": "string", "readOnly": true } } }, "Address": { "required": [ "createdOn", "lastModifiedOn" ], "type": "object", "properties": { "id": { "format": "uuid", "type": "string" }, "details": { "pattern": "^[^<>]*$", "type": "string" }, "county": { "pattern": "^[^<>]*$", "type": "string" }, "postalCode": { "pattern": "^[^<>]*$", "type": "string" }, "city": { "pattern": "^[^<>]*$", "type": "string" }, "state": { "pattern": "^[^<>]*$", "type": "string" }, "country": { "pattern": "^[^<>]*$", "type": "string" }, "organisationMembershipId": { "format": "uuid", "type": "string" }, "organisationMembership": { "$ref": "#/components/schemas/OrganisationMembership" }, "createdOn": { "format": "date-time", "type": "string" }, "lastModifiedOn": { "format": "date-time", "type": "string" }, "countrySlug": { "type": "string" }, "citySlug": { "type": "string" }, "geoLatitude": { "format": "double", "type": "number" }, "geoLongitude": { "format": "double", "type": "number" }, "fullAddress": { "type": "string", "readOnly": true } } }, "Work": { "required": [ "company", "createdOn", "lastModifiedOn" ], "type": "object", "properties": { "id": { "format": "uuid", "type": "string" }, "company": { "pattern": "^[^<>]*$", "type": "string" }, "position": { "pattern": "^[^<>]*$", "type": "string" }, "sector": { "pattern": "^[^<>]*$", "type": "string" }, "startYear": { "format": "int32", "type": "integer" }, "startMonth": { "format": "int32", "type": "integer" }, "endYear": { "format": "int32", "type": "integer" }, "endMonth": { "format": "int32", "type": "integer" }, "city": { "pattern": "^[^<>]*$", "type": "string" }, "country": { "pattern": "^[^<>]*$", "type": "string" }, "webSite": { "pattern": "^[^<>]*$", "type": "string" }, "organisationMembershipId": { "format": "uuid", "type": "string" }, "organisationMembership": { "$ref": "#/components/schemas/OrganisationMembership" }, "createdOn": { "format": "date-time", "type": "string" }, "lastModifiedOn": { "format": "date-time", "type": "string" }, "companySlug": { "type": "string" }, "workSectors": { "type": "array", "items": { "$ref": "#/components/schemas/WorkSector" } } } }, "Education": { "required": [ "school", "createdOn", "lastModifiedOn" ], "type": "object", "properties": { "id": { "format": "uuid", "type": "string" }, "school": { "pattern": "^[^<>]*$", "type": "string" }, "department": { "pattern": "^[^<>]*$", "type": "string" }, "faculty": { "pattern": "^[^<>]*$", "type": "string" }, "educationLevel": { "format": "int32", "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11 ], "type": "integer" }, "startYear": { "format": "int32", "type": "integer" }, "endYear": { "format": "int32", "type": "integer" }, "city": { "pattern": "^[^<>]*$", "type": "string" }, "country": { "pattern": "^[^<>]*$", "type": "string" }, "createdOn": { "format": "date-time", "type": "string" }, "lastModifiedOn": { "format": "date-time", "type": "string" }, "isLocked": { "type": "boolean" }, "schoolSlug": { "type": "string" }, "organisationMembershipId": { "format": "uuid", "type": "string" }, "organisationMembership": { "$ref": "#/components/schemas/OrganisationMembership" } } }, "GroupMembership": { "required": [ "createdOn", "lastModifiedOn" ], "type": "object", "properties": { "id": { "format": "uuid", "type": "string" }, "groupId": { "format": "uuid", "type": "string" }, "group": { "$ref": "#/components/schemas/Group" }, "organisationMembershipId": { "format": "uuid", "type": "string" }, "organisationMembership": { "$ref": "#/components/schemas/OrganisationMembership" }, "groupMembershipType": { "format": "int32", "enum": [ 0, 1, 2 ], "type": "integer" }, "groupMembershipStatus": { "format": "int32", "enum": [ 0, 1 ], "type": "integer" }, "emailDeliveryType": { "format": "int32", "enum": [ 0, 1, 2, 3 ], "type": "integer" }, "smsDeliveryType": { "format": "int32", "enum": [ 0, 1, 2 ], "type": "integer" }, "viewCount": { "format": "int32", "type": "integer" }, "createdOn": { "format": "date-time", "type": "string" }, "lastModifiedOn": { "format": "date-time", "type": "string" }, "posts": { "type": "array", "items": { "$ref": "#/components/schemas/Post" } } } }, "Payment": { "required": [ "amount", "currency", "paymentMethod", "paymentDate", "paymentType", "createdOn", "lastModifiedOn" ], "type": "object", "properties": { "id": { "format": "uuid", "type": "string" }, "organisationId": { "format": "uuid", "type": "string" }, "organisation": { "$ref": "#/components/schemas/Organisation" }, "amount": { "format": "double", "type": "number" }, "oldAmount": { "format": "double", "type": "number" }, "paidAmount": { "format": "double", "type": "number" }, "paidCurrency": { "format": "int32", "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62, 63, 64, 65, 66, 67, 68, 69, 70, 71, 72, 73, 74, 75, 76, 77, 78, 79, 80, 81, 82, 83, 84, 85, 86, 87, 88, 89, 90, 91, 92, 93, 94, 95, 96, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 112, 113, 114, 115, 116, 117, 118, 119, 120, 121, 122, 123, 124, 125, 126, 127, 128, 129, 130, 131, 132, 133, 134, 135, 136, 137 ], "type": "integer" }, "currency": { "format": "int32", "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62, 63, 64, 65, 66, 67, 68, 69, 70, 71, 72, 73, 74, 75, 76, 77, 78, 79, 80, 81, 82, 83, 84, 85, 86, 87, 88, 89, 90, 91, 92, 93, 94, 95, 96, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 112, 113, 114, 115, 116, 117, 118, 119, 120, 121, 122, 123, 124, 125, 126, 127, 128, 129, 130, 131, 132, 133, 134, 135, 136, 137 ], "type": "integer" }, "paymentMethod": { "format": "int32", "enum": [ 0, 1, 2, 3, 4, 5, 10 ], "type": "integer" }, "paymentDate": { "format": "date-time", "type": "string" }, "paymentType": { "format": "int32", "enum": [ 0, 1, 2, 3 ], "type": "integer" }, "feeType": { "format": "int32", "enum": [ 0, 1, 2 ], "type": "integer" }, "referenceNumber": { "type": "string" }, "identifier": { "type": "string" }, "paymentTransactionId": { "type": "string" }, "organisationMembershipId": { "format": "uuid", "type": "string" }, "organisationMembership": { "$ref": "#/components/schemas/OrganisationMembership" }, "_FullName": { "type": "string" }, "donationCampaignId": { "format": "uuid", "type": "string" }, "donationCampaign": { "$ref": "#/components/schemas/DonationCampaign" }, "_DonationCampaignName": { "type": "string" }, "isDonorNameHidden": { "type": "boolean" }, "isRecurringPayment": { "type": "boolean" }, "publicDonationId": { "format": "uuid", "type": "string" }, "publicDonation": { "$ref": "#/components/schemas/PublicDonation" }, "paymentAccountId": { "format": "uuid", "type": "string" }, "customMemberTypeId": { "format": "uuid", "type": "string" }, "customMemberType": { "$ref": "#/components/schemas/CustomMemberType" }, "_CustomMemberTypeName": { "type": "string" }, "customMembershipId": { "format": "uuid", "type": "string" }, "customMembership": { "$ref": "#/components/schemas/CustomMembership" }, "eventId": { "format": "uuid", "type": "string" }, "_EventName": { "type": "string" }, "couponId": { "maxLength": 200, "minLength": 0, "type": "string" }, "createdOn": { "format": "date-time", "type": "string" }, "lastModifiedOn": { "format": "date-time", "type": "string" }, "paymentNotifications": { "type": "array", "items": { "$ref": "#/components/schemas/PaymentNotification" } }, "debts": { "type": "array", "items": { "$ref": "#/components/schemas/Debt" } }, "refunds": { "type": "array", "items": { "$ref": "#/components/schemas/PaymentRefund" } }, "isManualPayment": { "type": "boolean", "readOnly": true }, "status": { "format": "int32", "enum": [ 0, 1, 3 ], "type": "integer" } } }, "MembershipFee": { "required": [ "amount", "currency", "createdOn", "lastModifiedOn" ], "type": "object", "properties": { "id": { "format": "uuid", "type": "string" }, "organisationMembershipId": { "format": "uuid", "type": "string" }, "organisationMembership": { "$ref": "#/components/schemas/OrganisationMembership" }, "amount": { "format": "double", "type": "number" }, "currency": { "format": "int32", "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62, 63, 64, 65, 66, 67, 68, 69, 70, 71, 72, 73, 74, 75, 76, 77, 78, 79, 80, 81, 82, 83, 84, 85, 86, 87, 88, 89, 90, 91, 92, 93, 94, 95, 96, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 112, 113, 114, 115, 116, 117, 118, 119, 120, 121, 122, 123, 124, 125, 126, 127, 128, 129, 130, 131, 132, 133, 134, 135, 136, 137 ], "type": "integer" }, "description": { "type": "string" }, "year": { "format": "int32", "type": "integer" }, "createdOn": { "format": "date-time", "type": "string" }, "lastModifiedOn": { "format": "date-time", "type": "string" } } }, "Role": { "type": "object", "properties": { "id": { "format": "uuid", "type": "string" }, "name": { "type": "string" }, "organisationId": { "format": "uuid", "type": "string" }, "organisationMemberships": { "type": "array", "items": { "$ref": "#/components/schemas/OrganisationMembership" } } } }, "Sms": { "required": [ "text", "phoneNumber", "createdOn", "lastModifiedOn" ], "type": "object", "properties": { "id": { "format": "uuid", "type": "string" }, "organisationMembershipId": { "format": "uuid", "type": "string" }, "organisationMembership": { "$ref": "#/components/schemas/OrganisationMembership" }, "bulkSmsItemId": { "format": "uuid", "type": "string" }, "bulkSmsItem": { "$ref": "#/components/schemas/BulkSmsItem" }, "smsIdentityId": { "format": "uuid", "type": "string" }, "smsIdentity": { "$ref": "#/components/schemas/SmsIdentity" }, "fullName": { "type": "string" }, "text": { "pattern": "^[ A-Za-z0-9_@./#&+-/'?*=()%!:|\n]*$", "type": "string" }, "phoneNumber": { "type": "string" }, "processingTime": { "format": "int64", "type": "integer" }, "messageId": { "type": "string" }, "type": { "format": "int32", "enum": [ 0, 1, 2, 3, 4, 5, 6 ], "type": "integer" }, "status": { "format": "int32", "enum": [ 0, 1, 2, -1 ], "type": "integer" }, "errorType": { "format": "int32", "enum": [ 0, 1, 2, 3, 4, 5, 6, 7 ], "type": "integer" }, "errorMessage": { "type": "string" }, "sentInMiliseconds": { "format": "int64", "type": "integer" }, "createdOn": { "format": "date-time", "type": "string" }, "lastModifiedOn": { "format": "date-time", "type": "string" } } }, "Mail": { "required": [ "fromAddress", "toAddress", "subject", "createdOn", "lastModifiedOn" ], "type": "object", "properties": { "id": { "format": "uuid", "type": "string" }, "emailIdentityId": { "format": "uuid", "type": "string" }, "emailIdentity": { "$ref": "#/components/schemas/EmailIdentity" }, "organisationMembershipId": { "format": "uuid", "type": "string" }, "bulkEmailItemId": { "format": "uuid", "type": "string" }, "oneTimeLoginId": { "format": "uuid", "type": "string" }, "activationEmailId": { "format": "uuid", "type": "string" }, "applicationFormId": { "format": "uuid", "type": "string" }, "conversationId": { "format": "uuid", "type": "string" }, "fileUrl": { "type": "string" }, "fromAddress": { "type": "string" }, "fromDisplayName": { "type": "string" }, "toAddress": { "type": "string" }, "toDisplayName": { "type": "string" }, "subject": { "type": "string" }, "sentInMiliseconds": { "format": "int64", "type": "integer" }, "messageId": { "type": "string" }, "type": { "format": "int32", "enum": [ 0, 1, 2, 3, 4, 5 ], "type": "integer" }, "status": { "format": "int32", "enum": [ 0, 1, 2, 3, -1 ], "type": "integer" }, "errorType": { "format": "int32", "enum": [ 0, 1, 2, 3, 4, 5, 6, 99, 100, 101, 102 ], "type": "integer" }, "errorMessage": { "type": "string" }, "createdOn": { "format": "date-time", "type": "string" }, "lastModifiedOn": { "format": "date-time", "type": "string" } } }, "PaymentTicket": { "required": [ "createdOn" ], "type": "object", "properties": { "id": { "format": "uuid", "type": "string" }, "organisationId": { "format": "uuid", "type": "string" }, "applicationFormId": { "format": "uuid", "type": "string" }, "organisation": { "$ref": "#/components/schemas/Organisation" }, "amount": { "format": "double", "type": "number" }, "currency": { "format": "int32", "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62, 63, 64, 65, 66, 67, 68, 69, 70, 71, 72, 73, 74, 75, 76, 77, 78, 79, 80, 81, 82, 83, 84, 85, 86, 87, 88, 89, 90, 91, 92, 93, 94, 95, 96, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 112, 113, 114, 115, 116, 117, 118, 119, 120, 121, 122, 123, 124, 125, 126, 127, 128, 129, 130, 131, 132, 133, 134, 135, 136, 137 ], "type": "integer" }, "status": { "format": "int32", "enum": [ 0, 1, 2, 3, 4, 5 ], "type": "integer" }, "organisationMembershipId": { "format": "uuid", "type": "string" }, "organisationMembership": { "$ref": "#/components/schemas/OrganisationMembership" }, "donationCampaignId": { "format": "uuid", "type": "string" }, "donationCampaign": { "$ref": "#/components/schemas/DonationCampaign" }, "publicDonationId": { "format": "uuid", "type": "string" }, "publicDonation": { "$ref": "#/components/schemas/PublicDonation" }, "_DonationCampaignName": { "type": "string" }, "isDonorNameHidden": { "type": "boolean" }, "isRecurringPayment": { "type": "boolean" }, "customMemberTypeId": { "format": "uuid", "type": "string" }, "customMemberType": { "$ref": "#/components/schemas/CustomMemberType" }, "_CustomMemberTypeName": { "type": "string" }, "customMembershipId": { "format": "uuid", "type": "string" }, "customMembership": { "$ref": "#/components/schemas/CustomMembership" }, "paymentAccountId": { "format": "uuid", "type": "string" }, "paymentType": { "format": "int32", "enum": [ 0, 1, 2, 3 ], "type": "integer" }, "paymentMethod": { "format": "int32", "enum": [ 0, 1, 2, 3, 4, 5, 10 ], "type": "integer" }, "creditCardTokenId": { "format": "uuid", "type": "string" }, "paymentDate": { "format": "date-time", "type": "string" }, "scheduleRule": { "type": "string" }, "scheduleEndDate": { "format": "date-time", "type": "string" }, "schedulePaymentGroupId": { "format": "uuid", "type": "string" }, "lastPurchaseTry": { "format": "date-time", "type": "string" }, "tryCount": { "format": "int32", "type": "integer" }, "createdOn": { "format": "date-time", "type": "string" }, "referenceNumber": { "type": "string" }, "identifier": { "type": "string" }, "paymentErrorMessage": { "type": "string" }, "paymentTicketInvoices": { "type": "array", "items": { "$ref": "#/components/schemas/PaymentTicketInvoice" } } } }, "Tag": { "required": [ "name", "createdOn", "lastModifiedOn" ], "type": "object", "properties": { "id": { "format": "uuid", "type": "string" }, "organisationId": { "format": "uuid", "type": "string" }, "organisation": { "$ref": "#/components/schemas/Organisation" }, "isVisible": { "type": "boolean" }, "isMemberSelectable": { "type": "boolean" }, "name": { "pattern": "^[^<>]*$", "type": "string" }, "isDeleted": { "type": "boolean" }, "createdOn": { "format": "date-time", "type": "string" }, "lastModifiedOn": { "format": "date-time", "type": "string" }, "organisationMemberships": { "type": "array", "items": { "$ref": "#/components/schemas/OrganisationMembership" } }, "memberListFilters": { "type": "array", "items": { "$ref": "#/components/schemas/MemberListFilter" } }, "bulkEmails": { "type": "array", "items": { "$ref": "#/components/schemas/BulkEmail" } }, "memberSelectors": { "type": "array", "items": { "$ref": "#/components/schemas/MemberSelector" } }, "hiddenFromAll": { "type": "boolean" } } }, "Newsletter": { "required": [ "title", "createdOn" ], "type": "object", "properties": { "id": { "format": "uuid", "type": "string" }, "organisationId": { "format": "uuid", "type": "string" }, "tagId": { "format": "uuid", "type": "string" }, "imageUrl": { "type": "string" }, "title": { "maxLength": 500, "minLength": 0, "pattern": "^[^<>]*$", "type": "string" }, "description": { "pattern": "^[^<>]*$", "type": "string" }, "permissionType": { "format": "int32", "enum": [ 0, 1, 2, 3, 4, 5 ], "type": "integer" }, "createdOn": { "format": "date-time", "type": "string" }, "lastModifiedOn": { "format": "date-time", "type": "string" }, "isDeleted": { "type": "boolean" }, "isDefault": { "type": "boolean" }, "slug": { "type": "string" }, "slugUrl": { "type": "string", "readOnly": true } } }, "OrganisationMembershipActivity": { "required": [ "createdOn" ], "type": "object", "properties": { "id": { "format": "uuid", "type": "string" }, "organisationId": { "format": "uuid", "type": "string" }, "organisation": { "$ref": "#/components/schemas/Organisation" }, "organisationMembershipId": { "format": "uuid", "type": "string" }, "organisationMembership": { "$ref": "#/components/schemas/OrganisationMembership" }, "_FullName": { "type": "string" }, "type": { "format": "int32", "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, -1 ], "type": "integer" }, "objectId": { "format": "uuid", "type": "string" }, "value": { "type": "string" }, "oldValue": { "type": "string" }, "createdOn": { "format": "date-time", "type": "string" }, "fullName": { "type": "string", "readOnly": true } } }, "CheckIn": { "required": [ "createdOn", "lastModifiedOn" ], "type": "object", "properties": { "id": { "format": "uuid", "type": "string" }, "eventId": { "format": "uuid", "type": "string" }, "event": { "$ref": "#/components/schemas/Event" }, "organisationMembershipId": { "format": "uuid", "type": "string" }, "organisationMembership": { "$ref": "#/components/schemas/OrganisationMembership" }, "createdOn": { "format": "date-time", "type": "string" }, "lastModifiedOn": { "format": "date-time", "type": "string" } } }, "LoginActivity": { "required": [ "createdOn", "lastModifiedOn" ], "type": "object", "properties": { "id": { "format": "uuid", "type": "string" }, "organisationId": { "format": "uuid", "type": "string" }, "organisation": { "$ref": "#/components/schemas/Organisation" }, "organisationMembershipId": { "format": "uuid", "type": "string" }, "organisationMembership": { "$ref": "#/components/schemas/OrganisationMembership" }, "_FullName": { "type": "string" }, "identifier": { "type": "string" }, "ipAddress": { "type": "string" }, "type": { "format": "int32", "enum": [ 0, 1, 2, -2, -1 ], "type": "integer" }, "provider": { "format": "int32", "enum": [ 0, 1, 2, 3, 4, 5, 6 ], "type": "integer" }, "errorMessage": { "type": "string" }, "fullName": { "type": "string", "readOnly": true }, "createdOn": { "format": "date-time", "type": "string" }, "lastModifiedOn": { "format": "date-time", "type": "string" } } }, "Unsubscribe": { "required": [ "createdOn" ], "type": "object", "properties": { "id": { "format": "uuid", "type": "string" }, "emailIdentityId": { "format": "uuid", "type": "string" }, "emailIdentity": { "$ref": "#/components/schemas/EmailIdentity" }, "organisationMembershipId": { "format": "uuid", "type": "string" }, "organisationMembership": { "$ref": "#/components/schemas/OrganisationMembership" }, "createdOn": { "format": "date-time", "type": "string" } } }, "ConversationMember": { "type": "object", "properties": { "id": { "format": "uuid", "type": "string" }, "conversationId": { "format": "uuid", "type": "string" }, "conversation": { "$ref": "#/components/schemas/Conversation" }, "organisationMembershipId": { "format": "uuid", "type": "string" }, "_FullName": { "type": "string" }, "organisationMembership": { "$ref": "#/components/schemas/OrganisationMembership" }, "isConversationDeleted": { "type": "boolean" }, "conversationDeletedDate": { "format": "date-time", "type": "string" }, "lastViewedOn": { "format": "date-time", "type": "string" } } }, "Note": { "required": [ "text", "createdOn", "lastModifiedOn" ], "type": "object", "properties": { "id": { "format": "uuid", "type": "string" }, "organisationMembershipId": { "format": "uuid", "type": "string" }, "organisationMembership": { "$ref": "#/components/schemas/OrganisationMembership" }, "text": { "pattern": "^[^<>]*$", "type": "string" }, "modifiedByName": { "type": "string" }, "createdOn": { "format": "date-time", "type": "string" }, "lastModifiedOn": { "format": "date-time", "type": "string" } } }, "PaymentMatch": { "type": "object", "properties": { "id": { "format": "uuid", "type": "string" }, "identifier": { "type": "string" }, "organisationMembershipId": { "format": "uuid", "type": "string" }, "organisationMembership": { "$ref": "#/components/schemas/OrganisationMembership" } } }, "BulkEmail": { "required": [ "createdOn", "lastModifiedOn" ], "type": "object", "properties": { "id": { "format": "uuid", "type": "string" }, "organisationId": { "format": "uuid", "type": "string" }, "organisation": { "$ref": "#/components/schemas/Organisation" }, "emailIdentityId": { "format": "uuid", "type": "string" }, "emailIdentity": { "$ref": "#/components/schemas/EmailIdentity" }, "status": { "format": "int32", "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, -1 ], "type": "integer" }, "errorType": { "format": "int32", "enum": [ 0, 1, 2, 3, 4, 5 ], "type": "integer" }, "errorMessage": { "type": "string" }, "fromAddress": { "type": "string" }, "fromName": { "type": "string" }, "imageUrl": { "type": "string" }, "replyAddress": { "type": "string" }, "subject": { "type": "string" }, "body": { "type": "string" }, "isArchived": { "type": "boolean" }, "createdOn": { "format": "date-time", "type": "string" }, "lastModifiedOn": { "format": "date-time", "type": "string" }, "memberSelectorId": { "format": "uuid", "type": "string" }, "memberSelector": { "$ref": "#/components/schemas/MemberSelector" }, "attachments": { "type": "array", "items": { "$ref": "#/components/schemas/BulkEmailAttachment" } }, "activities": { "type": "array", "items": { "$ref": "#/components/schemas/BulkEmailActivity" } }, "memberLists": { "type": "array", "items": { "$ref": "#/components/schemas/MemberList" } }, "tags": { "type": "array", "items": { "$ref": "#/components/schemas/Tag" } }, "organisationMemberships": { "type": "array", "items": { "$ref": "#/components/schemas/OrganisationMembership" } }, "bulkEmailItems": { "type": "array", "items": { "$ref": "#/components/schemas/BulkEmailItem" } }, "bulkEmailParts": { "type": "array", "items": { "$ref": "#/components/schemas/BulkEmailPart" } }, "bulkEmailV2Attachments": { "type": "array", "items": { "$ref": "#/components/schemas/BulkEmailV2Attachment" } } } }, "JobPosting": { "required": [ "description" ], "type": "object", "properties": { "id": { "format": "uuid", "type": "string" }, "organisationId": { "format": "uuid", "type": "string" }, "description": { "type": "string" }, "position": { "pattern": "^[^<>]*$", "type": "string" }, "company": { "pattern": "^[^<>]*$", "type": "string" }, "organisationMembershipId": { "format": "uuid", "type": "string" }, "_FullName": { "type": "string" }, "approvedByName": { "type": "string" }, "createdOn": { "format": "date-time", "type": "string" }, "lastModifiedOn": { "format": "date-time", "type": "string" }, "approvedById": { "format": "uuid", "type": "string" }, "publishedOn": { "format": "date-time", "type": "string" }, "validUntil": { "format": "date-time", "type": "string" }, "viewCount": { "format": "int32", "type": "integer" }, "jobPostingStatus": { "format": "int32", "enum": [ 0, 1, 2, 3, -1 ], "type": "integer" }, "jobType": { "format": "int32", "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8 ], "type": "integer" }, "positionSlug": { "type": "string" }, "country": { "type": "string" }, "city": { "type": "string" }, "applyToEmail": { "type": "string", "x-pattern-dotnet": "(?:[a-zA-Z0-9\\p{L}\\p{M}!#$%&'*+/=?^_`{|}~-]+(?:\\.[a-zA-Z0-9\\p{L}\\p{M}!#$%&'*+/=?^_`{|}~-]+)*|\"(?:[\\x01-\\x08\\x0b\\x0c\\x0e-\\x1f\\x21\\x23-\\x5b\\x5d-\\x7f]|\\\\[\\x01-\\x09\\x0b\\x0c\\x0e-\\x7f])*\")@(?:(?:[a-zA-Z0-9\\p{L}\\p{M}](?:[a-zA-Z0-9\\p{L}\\p{M}-]*[a-zA-Z0-9\\p{L}\\p{M}])?\\.)+[a-zA-Z0-9\\p{L}\\p{M}](?:[a-zA-Z0-9\\p{L}\\p{M}-]*[a-zA-Z0-9\\p{L}\\p{M}])?|\\[(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?|[a-zA-Z0-9-]*[a-z0-9]:(?:[\\x01-\\x08\\x0b\\x0c\\x0e-\\x1f\\x21-\\x5a\\x53-\\x7f]|\\\\[\\x01-\\x09\\x0b\\x0c\\x0e-\\x7f])+)\\])" }, "workPlaceType": { "format": "int32", "enum": [ 0, 1, 2, 3 ], "type": "integer" }, "jobLocation": { "type": "string" }, "archivedReason": { "type": "string" }, "archivedAt": { "format": "date-time", "type": "string" }, "archivedById": { "format": "uuid", "type": "string" }, "archivedByName": { "type": "string" }, "organisationMembership": { "$ref": "#/components/schemas/OrganisationMembership" }, "organisation": { "$ref": "#/components/schemas/Organisation" } } }, "OfferedService": { "required": [ "title", "description", "createdOn", "lastModifiedOn", "offeredServiceStatus" ], "type": "object", "properties": { "id": { "format": "uuid", "type": "string" }, "organisationMembershipId": { "format": "uuid", "type": "string" }, "organisationId": { "format": "uuid", "type": "string" }, "_FullName": { "type": "string" }, "title": { "pattern": "^[^<>]*$", "type": "string" }, "description": { "type": "string" }, "approvedById": { "format": "uuid", "type": "string" }, "approvedByName": { "type": "string" }, "createdOn": { "format": "date-time", "type": "string" }, "lastModifiedOn": { "format": "date-time", "type": "string" }, "publishedOn": { "format": "date-time", "type": "string" }, "offeredServiceStatus": { "format": "int32", "enum": [ 0, 1, 2, -1 ], "type": "integer" }, "viewCount": { "format": "int32", "type": "integer" }, "organisationMembership": { "$ref": "#/components/schemas/OrganisationMembership" }, "organisation": { "$ref": "#/components/schemas/Organisation" } } }, "SupportTicketMessage": { "required": [ "createdOn", "lastModifiedOn" ], "type": "object", "properties": { "id": { "format": "uuid", "type": "string" }, "text": { "type": "string" }, "supportTicketId": { "format": "uuid", "type": "string" }, "supportTicket": { "$ref": "#/components/schemas/SupportTicket" }, "organisationMembershipId": { "format": "uuid", "type": "string" }, "organisationMembership": { "$ref": "#/components/schemas/OrganisationMembership" }, "_FullName": { "type": "string" }, "fullName": { "type": "string", "readOnly": true }, "createdOn": { "format": "date-time", "type": "string" }, "lastModifiedOn": { "format": "date-time", "type": "string" }, "type": { "format": "int32", "enum": [ 0, 1 ], "type": "integer" } } }, "OrganisationMembershipFile": { "required": [ "name" ], "type": "object", "properties": { "id": { "format": "uuid", "type": "string" }, "name": { "pattern": "^[^<>]*$", "type": "string" }, "description": { "pattern": "^[^<>]*$", "type": "string" }, "organisationMembershipId": { "format": "uuid", "type": "string" }, "organisationMembership": { "$ref": "#/components/schemas/OrganisationMembership" }, "createdOn": { "format": "date-time", "type": "string" }, "lastModifiedOn": { "format": "date-time", "type": "string" }, "attachments": { "type": "array", "items": { "$ref": "#/components/schemas/OrganisationMembershipAttachment" } } } }, "FamilyMember": { "required": [ "firstName", "lastName" ], "type": "object", "properties": { "id": { "format": "uuid", "type": "string" }, "relationship": { "type": "string" }, "firstName": { "pattern": "^[^<>]*$", "type": "string" }, "lastName": { "pattern": "^[^<>]*$", "type": "string" }, "organisationMembershipId": { "format": "uuid", "type": "string" }, "organisationMembership": { "$ref": "#/components/schemas/OrganisationMembership" }, "gender": { "format": "int32", "enum": [ 0, 1, 2, 3, 4 ], "type": "integer" }, "birthDate": { "format": "date-time", "type": "string" }, "isOrganisationMembership": { "type": "boolean" }, "createdOn": { "format": "date-time", "type": "string" }, "lastModifiedOn": { "format": "date-time", "type": "string" } } }, "Debt": { "type": "object", "properties": { "id": { "format": "uuid", "type": "string" }, "organisationMembershipId": { "format": "uuid", "type": "string" }, "organisationMembership": { "$ref": "#/components/schemas/OrganisationMembership" }, "debtType": { "format": "int32", "enum": [ 0, 1, 2 ], "type": "integer" }, "amount": { "format": "double", "type": "number" }, "year": { "format": "int32", "type": "integer" }, "month": { "format": "int32", "type": "integer" }, "description": { "type": "string" }, "isManuelEntry": { "type": "boolean" }, "currency": { "format": "int32", "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62, 63, 64, 65, 66, 67, 68, 69, 70, 71, 72, 73, 74, 75, 76, 77, 78, 79, 80, 81, 82, 83, 84, 85, 86, 87, 88, 89, 90, 91, 92, 93, 94, 95, 96, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 112, 113, 114, 115, 116, 117, 118, 119, 120, 121, 122, 123, 124, 125, 126, 127, 128, 129, 130, 131, 132, 133, 134, 135, 136, 137 ], "type": "integer" }, "customMemberTypeId": { "format": "uuid", "type": "string" }, "customMemberType": { "$ref": "#/components/schemas/CustomMemberType" }, "_CustomMemberTypeName": { "type": "string" }, "customMembershipId": { "format": "uuid", "type": "string" }, "customMembership": { "$ref": "#/components/schemas/CustomMembership" }, "organisationId": { "format": "uuid", "type": "string" }, "organisation": { "$ref": "#/components/schemas/Organisation" }, "status": { "format": "int32", "enum": [ 0, 1, -1 ], "type": "integer" }, "couponId": { "maxLength": 200, "minLength": 0, "type": "string" }, "discountAmount": { "format": "double", "type": "number" }, "issuedOn": { "format": "date-time", "type": "string" }, "createdOn": { "format": "date-time", "type": "string" }, "lastModifiedOn": { "format": "date-time", "type": "string" }, "payments": { "type": "array", "items": { "$ref": "#/components/schemas/Payment" } }, "paymentTicketInvoices": { "type": "array", "items": { "$ref": "#/components/schemas/PaymentTicketInvoice" } } } }, "EventV2Ticket": { "required": [ "createdOn", "lastModifiedOn" ], "type": "object", "properties": { "id": { "format": "uuid", "type": "string" }, "status": { "format": "int32", "enum": [ 0, 1, 2, 3 ], "type": "integer" }, "eventV2TicketButtonId": { "format": "uuid", "type": "string" }, "eventV2TicketButton": { "$ref": "#/components/schemas/EventV2TicketButton" }, "organisationMembershipId": { "format": "uuid", "type": "string" }, "organisationMembership": { "$ref": "#/components/schemas/OrganisationMembership" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "email": { "type": "string" }, "phoneCountryCode": { "type": "string" }, "phoneNumber": { "type": "string" }, "addressLine1": { "type": "string" }, "addressLine2": { "type": "string" }, "city": { "type": "string" }, "state": { "type": "string" }, "zip": { "type": "string" }, "country": { "type": "string" }, "paymentId": { "format": "uuid", "type": "string" }, "payment": { "$ref": "#/components/schemas/Payment" }, "isArchived": { "type": "boolean" }, "createdOn": { "format": "date-time", "type": "string" }, "lastModifiedOn": { "format": "date-time", "type": "string" } } }, "MemberSelector": { "required": [ "createdOn", "lastModifiedOn" ], "type": "object", "properties": { "id": { "format": "uuid", "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "organisationId": { "format": "uuid", "type": "string" }, "organisation": { "$ref": "#/components/schemas/Organisation" }, "contactFilters": { "type": "string" }, "segments": { "type": "array", "items": { "$ref": "#/components/schemas/Segment" } }, "memberLists": { "type": "array", "items": { "$ref": "#/components/schemas/MemberList" } }, "tags": { "type": "array", "items": { "$ref": "#/components/schemas/Tag" } }, "organisationMemberships": { "type": "array", "items": { "$ref": "#/components/schemas/OrganisationMembership" } }, "smsBlasts": { "type": "array", "items": { "$ref": "#/components/schemas/SmsBlast" } }, "createdOn": { "format": "date-time", "type": "string" }, "lastModifiedOn": { "format": "date-time", "type": "string" }, "isAnySelected": { "type": "boolean", "readOnly": true } } }, "SmsBlastCategoryUnsubscribe": { "type": "object", "properties": { "smsBlastCategoryId": { "format": "uuid", "type": "string" }, "smsBlastCategory": { "$ref": "#/components/schemas/SmsBlastCategory" }, "organisationMembershipId": { "format": "uuid", "type": "string" }, "organisationMembership": { "$ref": "#/components/schemas/OrganisationMembership" }, "createdOn": { "format": "date-time", "type": "string" } } }, "CreditCardToken": { "type": "object", "properties": { "id": { "format": "uuid", "type": "string" }, "createdOn": { "format": "date-time", "type": "string" }, "lastModifiedOn": { "format": "date-time", "type": "string" }, "tokenData": { "type": "string" }, "creditCardType": { "type": "string" }, "cardNumber": { "type": "string" }, "processorReferenceNumber": { "type": "string" }, "processorUserKey": { "type": "string" }, "creditCardProcessor": { "format": "int32", "enum": [ 0, 1, 2, 4, 5, 6 ], "type": "integer" }, "organisationMembershipId": { "format": "uuid", "type": "string" }, "paymentAccountId": { "format": "uuid", "type": "string" }, "organisationMembership": { "$ref": "#/components/schemas/OrganisationMembership" } } }, "CreditCardSubscription": { "type": "object", "properties": { "id": { "format": "uuid", "type": "string" }, "processorReferenceNumber": { "type": "string" }, "processorUserKey": { "type": "string" }, "amount": { "format": "double", "type": "number" }, "paymentType": { "format": "int32", "enum": [ 0, 1, 2, 3 ], "type": "integer" }, "creditCardProcessor": { "format": "int32", "enum": [ 0, 1, 2, 4, 5, 6 ], "type": "integer" }, "registerDate": { "format": "date-time", "type": "string" }, "totalPeriod": { "format": "int32", "type": "integer" }, "currentPeriod": { "format": "int32", "type": "integer" }, "currentPeriodPaymentDate": { "format": "date-time", "type": "string" }, "creditCardSubscriptionStatus": { "format": "int32", "enum": [ 0, 1, 2, 3 ], "type": "integer" }, "organisationMembershipId": { "format": "uuid", "type": "string" }, "organisationMembership": { "$ref": "#/components/schemas/OrganisationMembership" }, "_FullName": { "type": "string" }, "errorMessage": { "type": "string" }, "chargeCreditCardSubscriptions": { "type": "array", "items": { "$ref": "#/components/schemas/ChargeCreditCardSubscription" } } } }, "ContactCategory": { "required": [ "name" ], "type": "object", "properties": { "id": { "format": "uuid", "type": "string" }, "name": { "type": "string" }, "organisationId": { "format": "uuid", "type": "string" }, "isSocialNetworkLoginEnabled": { "type": "boolean" }, "createdOn": { "format": "date-time", "type": "string" }, "lastModifiedOn": { "format": "date-time", "type": "string" }, "organisationMemberships": { "type": "array", "items": { "$ref": "#/components/schemas/OrganisationMembership" } } } }, "DataExportLog": { "required": [ "createdOn", "lastModifiedOn" ], "type": "object", "properties": { "id": { "format": "uuid", "type": "string" }, "organisationId": { "format": "uuid", "type": "string" }, "organisation": { "$ref": "#/components/schemas/Organisation" }, "organisationMembershipId": { "format": "uuid", "type": "string" }, "organisationMembership": { "$ref": "#/components/schemas/OrganisationMembership" }, "requestedByEmail": { "type": "string" }, "countOfTotalRows": { "format": "int32", "type": "integer" }, "countOfProcessedRows": { "format": "int32", "type": "integer" }, "percentageOfJobProgress": { "format": "int32", "type": "integer" }, "exportFields": { "type": "string" }, "exportFileUrl": { "type": "string" }, "exportStartTime": { "type": "string" }, "exportFinishTime": { "type": "string" }, "exportElapsedTime": { "type": "string" }, "errorMessages": { "type": "string" }, "status": { "format": "int32", "enum": [ 0, 1, 2, 3, 4 ], "type": "integer" }, "createdOn": { "format": "date-time", "type": "string" }, "lastModifiedOn": { "format": "date-time", "type": "string" } } }, "DataImportLog": { "required": [ "createdOn", "lastModifiedOn" ], "type": "object", "properties": { "id": { "format": "uuid", "type": "string" }, "organisationId": { "format": "uuid", "type": "string" }, "organisation": { "$ref": "#/components/schemas/Organisation" }, "organisationMembershipId": { "format": "uuid", "type": "string" }, "organisationMembership": { "$ref": "#/components/schemas/OrganisationMembership" }, "requestedByEmail": { "type": "string" }, "countOfTotalRows": { "format": "int32", "type": "integer" }, "countOfProcessedRows": { "format": "int32", "type": "integer" }, "percentageOfJobProgress": { "format": "int32", "type": "integer" }, "countOfRowsWithErrors": { "format": "int32", "type": "integer" }, "countOfRowsWithWarnings": { "format": "int32", "type": "integer" }, "importFields": { "type": "string" }, "importFileUrl": { "type": "string" }, "tagId": { "format": "uuid", "type": "string" }, "tag": { "$ref": "#/components/schemas/Tag" }, "importStartTime": { "type": "string" }, "importFinishTime": { "type": "string" }, "importElapsedTime": { "type": "string" }, "errorMessages": { "type": "string" }, "warningMessages": { "type": "string" }, "status": { "format": "int32", "enum": [ 0, 1, 2, 3, 4 ], "type": "integer" }, "createdOn": { "format": "date-time", "type": "string" }, "lastModifiedOn": { "format": "date-time", "type": "string" } } }, "SmsCreditPurchase": { "required": [ "id", "amount", "paymentMethod", "organisationId", "paymentDate", "createdOn" ], "type": "object", "properties": { "id": { "format": "uuid", "type": "string" }, "amount": { "format": "double", "type": "number" }, "stripeInvoiceId": { "type": "string" }, "isAutoReloadEnabled": { "type": "boolean" }, "paymentMethod": { "format": "int32", "enum": [ 0, 1, 2, 3, 4, 5, 10 ], "type": "integer" }, "organisationId": { "format": "uuid", "type": "string" }, "organisation": { "$ref": "#/components/schemas/Organisation" }, "organisationMembershipId": { "format": "uuid", "type": "string" }, "organisationMembership": { "$ref": "#/components/schemas/OrganisationMembership" }, "paymentDate": { "format": "date-time", "type": "string" }, "createdOn": { "format": "date-time", "type": "string" }, "lastModifiedOn": { "format": "date-time", "type": "string" }, "isDeleted": { "type": "boolean" } } }, "Announcement": { "required": [ "createdOn", "lastModifiedOn" ], "type": "object", "properties": { "id": { "format": "uuid", "type": "string" }, "organisationId": { "format": "uuid", "type": "string" }, "organisation": { "$ref": "#/components/schemas/Organisation" }, "organisationMembershipId": { "format": "uuid", "type": "string" }, "organisationMembership": { "$ref": "#/components/schemas/OrganisationMembership" }, "subject": { "pattern": "^[^<>]*$", "type": "string" }, "description": { "type": "string" }, "summary": { "type": "string" }, "imageUrl": { "type": "string" }, "isDeleted": { "type": "boolean" }, "slug": { "type": "string" }, "createdOn": { "format": "date-time", "type": "string" }, "lastModifiedOn": { "format": "date-time", "type": "string" }, "publishedOn": { "format": "date-time", "type": "string" }, "status": { "format": "int32", "enum": [ 0, 1, 2, 3, 4, 5 ], "type": "integer" }, "permissionType": { "format": "int32", "enum": [ 0, 1, 2, 3, 4, 5 ], "type": "integer" }, "attachments": { "type": "array", "items": { "$ref": "#/components/schemas/AnnouncementAttachment" } }, "comments": { "type": "array", "items": { "$ref": "#/components/schemas/AnnouncementComment" } }, "commentAttachments": { "type": "array", "items": { "$ref": "#/components/schemas/AnnouncementCommentAttachment" } }, "likes": { "type": "array", "items": { "$ref": "#/components/schemas/AnnouncementLike" } }, "subscribers": { "type": "array", "items": { "$ref": "#/components/schemas/AnnouncementSubscriber" } }, "customMemberTypes": { "type": "array", "items": { "$ref": "#/components/schemas/CustomMemberType" } }, "categories": { "type": "array", "items": { "$ref": "#/components/schemas/Category" } }, "links": { "type": "array", "items": { "$ref": "#/components/schemas/Link" } }, "isDefault": { "type": "boolean" }, "likeCount": { "format": "int32", "type": "integer" }, "commentCount": { "format": "int32", "type": "integer" }, "viewCount": { "format": "int32", "type": "integer" }, "approvedById": { "format": "uuid", "type": "string" }, "like": { "format": "int32", "enum": [ 0, 1, 2 ], "type": "integer" }, "comment": { "format": "int32", "enum": [ 0, 1, 2 ], "type": "integer" }, "share": { "format": "int32", "enum": [ 0, 1, 2 ], "type": "integer" }, "approvedBy": { "$ref": "#/components/schemas/OrganisationMembership" }, "slugUrl": { "type": "string", "readOnly": true }, "isPinned": { "type": "boolean" }, "announcementType": { "format": "int32", "enum": [ 0, 1 ], "type": "integer" }, "pollStatus": { "format": "int32", "enum": [ 0, 1 ], "type": "integer" }, "pollClosesOn": { "format": "date-time", "type": "string" }, "pollSelectionMode": { "format": "int32", "enum": [ 0, 1 ], "type": "integer" }, "pollResultsVisibility": { "format": "int32", "enum": [ 0, 1, 2 ], "type": "integer" }, "pollVoteVisibility": { "format": "int32", "enum": [ 0, 1 ], "type": "integer" }, "pollMaxSelections": { "format": "int32", "type": "integer" }, "pollOptions": { "type": "array", "items": { "$ref": "#/components/schemas/PollOption" } }, "pollVotes": { "type": "array", "items": { "$ref": "#/components/schemas/PollVote" } } } }, "CategorySubscriber": { "type": "object", "properties": { "id": { "format": "uuid", "type": "string" }, "organisationId": { "format": "uuid", "type": "string" }, "organisation": { "$ref": "#/components/schemas/Organisation" }, "organisationMembershipId": { "format": "uuid", "type": "string" }, "organisationMembership": { "$ref": "#/components/schemas/OrganisationMembership" }, "categoryId": { "format": "uuid", "type": "string" }, "category": { "$ref": "#/components/schemas/Category" }, "notificationPeriod": { "format": "int32", "enum": [ 0, 1, 2 ], "type": "integer" } } }, "AnnouncementSubscriber": { "required": [ "createdOn" ], "type": "object", "properties": { "id": { "format": "uuid", "type": "string" }, "organisationId": { "format": "uuid", "type": "string" }, "organisation": { "$ref": "#/components/schemas/Organisation" }, "organisationMembershipId": { "format": "uuid", "type": "string" }, "organisationMembership": { "$ref": "#/components/schemas/OrganisationMembership" }, "announcementId": { "format": "uuid", "type": "string" }, "announcement": { "$ref": "#/components/schemas/Announcement" }, "createdOn": { "format": "date-time", "type": "string" } } }, "AnnouncementComment": { "required": [ "createdOn", "lastModifiedOn" ], "type": "object", "properties": { "id": { "format": "uuid", "type": "string" }, "organisationId": { "format": "uuid", "type": "string" }, "organisation": { "$ref": "#/components/schemas/Organisation" }, "organisationMembershipId": { "format": "uuid", "type": "string" }, "organisationMembership": { "$ref": "#/components/schemas/OrganisationMembership" }, "announcementId": { "format": "uuid", "type": "string" }, "announcement": { "$ref": "#/components/schemas/Announcement" }, "status": { "format": "int32", "enum": [ 0, 1, 2, 3, 4, 5 ], "type": "integer" }, "text": { "type": "string" }, "createdOn": { "format": "date-time", "type": "string" }, "lastModifiedOn": { "format": "date-time", "type": "string" }, "publishedOn": { "format": "date-time", "type": "string" }, "approvedById": { "format": "uuid", "type": "string" }, "approvedBy": { "$ref": "#/components/schemas/OrganisationMembership" }, "parentId": { "format": "uuid", "type": "string" }, "parent": { "$ref": "#/components/schemas/AnnouncementComment" }, "likeCount": { "format": "int32", "type": "integer" }, "attachments": { "type": "array", "items": { "$ref": "#/components/schemas/AnnouncementCommentAttachment" } }, "likes": { "type": "array", "items": { "$ref": "#/components/schemas/AnnouncementCommentLike" } } } }, "AnnouncementLike": { "required": [ "createdOn" ], "type": "object", "properties": { "id": { "format": "uuid", "type": "string" }, "organisationId": { "format": "uuid", "type": "string" }, "organisation": { "$ref": "#/components/schemas/Organisation" }, "organisationMembershipId": { "format": "uuid", "type": "string" }, "organisationMembership": { "$ref": "#/components/schemas/OrganisationMembership" }, "announcementId": { "format": "uuid", "type": "string" }, "announcement": { "$ref": "#/components/schemas/Announcement" }, "createdOn": { "format": "date-time", "type": "string" } } }, "AnnouncementCommentLike": { "required": [ "createdOn" ], "type": "object", "properties": { "id": { "format": "uuid", "type": "string" }, "organisationId": { "format": "uuid", "type": "string" }, "organisation": { "$ref": "#/components/schemas/Organisation" }, "organisationMembershipId": { "format": "uuid", "type": "string" }, "organisationMembership": { "$ref": "#/components/schemas/OrganisationMembership" }, "announcementCommentId": { "format": "uuid", "type": "string" }, "announcementComment": { "$ref": "#/components/schemas/AnnouncementComment" }, "createdOn": { "format": "date-time", "type": "string" } } }, "AnnouncementCommentAttachment": { "required": [ "createdOn" ], "type": "object", "properties": { "id": { "format": "uuid", "type": "string" }, "fileName": { "type": "string" }, "size": { "format": "int32", "type": "integer" }, "organisationId": { "format": "uuid", "type": "string" }, "organisation": { "$ref": "#/components/schemas/Organisation" }, "organisationMembershipId": { "format": "uuid", "type": "string" }, "organisationMembership": { "$ref": "#/components/schemas/OrganisationMembership" }, "announcementId": { "format": "uuid", "type": "string" }, "announcement": { "$ref": "#/components/schemas/Announcement" }, "announcementCommentId": { "format": "uuid", "type": "string" }, "announcementComment": { "$ref": "#/components/schemas/AnnouncementComment" }, "createdOn": { "format": "date-time", "type": "string" } } }, "Group": { "required": [ "organisationId", "name", "emailAddress", "createdOn", "lastModifiedOn" ], "type": "object", "properties": { "id": { "format": "uuid", "type": "string" }, "organisationId": { "format": "uuid", "type": "string" }, "organisation": { "$ref": "#/components/schemas/Organisation" }, "name": { "pattern": "^[^<>]*$", "type": "string" }, "shortName": { "pattern": "^[^<>]*$", "type": "string" }, "emailAddress": { "type": "string", "x-pattern-dotnet": "(?:[a-zA-Z0-9\\p{L}\\p{M}!#$%&'*+/=?^_`{|}~-]+(?:\\.[a-zA-Z0-9\\p{L}\\p{M}!#$%&'*+/=?^_`{|}~-]+)*|\"(?:[\\x01-\\x08\\x0b\\x0c\\x0e-\\x1f\\x21\\x23-\\x5b\\x5d-\\x7f]|\\\\[\\x01-\\x09\\x0b\\x0c\\x0e-\\x7f])*\")@(?:(?:[a-zA-Z0-9\\p{L}\\p{M}](?:[a-zA-Z0-9\\p{L}\\p{M}-]*[a-zA-Z0-9\\p{L}\\p{M}])?\\.)+[a-zA-Z0-9\\p{L}\\p{M}](?:[a-zA-Z0-9\\p{L}\\p{M}-]*[a-zA-Z0-9\\p{L}\\p{M}])?|\\[(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?|[a-zA-Z0-9-]*[a-z0-9]:(?:[\\x01-\\x08\\x0b\\x0c\\x0e-\\x1f\\x21-\\x5a\\x53-\\x7f]|\\\\[\\x01-\\x09\\x0b\\x0c\\x0e-\\x7f])+)\\])" }, "description": { "pattern": "^[^<>]*$", "type": "string" }, "isPostNewMessageEnabled": { "type": "boolean" }, "isReplyEnabled": { "type": "boolean" }, "isMemberListVisible": { "type": "boolean" }, "groupVisibilityType": { "format": "int32", "enum": [ 0, 1 ], "type": "integer" }, "groupRegistrationType": { "format": "int32", "enum": [ 0, 1, 2 ], "type": "integer" }, "createdOn": { "format": "date-time", "type": "string" }, "lastModifiedOn": { "format": "date-time", "type": "string" }, "groupCategories": { "type": "array", "items": { "$ref": "#/components/schemas/GroupCategory" } }, "groupMemberships": { "type": "array", "items": { "$ref": "#/components/schemas/GroupMembership" } }, "posts": { "type": "array", "items": { "$ref": "#/components/schemas/Post" } } } }, "GroupCategory": { "required": [ "name", "createdOn", "lastModifiedOn" ], "type": "object", "properties": { "id": { "format": "uuid", "type": "string" }, "name": { "pattern": "^[^<>]*$", "type": "string" }, "organisationId": { "format": "uuid", "type": "string" }, "organisation": { "$ref": "#/components/schemas/Organisation" }, "createdOn": { "format": "date-time", "type": "string" }, "lastModifiedOn": { "format": "date-time", "type": "string" }, "groups": { "type": "array", "items": { "$ref": "#/components/schemas/Group" } } } }, "EmailIdentity": { "required": [ "name", "fromName", "emailAddress", "replyAddress", "mailProvider", "createdOn", "lastModifiedOn" ], "type": "object", "properties": { "id": { "format": "uuid", "type": "string" }, "name": { "type": "string" }, "isDefault": { "type": "boolean" }, "isDeleted": { "type": "boolean" }, "organisationId": { "format": "uuid", "type": "string" }, "organisation": { "$ref": "#/components/schemas/Organisation" }, "fromName": { "type": "string" }, "emailAddress": { "type": "string", "x-pattern-dotnet": "(?:[a-zA-Z0-9\\p{L}\\p{M}!#$%&'*+/=?^_`{|}~-]+(?:\\.[a-zA-Z0-9\\p{L}\\p{M}!#$%&'*+/=?^_`{|}~-]+)*|\"(?:[\\x01-\\x08\\x0b\\x0c\\x0e-\\x1f\\x21\\x23-\\x5b\\x5d-\\x7f]|\\\\[\\x01-\\x09\\x0b\\x0c\\x0e-\\x7f])*\")@(?:(?:[a-zA-Z0-9\\p{L}\\p{M}](?:[a-zA-Z0-9\\p{L}\\p{M}-]*[a-zA-Z0-9\\p{L}\\p{M}])?\\.)+[a-zA-Z0-9\\p{L}\\p{M}](?:[a-zA-Z0-9\\p{L}\\p{M}-]*[a-zA-Z0-9\\p{L}\\p{M}])?|\\[(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?|[a-zA-Z0-9-]*[a-z0-9]:(?:[\\x01-\\x08\\x0b\\x0c\\x0e-\\x1f\\x21-\\x5a\\x53-\\x7f]|\\\\[\\x01-\\x09\\x0b\\x0c\\x0e-\\x7f])+)\\])" }, "replyAddress": { "type": "string", "x-pattern-dotnet": "(?:[a-zA-Z0-9\\p{L}\\p{M}!#$%&'*+/=?^_`{|}~-]+(?:\\.[a-zA-Z0-9\\p{L}\\p{M}!#$%&'*+/=?^_`{|}~-]+)*|\"(?:[\\x01-\\x08\\x0b\\x0c\\x0e-\\x1f\\x21\\x23-\\x5b\\x5d-\\x7f]|\\\\[\\x01-\\x09\\x0b\\x0c\\x0e-\\x7f])*\")@(?:(?:[a-zA-Z0-9\\p{L}\\p{M}](?:[a-zA-Z0-9\\p{L}\\p{M}-]*[a-zA-Z0-9\\p{L}\\p{M}])?\\.)+[a-zA-Z0-9\\p{L}\\p{M}](?:[a-zA-Z0-9\\p{L}\\p{M}-]*[a-zA-Z0-9\\p{L}\\p{M}])?|\\[(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?|[a-zA-Z0-9-]*[a-z0-9]:(?:[\\x01-\\x08\\x0b\\x0c\\x0e-\\x1f\\x21-\\x5a\\x53-\\x7f]|\\\\[\\x01-\\x09\\x0b\\x0c\\x0e-\\x7f])+)\\])" }, "mailProvider": { "format": "int32", "enum": [ 0, 1 ], "type": "integer" }, "serverAddress": { "type": "string" }, "username": { "type": "string" }, "password": { "type": "string" }, "details": { "type": "string" }, "county": { "type": "string" }, "postalCode": { "type": "string" }, "city": { "type": "string" }, "country": { "type": "string" }, "state": { "type": "string" }, "website": { "type": "string" }, "contactTelephone": { "type": "string" }, "createdOn": { "format": "date-time", "type": "string" }, "lastModifiedOn": { "format": "date-time", "type": "string" }, "isVerified": { "type": "boolean" }, "bulkEmails": { "type": "array", "items": { "$ref": "#/components/schemas/BulkEmail" } }, "mails": { "type": "array", "items": { "$ref": "#/components/schemas/Mail" } }, "unsubscribes": { "type": "array", "items": { "$ref": "#/components/schemas/Unsubscribe" } } } }, "SmsIdentity": { "required": [ "name", "createdOn", "lastModifiedOn" ], "type": "object", "properties": { "id": { "format": "uuid", "type": "string" }, "name": { "type": "string" }, "isDefault": { "type": "boolean" }, "isDeleted": { "type": "boolean" }, "organisationId": { "format": "uuid", "type": "string" }, "organisation": { "$ref": "#/components/schemas/Organisation" }, "smsProvider": { "format": "int32", "enum": [ 0, 1, 2, 3 ], "type": "integer" }, "smsSenderName": { "type": "string" }, "smsUsername": { "type": "string" }, "smsPassword": { "type": "string" }, "smsFromNumber": { "type": "string" }, "createdOn": { "format": "date-time", "type": "string" }, "lastModifiedOn": { "format": "date-time", "type": "string" }, "bulkSmses": { "type": "array", "items": { "$ref": "#/components/schemas/BulkSms" } }, "smses": { "type": "array", "items": { "$ref": "#/components/schemas/Sms" } } } }, "BulkSms": { "required": [ "createdOn", "lastModifiedOn" ], "type": "object", "properties": { "id": { "format": "uuid", "type": "string" }, "organisationId": { "format": "uuid", "type": "string" }, "organisation": { "$ref": "#/components/schemas/Organisation" }, "text": { "type": "string" }, "smsIdentityId": { "format": "uuid", "type": "string" }, "smsIdentity": { "$ref": "#/components/schemas/SmsIdentity" }, "status": { "format": "int32", "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, -1 ], "type": "integer" }, "errorType": { "format": "int32", "enum": [ 0, 1, 2, 3, 4 ], "type": "integer" }, "errorMessage": { "type": "string" }, "isArchived": { "type": "boolean" }, "createdOn": { "format": "date-time", "type": "string" }, "lastModifiedOn": { "format": "date-time", "type": "string" }, "activities": { "type": "array", "items": { "$ref": "#/components/schemas/BulkSmsActivity" } }, "memberLists": { "type": "array", "items": { "$ref": "#/components/schemas/MemberList" } }, "bulkSmsItems": { "type": "array", "items": { "$ref": "#/components/schemas/BulkSmsItem" } }, "tags": { "type": "array", "items": { "$ref": "#/components/schemas/Tag" } }, "organisationMemberships": { "type": "array", "items": { "$ref": "#/components/schemas/OrganisationMembership" } } } }, "DonationCampaign": { "required": [ "createdOn", "lastModifiedOn" ], "type": "object", "properties": { "id": { "format": "uuid", "type": "string" }, "organisationId": { "format": "uuid", "type": "string" }, "organisation": { "$ref": "#/components/schemas/Organisation" }, "name": { "pattern": "^[^<>]*$", "type": "string" }, "description": { "type": "string" }, "shortDescription": { "pattern": "^[^<>]*$", "type": "string" }, "thumbnailUrl": { "type": "string" }, "imageUrl": { "type": "string" }, "imageThumbnailUrl": { "type": "string" }, "startDate": { "format": "date-time", "type": "string" }, "endDate": { "format": "date-time", "type": "string" }, "goal": { "format": "double", "type": "number" }, "createdOn": { "format": "date-time", "type": "string" }, "lastModifiedOn": { "format": "date-time", "type": "string" }, "publishedOn": { "format": "date-time", "type": "string" }, "status": { "format": "int32", "enum": [ 0, 1, 2 ], "type": "integer" }, "isDeleted": { "type": "boolean", "readOnly": true }, "isCustomPaymentEnabled": { "type": "boolean" }, "paymentAccountId": { "format": "uuid", "type": "string" }, "payments": { "type": "array", "items": { "$ref": "#/components/schemas/Payment" } }, "paymentTickets": { "type": "array", "items": { "$ref": "#/components/schemas/PaymentTicket" } }, "donationCampaignPaymentButtons": { "type": "array", "items": { "$ref": "#/components/schemas/DonationCampaignPaymentButton" } }, "publicDonations": { "type": "array", "items": { "$ref": "#/components/schemas/PublicDonation" } } } }, "MemberList": { "required": [ "id", "name", "organisationId", "createdOn", "lastModifiedOn" ], "type": "object", "properties": { "id": { "format": "uuid", "type": "string" }, "name": { "pattern": "^[^<>]*$", "type": "string" }, "organisationId": { "format": "uuid", "type": "string" }, "organisation": { "$ref": "#/components/schemas/Organisation" }, "createdOn": { "format": "date-time", "type": "string" }, "lastModifiedOn": { "format": "date-time", "type": "string" }, "isDeleted": { "type": "boolean" }, "memberListFilters": { "type": "array", "items": { "$ref": "#/components/schemas/MemberListFilter" } }, "bulkEmails": { "type": "array", "items": { "$ref": "#/components/schemas/BulkEmail" } }, "bulkSmses": { "type": "array", "items": { "$ref": "#/components/schemas/BulkSms" } }, "memberSelectors": { "type": "array", "items": { "$ref": "#/components/schemas/MemberSelector" } } } }, "Event": { "required": [ "organisationId", "createdOn", "lastModifiedOn" ], "type": "object", "properties": { "id": { "format": "uuid", "type": "string" }, "organisationId": { "format": "uuid", "type": "string" }, "organisation": { "$ref": "#/components/schemas/Organisation" }, "name": { "pattern": "^[^<>]*$", "type": "string" }, "shortDescription": { "pattern": "^[^<>]*$", "type": "string" }, "imageUrl": { "type": "string" }, "imageThumbnailUrl": { "type": "string" }, "description": { "type": "string" }, "location": { "pattern": "^[^<>]*$", "type": "string" }, "eventDate": { "format": "date-time", "type": "string" }, "eventTime": { "pattern": "^[^<>]*$", "type": "string" }, "createdOn": { "format": "date-time", "type": "string" }, "lastModifiedOn": { "format": "date-time", "type": "string" }, "welcomeScreenIsActive": { "type": "boolean" }, "welcomeScreenPin": { "type": "string" }, "eventStatus": { "format": "int32", "enum": [ 0, 1, -1 ], "type": "integer" }, "checkIns": { "type": "array", "items": { "$ref": "#/components/schemas/CheckIn" } }, "rsvps": { "type": "array", "items": { "$ref": "#/components/schemas/EventRsvp" } }, "eventSmsTemplates": { "type": "array", "items": { "$ref": "#/components/schemas/EventSmsTemplate" } } } }, "Conversation": { "required": [ "createdOn", "lastModifiedOn" ], "type": "object", "properties": { "id": { "format": "uuid", "type": "string" }, "organisationId": { "format": "uuid", "type": "string" }, "organisation": { "$ref": "#/components/schemas/Organisation" }, "conversationMembers": { "type": "array", "items": { "$ref": "#/components/schemas/ConversationMember" } }, "conversationMessages": { "type": "array", "items": { "$ref": "#/components/schemas/ConversationMessage" } }, "createdOn": { "format": "date-time", "type": "string" }, "lastModifiedOn": { "format": "date-time", "type": "string" } } }, "Invoice": { "type": "object", "properties": { "id": { "format": "uuid", "type": "string" }, "organisationId": { "format": "uuid", "type": "string" }, "organisation": { "$ref": "#/components/schemas/Organisation" }, "createdOn": { "format": "date-time", "type": "string" }, "lastModifiedOn": { "format": "date-time", "type": "string" }, "invoiceDate": { "format": "date-time", "type": "string" }, "dueDate": { "format": "date-time", "type": "string" }, "invoiceNumber": { "type": "string" }, "invoiceAddress": { "type": "string" }, "invoiceLineItems": { "type": "array", "items": { "$ref": "#/components/schemas/InvoiceLineItem" } } } }, "CustomPaymentButton": { "type": "object", "properties": { "id": { "format": "uuid", "type": "string" }, "organisationId": { "format": "uuid", "type": "string" }, "organisation": { "$ref": "#/components/schemas/Organisation" }, "description": { "type": "string" }, "amount": { "format": "double", "type": "number" }, "paymentMethod": { "format": "int32", "enum": [ 0, 1, 2, 3, 4, 5, 10 ], "type": "integer" }, "paymentMode": { "format": "int32", "enum": [ 0, 1, 2 ], "type": "integer" }, "paymentPeriod": { "format": "int32", "enum": [ 0 ], "type": "integer" }, "installmentNumber": { "format": "int32", "type": "integer" }, "createdOn": { "format": "date-time", "type": "string" }, "lastModifiedOn": { "format": "date-time", "type": "string" } } }, "MailTemplate": { "required": [ "createdOn", "lastModifiedOn" ], "type": "object", "properties": { "id": { "format": "uuid", "type": "string" }, "organisationId": { "format": "uuid", "type": "string" }, "organisation": { "$ref": "#/components/schemas/Organisation" }, "type": { "format": "int32", "enum": [ 0, 1 ], "type": "integer" }, "subject": { "type": "string" }, "body": { "type": "string" }, "createdOn": { "format": "date-time", "type": "string" }, "lastModifiedOn": { "format": "date-time", "type": "string" } } }, "CustomMemberType": { "required": [ "name" ], "type": "object", "properties": { "id": { "format": "uuid", "type": "string" }, "paymentAccountId": { "format": "uuid", "type": "string" }, "calculatedPaymentAccountId": { "format": "uuid", "type": "string", "readOnly": true }, "organisationId": { "format": "uuid", "type": "string" }, "name": { "pattern": "^[^<>]*$", "type": "string" }, "description": { "pattern": "^[^<>]*$", "type": "string" }, "membershipFee": { "format": "double", "type": "number" }, "membershipFeeInterval": { "format": "int32", "enum": [ 0, 1, 2, 3 ], "type": "integer" }, "canPublicApply": { "type": "boolean" }, "canSocialNetworkApply": { "type": "boolean" }, "gracePeriod": { "format": "int32", "maximum": 2147483647, "minimum": 0, "type": "integer" }, "isMembershipAutomationEnabled": { "type": "boolean" }, "updateOrganisationMembershipStatus": { "type": "boolean" }, "removeDebtAfterCancellation": { "type": "boolean" }, "paymentFailAction": { "format": "int32", "enum": [ 0, 1 ], "type": "integer" }, "hasSpecificStartDate": { "type": "boolean" }, "monthOfStartDate": { "format": "int32", "type": "integer" }, "dayOfStartDate": { "format": "int32", "type": "integer" }, "renewalInterval": { "format": "int32", "type": "integer" }, "createdOn": { "format": "date-time", "type": "string" }, "lastModifiedOn": { "format": "date-time", "type": "string" }, "isDeleted": { "type": "boolean" }, "reminder10DayBeforeTemplateId": { "format": "uuid", "type": "string" }, "reminder5DayBeforeTemplateId": { "format": "uuid", "type": "string" }, "reminderSameDayTemplateId": { "format": "uuid", "type": "string" }, "pastDueNotice10DayAfterTemplateId": { "format": "uuid", "type": "string" }, "pastDueNotice5DayAfterTemplateId": { "format": "uuid", "type": "string" }, "reminder60DayBeforeTemplateId": { "format": "uuid", "type": "string" }, "reminder30DayBeforeTemplateId": { "format": "uuid", "type": "string" }, "pastDueNotice30DayAfterTemplateId": { "format": "uuid", "type": "string" }, "pastDueNotice60DayAfterTemplateId": { "format": "uuid", "type": "string" }, "updateCardUnsuccessfulPaymentTemplateId": { "format": "uuid", "type": "string" }, "receiptSuccessPaymentTemplateId": { "format": "uuid", "type": "string" }, "reminder60DayBeforeEnabled": { "type": "boolean" }, "reminder30DayBeforeEnabled": { "type": "boolean" }, "reminder10DayBeforeEnabled": { "type": "boolean" }, "reminder5DayBeforeEnabled": { "type": "boolean" }, "reminderSameDayEnabled": { "type": "boolean" }, "pastDueNotice5DayAfterEnabled": { "type": "boolean" }, "pastDueNotice10DayAfterEnabled": { "type": "boolean" }, "pastDueNotice30DayAfterEnabled": { "type": "boolean" }, "pastDueNotice60DayAfterEnabled": { "type": "boolean" }, "renewalReminderActiveNoInvoiceNoRecurringTemplateId": { "format": "uuid", "type": "string" }, "renewalReminderActiveNoInvoiceHasRecurringTemplateId": { "format": "uuid", "type": "string" }, "renewalReminderPastdueHasInvoiceHasRecurringTemplateId": { "format": "uuid", "type": "string" }, "renewalReminderPastdueHasInvoiceNoRecurringTemplateId": { "format": "uuid", "type": "string" }, "renewalReminderScheduledNotStartedTemplateId": { "format": "uuid", "type": "string" }, "endDateReminderEnabled": { "type": "boolean" }, "endDateReminder1Days": { "format": "int32", "type": "integer" }, "endDateReminder1TemplateId": { "format": "uuid", "type": "string" }, "endDateReminder2Days": { "format": "int32", "type": "integer" }, "endDateReminder2TemplateId": { "format": "uuid", "type": "string" }, "endDateReminder3Days": { "format": "int32", "type": "integer" }, "endDateReminder3TemplateId": { "format": "uuid", "type": "string" }, "allowMultipleSubscription": { "type": "boolean" }, "backgroundColor": { "maxLength": 30, "minLength": 0, "type": "string" }, "textColor": { "maxLength": 30, "minLength": 0, "type": "string" }, "colorsInheritedFromDigitalCardSettings": { "type": "boolean" }, "customMembershipCount": { "format": "int32", "type": "integer" }, "signupFormEnabled": { "type": "boolean" }, "signupFormAutoApproval": { "type": "boolean" }, "signupFormFields": { "type": "string" }, "signupFormFieldList": { "type": "array", "items": { "$ref": "#/components/schemas/SignUpFormFieldObject" } }, "groupMembershipEnabled": { "type": "boolean" }, "groupMembershipPriceType": { "format": "int32", "enum": [ 1, 2 ], "type": "integer" }, "maxGroupMemberCount": { "format": "int32", "type": "integer" }, "groupMembershipPlanIds": { "type": "object", "additionalProperties": { "type": "boolean" } }, "groupMembershipFormFields": { "type": "string" }, "groupMembershipFormFieldList": { "type": "array", "items": { "$ref": "#/components/schemas/SignUpFormFieldObject" } }, "freePeriodInDays": { "format": "int32", "type": "integer" }, "currency": { "format": "int32", "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62, 63, 64, 65, 66, 67, 68, 69, 70, 71, 72, 73, 74, 75, 76, 77, 78, 79, 80, 81, 82, 83, 84, 85, 86, 87, 88, 89, 90, 91, 92, 93, 94, 95, 96, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 112, 113, 114, 115, 116, 117, 118, 119, 120, 121, 122, 123, 124, 125, 126, 127, 128, 129, 130, 131, 132, 133, 134, 135, 136, 137 ], "type": "integer" } } }, "SocialNetwork": { "required": [ "name", "url", "socialNetworkType", "createdOn", "lastModifiedOn" ], "type": "object", "properties": { "id": { "format": "uuid", "type": "string" }, "name": { "pattern": "^[^<>]*$", "type": "string" }, "description": { "pattern": "^[^<>]*$", "type": "string" }, "url": { "pattern": "^[^<>]*$", "type": "string" }, "organisationId": { "format": "uuid", "type": "string" }, "organisation": { "$ref": "#/components/schemas/Organisation" }, "socialNetworkType": { "format": "int32", "enum": [ 0, 1, 2, 3 ], "type": "integer" }, "createdOn": { "format": "date-time", "type": "string" }, "lastModifiedOn": { "format": "date-time", "type": "string" } } }, "AnnualMembershipFee": { "required": [ "year", "amount", "inscriptionFee", "createdOn", "lastModifiedOn" ], "type": "object", "properties": { "id": { "format": "uuid", "type": "string" }, "organisationId": { "format": "uuid", "type": "string" }, "organisation": { "$ref": "#/components/schemas/Organisation" }, "customMemberTypeId": { "format": "uuid", "type": "string" }, "customMemberType": { "$ref": "#/components/schemas/CustomMemberType" }, "year": { "format": "int32", "type": "integer" }, "amount": { "format": "double", "type": "number" }, "inscriptionFee": { "format": "double", "type": "number" }, "description": { "type": "string" }, "createdOn": { "format": "date-time", "type": "string" }, "lastModifiedOn": { "format": "date-time", "type": "string" } } }, "EventV2": { "required": [ "createdOn", "lastModifiedOn" ], "type": "object", "properties": { "id": { "format": "uuid", "type": "string" }, "organisationId": { "format": "uuid", "type": "string" }, "organisation": { "$ref": "#/components/schemas/Organisation" }, "title": { "type": "string" }, "shortDescription": { "type": "string" }, "description": { "type": "string" }, "venueName": { "type": "string" }, "address": { "type": "string" }, "city": { "type": "string" }, "state": { "type": "string" }, "zip": { "pattern": "^[^<>]*$", "type": "string" }, "country": { "type": "string" }, "startDate": { "format": "date-time", "type": "string" }, "endDate": { "format": "date-time", "type": "string" }, "imageUrl": { "type": "string" }, "thumbnailUrl": { "type": "string" }, "lng": { "type": "string" }, "lat": { "type": "string" }, "facebookLink": { "type": "string" }, "isPublic": { "type": "boolean" }, "isInviteOnly": { "type": "boolean" }, "memberSelectorId": { "format": "uuid", "type": "string" }, "memberSelector": { "$ref": "#/components/schemas/MemberSelector" }, "ticketButtons": { "type": "array", "items": { "$ref": "#/components/schemas/EventV2TicketButton" } }, "eventStatus": { "format": "int32", "enum": [ 0, 1, -1 ], "type": "integer" }, "createdOn": { "format": "date-time", "type": "string" }, "lastModifiedOn": { "format": "date-time", "type": "string" } } }, "AdminReportReceiver": { "type": "object", "properties": { "id": { "format": "uuid", "type": "string" }, "organisationId": { "format": "uuid", "type": "string" }, "organisation": { "$ref": "#/components/schemas/Organisation" }, "emailAddress": { "type": "string" }, "lastLoggedOn": { "format": "date-time", "type": "string" }, "createdOn": { "format": "date-time", "type": "string" }, "lastModifiedOn": { "format": "date-time", "type": "string" } } }, "ImportJob": { "type": "object", "properties": { "id": { "format": "uuid", "type": "string" }, "organisationId": { "format": "uuid", "type": "string" }, "organisation": { "$ref": "#/components/schemas/Organisation" }, "createdOn": { "format": "date-time", "type": "string" }, "lastModifiedOn": { "format": "date-time", "type": "string" }, "importJobType": { "format": "int32", "enum": [ 0, 1 ], "type": "integer" } } }, "StaticPage": { "type": "object", "properties": { "id": { "format": "uuid", "type": "string" }, "title": { "type": "string" }, "html": { "type": "string" }, "order": { "format": "int32", "type": "integer" }, "organisationId": { "format": "uuid", "type": "string" }, "organisation": { "$ref": "#/components/schemas/Organisation" } } }, "PaymentAccount": { "required": [ "name" ], "type": "object", "properties": { "id": { "format": "uuid", "type": "string" }, "organisationId": { "format": "uuid", "type": "string" }, "organisation": { "$ref": "#/components/schemas/Organisation" }, "status": { "type": "string" }, "creditCardProcessor": { "format": "int32", "enum": [ 0, 1, 2, 4, 5, 6 ], "type": "integer" }, "subMerchantId": { "type": "string" }, "caracolesSubMerchantId": { "type": "string" }, "name": { "type": "string" }, "data": { "type": "string" } } }, "PublicDonation": { "type": "object", "properties": { "id": { "format": "uuid", "type": "string" }, "donationCampaignId": { "format": "uuid", "type": "string" }, "donationCampaign": { "$ref": "#/components/schemas/DonationCampaign" }, "organisationId": { "format": "uuid", "type": "string" }, "organisation": { "$ref": "#/components/schemas/Organisation" }, "title": { "type": "string" }, "description": { "type": "string" }, "photoUrl": { "type": "string" }, "currency": { "format": "int32", "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62, 63, 64, 65, 66, 67, 68, 69, 70, 71, 72, 73, 74, 75, 76, 77, 78, 79, 80, 81, 82, 83, 84, 85, 86, 87, 88, 89, 90, 91, 92, 93, 94, 95, 96, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 112, 113, 114, 115, 116, 117, 118, 119, 120, 121, 122, 123, 124, 125, 126, 127, 128, 129, 130, 131, 132, 133, 134, 135, 136, 137 ], "type": "integer" }, "isRecurringPaymentsEnabled": { "type": "boolean" }, "isCustomAmountEnabled": { "type": "boolean" }, "isAnonymousPaymentEnabled": { "type": "boolean" }, "createdOn": { "format": "date-time", "type": "string" }, "lastModifiedOn": { "format": "date-time", "type": "string" }, "paymentAccountId": { "format": "uuid", "type": "string" }, "payments": { "type": "array", "items": { "$ref": "#/components/schemas/Payment" } }, "publicDonationPaymentOptions": { "type": "array", "items": { "$ref": "#/components/schemas/PublicDonationPaymentOption" } }, "paymentTicket": { "type": "array", "items": { "$ref": "#/components/schemas/PaymentTicket" } }, "isDeleted": { "type": "boolean" }, "isPublished": { "type": "boolean" } } }, "OrganisationRakletApp": { "required": [ "id", "organisationId", "rakletAppId", "createdOn" ], "type": "object", "properties": { "id": { "format": "uuid", "type": "string" }, "organisationId": { "format": "uuid", "type": "string" }, "rakletAppId": { "format": "uuid", "type": "string" }, "otherDescription": { "type": "string" }, "createdOn": { "format": "date-time", "type": "string" }, "isActivated": { "type": "boolean" }, "organisation": { "$ref": "#/components/schemas/Organisation" }, "rakletApp": { "$ref": "#/components/schemas/RakletApp" } } }, "SmsSetting": { "required": [ "id", "smsDiscountGlobal", "smsDiscountTurkey", "organisationId", "createdOn" ], "type": "object", "properties": { "id": { "format": "uuid", "type": "string" }, "smsDiscountGlobal": { "format": "double", "type": "number" }, "smsDiscountTurkey": { "format": "double", "type": "number" }, "smsCreditCardTokenId": { "type": "string" }, "organisationId": { "format": "uuid", "type": "string" }, "organisation": { "$ref": "#/components/schemas/Organisation" }, "createdOn": { "format": "date-time", "type": "string" }, "lastModifiedOn": { "format": "date-time", "type": "string" }, "isDeleted": { "type": "boolean" } } }, "SmsBalance": { "required": [ "id", "currentBalance", "organisationId", "createdOn" ], "type": "object", "properties": { "id": { "format": "uuid", "type": "string" }, "previousBalance": { "format": "double", "type": "number" }, "currentBalance": { "format": "double", "type": "number" }, "organisationId": { "format": "uuid", "type": "string" }, "organisation": { "$ref": "#/components/schemas/Organisation" }, "lastChargeSmsId": { "format": "uuid", "type": "string" }, "createdOn": { "format": "date-time", "type": "string" }, "lastModifiedOn": { "format": "date-time", "type": "string" }, "isDeleted": { "type": "boolean" } } }, "Category": { "required": [ "slug", "createdOn" ], "type": "object", "properties": { "id": { "format": "uuid", "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "imageUrl": { "type": "string" }, "slug": { "type": "string" }, "accessType": { "format": "int32", "enum": [ 0, 1, 2, 3, 4, 5 ], "type": "integer" }, "postCreatePermission": { "format": "int32", "enum": [ 0, 1, 2, 3 ], "type": "integer" }, "postApprovalRequired": { "type": "boolean" }, "postCommentCreatePermission": { "format": "int32", "enum": [ 0, 1, 2, 3 ], "type": "integer" }, "postCommentApprovalRequired": { "type": "boolean" }, "visibility": { "format": "int32", "enum": [ 0, 1, 2, 3 ], "type": "integer" }, "isDefault": { "type": "boolean" }, "organisationId": { "format": "uuid", "type": "string" }, "organisation": { "$ref": "#/components/schemas/Organisation" }, "announcements": { "type": "array", "items": { "$ref": "#/components/schemas/Announcement" } }, "customMemberTypes": { "type": "array", "items": { "$ref": "#/components/schemas/CustomMemberType" } }, "subscribers": { "type": "array", "items": { "$ref": "#/components/schemas/CategorySubscriber" } }, "categoryMembers": { "type": "array", "items": { "$ref": "#/components/schemas/CategoryMember" } }, "createdOn": { "format": "date-time", "type": "string" }, "lastModifiedOn": { "format": "date-time", "type": "string" }, "isDeleted": { "type": "boolean" }, "tagId": { "format": "uuid", "type": "string" }, "postLike": { "format": "int32", "enum": [ 0, 1 ], "type": "integer" }, "postComment": { "format": "int32", "enum": [ 0, 1 ], "type": "integer" }, "postShare": { "format": "int32", "enum": [ 0, 1 ], "type": "integer" }, "layout": { "format": "int32", "enum": [ 0, 1 ], "type": "integer" }, "columns": { "format": "int32", "enum": [ 1, 2, 3 ], "type": "integer" }, "isVisibleOnTheFeed": { "type": "boolean" }, "isAutoSubscribeMembers": { "type": "boolean" }, "isShowSubscribersOnBoardPage": { "type": "boolean" } } }, "WorkSector": { "required": [ "sectorName", "createdOn", "lastModifiedOn" ], "type": "object", "properties": { "id": { "format": "uuid", "type": "string" }, "sectorName": { "type": "string" }, "workId": { "format": "uuid", "type": "string" }, "work": { "$ref": "#/components/schemas/Work" }, "organisationId": { "format": "uuid", "type": "string" }, "organisation": { "$ref": "#/components/schemas/Organisation" }, "organisationMembershipId": { "format": "uuid", "type": "string" }, "organisationMembership": { "$ref": "#/components/schemas/OrganisationMembership" }, "sectorSlug": { "type": "string" }, "createdOn": { "format": "date-time", "type": "string" }, "lastModifiedOn": { "format": "date-time", "type": "string" } } }, "Post": { "required": [ "title", "body", "createdOn", "lastModifiedOn" ], "type": "object", "properties": { "id": { "format": "uuid", "type": "string" }, "groupId": { "format": "uuid", "type": "string" }, "group": { "$ref": "#/components/schemas/Group" }, "title": { "type": "string" }, "body": { "type": "string" }, "parentId": { "format": "uuid", "type": "string" }, "parent": { "$ref": "#/components/schemas/Post" }, "_FullName": { "type": "string" }, "groupMembershipId": { "format": "uuid", "type": "string" }, "groupMembership": { "$ref": "#/components/schemas/GroupMembership" }, "childPosts": { "type": "array", "items": { "$ref": "#/components/schemas/Post" } }, "createdOn": { "format": "date-time", "type": "string" }, "lastModifiedOn": { "format": "date-time", "type": "string" }, "fullName": { "type": "string", "readOnly": true }, "getPictureUrl": { "type": "string", "readOnly": true } } }, "PaymentNotification": { "required": [ "createdOn", "lastModifiedOn" ], "type": "object", "properties": { "id": { "format": "uuid", "type": "string" }, "organisationId": { "format": "uuid", "type": "string" }, "organisation": { "$ref": "#/components/schemas/Organisation" }, "body": { "type": "string" }, "isVerified": { "type": "boolean" }, "source": { "format": "int32", "enum": [ 0, 1, 2, 3 ], "type": "integer" }, "status": { "format": "int32", "enum": [ 0, 1, -1 ], "type": "integer" }, "errorType": { "format": "int32", "enum": [ 0, 1, 2 ], "type": "integer" }, "paymentId": { "format": "uuid", "type": "string" }, "payment": { "$ref": "#/components/schemas/Payment" }, "createdOn": { "format": "date-time", "type": "string" }, "lastModifiedOn": { "format": "date-time", "type": "string" } } }, "PaymentRefund": { "required": [ "connectedAccountId", "idempotencyKey" ], "type": "object", "properties": { "id": { "format": "uuid", "type": "string" }, "paymentId": { "format": "uuid", "type": "string" }, "payment": { "$ref": "#/components/schemas/Payment" }, "organisationId": { "format": "uuid", "type": "string" }, "organisation": { "$ref": "#/components/schemas/Organisation" }, "organisationMembershipId": { "format": "uuid", "type": "string" }, "organisationMembership": { "$ref": "#/components/schemas/OrganisationMembership" }, "amount": { "format": "double", "type": "number" }, "currency": { "format": "int32", "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62, 63, 64, 65, 66, 67, 68, 69, 70, 71, 72, 73, 74, 75, 76, 77, 78, 79, 80, 81, 82, 83, 84, 85, 86, 87, 88, 89, 90, 91, 92, 93, 94, 95, 96, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 112, 113, 114, 115, 116, 117, 118, 119, 120, 121, 122, 123, 124, 125, 126, 127, 128, 129, 130, 131, 132, 133, 134, 135, 136, 137 ], "type": "integer" }, "status": { "format": "int32", "enum": [ 0, 1, 2, 3 ], "type": "integer" }, "stripeRefundId": { "type": "string" }, "stripeChargeId": { "type": "string" }, "stripePaymentIntentId": { "type": "string" }, "stripeBalanceTransactionId": { "type": "string" }, "connectedAccountId": { "type": "string" }, "requestedByRakletId": { "format": "uuid", "type": "string" }, "requestedOn": { "format": "date-time", "type": "string" }, "processedOn": { "format": "date-time", "type": "string" }, "idempotencyKey": { "type": "string" }, "reason": { "type": "string" }, "failureReason": { "type": "string" }, "metadataJson": { "type": "string" }, "note": { "type": "string" } } }, "BulkSmsItem": { "required": [ "createdOn", "lastModifiedOn" ], "type": "object", "properties": { "id": { "format": "uuid", "type": "string" }, "status": { "format": "int32", "enum": [ 0, 1, 2, -1 ], "type": "integer" }, "errorType": { "format": "int32", "enum": [ 0, 1, 2, 3, 4, 5, 6, 7 ], "type": "integer" }, "errorMessage": { "type": "string" }, "bulkSmsId": { "format": "uuid", "type": "string" }, "bulkSms": { "$ref": "#/components/schemas/BulkSms" }, "organisationMembershipId": { "format": "uuid", "type": "string" }, "organisationMembership": { "$ref": "#/components/schemas/OrganisationMembership" }, "_FullName": { "type": "string" }, "smsId": { "format": "uuid", "type": "string" }, "createdOn": { "format": "date-time", "type": "string" }, "lastModifiedOn": { "format": "date-time", "type": "string" }, "fullName": { "type": "string", "readOnly": true }, "phoneNumber": { "type": "string" } } }, "PaymentTicketInvoice": { "type": "object", "properties": { "id": { "format": "uuid", "type": "string" }, "paymentTicketId": { "format": "uuid", "type": "string" }, "paymentTicket": { "$ref": "#/components/schemas/PaymentTicket" }, "invoiceId": { "format": "uuid", "type": "string" }, "invoice": { "$ref": "#/components/schemas/Debt" } } }, "MemberListFilter": { "type": "object", "properties": { "id": { "format": "uuid", "type": "string" }, "memberListId": { "format": "uuid", "type": "string" }, "memberList": { "$ref": "#/components/schemas/MemberList" }, "type": { "format": "int32", "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, -32, -31, -26, -24, -20, -19, -18, -17, -16, -15, -14, -13, -12, -11, -10, -9, -8, -7, -6, -5, -4, -3, -2, -1 ], "type": "integer" }, "objectId": { "format": "uuid", "type": "string" }, "value": { "type": "string" }, "tags": { "type": "array", "items": { "$ref": "#/components/schemas/Tag" } } } }, "BulkEmailAttachment": { "required": [ "createdOn" ], "type": "object", "properties": { "id": { "format": "uuid", "type": "string" }, "fileName": { "type": "string" }, "size": { "format": "int32", "type": "integer" }, "bulkEmailId": { "format": "uuid", "type": "string" }, "bulkEmail": { "$ref": "#/components/schemas/BulkEmail" }, "bulkEmailTemplateAttachmentId": { "format": "uuid", "type": "string" }, "createdOn": { "format": "date-time", "type": "string" } } }, "BulkEmailActivity": { "required": [ "createdOn" ], "type": "object", "properties": { "id": { "format": "uuid", "type": "string" }, "bulkEmailId": { "format": "uuid", "type": "string" }, "bulkEmail": { "$ref": "#/components/schemas/BulkEmail" }, "type": { "format": "int32", "enum": [ 0, 1, 2, 3, 4, 5, -1 ], "type": "integer" }, "errorType": { "format": "int32", "enum": [ 0, 1, 2, 3, 4 ], "type": "integer" }, "errorMessage": { "type": "string" }, "organisationMembershipId": { "format": "uuid", "type": "string" }, "fullName": { "type": "string" }, "emailAddress": { "type": "string" }, "mailId": { "format": "uuid", "type": "string" }, "createdOn": { "format": "date-time", "type": "string" } } }, "BulkEmailItem": { "required": [ "createdOn", "lastModifiedOn" ], "type": "object", "properties": { "id": { "format": "uuid", "type": "string" }, "status": { "format": "int32", "enum": [ 0, 1, 2, 3, -1 ], "type": "integer" }, "errorType": { "format": "int32", "enum": [ 0, 1, 2, 3, 4, 5, 6, 99, 100, 101, 102 ], "type": "integer" }, "errorMessage": { "type": "string" }, "bulkEmailId": { "format": "uuid", "type": "string" }, "bulkEmail": { "$ref": "#/components/schemas/BulkEmail" }, "organisationMembershipId": { "format": "uuid", "type": "string" }, "organisationMembership": { "$ref": "#/components/schemas/OrganisationMembership" }, "_FullName": { "type": "string" }, "emailAddress": { "type": "string" }, "mailId": { "format": "uuid", "type": "string" }, "createdOn": { "format": "date-time", "type": "string" }, "lastModifiedOn": { "format": "date-time", "type": "string" }, "fullName": { "type": "string", "readOnly": true }, "bulkEmailItemActivities": { "type": "array", "items": { "$ref": "#/components/schemas/BulkEmailItemActivity" } } } }, "BulkEmailPart": { "required": [ "createdOn", "lastModifiedOn" ], "type": "object", "properties": { "id": { "format": "uuid", "type": "string" }, "type": { "format": "int32", "enum": [ 0, 1, 2, 3, 4, 5 ], "type": "integer" }, "content": { "type": "string" }, "orderNumber": { "format": "int32", "type": "integer" }, "bulkEmailId": { "format": "uuid", "type": "string" }, "bulkEmail": { "$ref": "#/components/schemas/BulkEmail" }, "bulkEmailV2AttachmentId": { "format": "uuid", "type": "string" }, "bulkEmailV2Attachment": { "$ref": "#/components/schemas/BulkEmailV2Attachment" }, "createdOn": { "format": "date-time", "type": "string" }, "lastModifiedOn": { "format": "date-time", "type": "string" }, "isEditable": { "type": "boolean", "readOnly": true }, "isContentEmpty": { "type": "boolean", "readOnly": true } } }, "BulkEmailV2Attachment": { "required": [ "createdOn" ], "type": "object", "properties": { "id": { "format": "uuid", "type": "string" }, "fileName": { "type": "string" }, "size": { "format": "int32", "type": "integer" }, "bulkEmailId": { "format": "uuid", "type": "string" }, "bulkEmail": { "$ref": "#/components/schemas/BulkEmail" }, "bulkEmailTemplateAttachmentId": { "format": "uuid", "type": "string" }, "url": { "type": "string" }, "storageUrl": { "type": "string" }, "bulkEmailPartId": { "format": "uuid", "type": "string" }, "createdOn": { "format": "date-time", "type": "string" } } }, "SupportTicket": { "required": [ "createdOn", "lastModifiedOn" ], "type": "object", "properties": { "id": { "format": "uuid", "type": "string" }, "organisationId": { "format": "uuid", "type": "string" }, "organisation": { "$ref": "#/components/schemas/Organisation" }, "_FullName": { "type": "string" }, "subject": { "type": "string" }, "supportTicketStatus": { "format": "int32", "enum": [ 0, -1 ], "type": "integer" }, "createdOn": { "format": "date-time", "type": "string" }, "lastModifiedOn": { "format": "date-time", "type": "string" }, "closedOn": { "format": "date-time", "type": "string" }, "closedById": { "format": "uuid", "type": "string" }, "closedBy": { "$ref": "#/components/schemas/OrganisationMembership" }, "_ClosedByName": { "type": "string" }, "supportTicketMessages": { "type": "array", "items": { "$ref": "#/components/schemas/SupportTicketMessage" } } } }, "OrganisationMembershipAttachment": { "required": [ "createdOn" ], "type": "object", "properties": { "id": { "format": "uuid", "type": "string" }, "fileName": { "type": "string" }, "size": { "format": "int32", "type": "integer" }, "organisationMembershipFileId": { "format": "uuid", "type": "string" }, "organisationMembershipFile": { "$ref": "#/components/schemas/OrganisationMembershipFile" }, "createdOn": { "format": "date-time", "type": "string" } } }, "EventV2TicketButton": { "required": [ "createdOn", "lastModifiedOn" ], "type": "object", "properties": { "id": { "format": "uuid", "type": "string" }, "eventV2Id": { "format": "uuid", "type": "string" }, "eventV2": { "$ref": "#/components/schemas/EventV2" }, "name": { "type": "string" }, "description": { "type": "string" }, "type": { "format": "int32", "enum": [ 0, 1, 2 ], "type": "integer" }, "quantity": { "format": "int32", "type": "integer" }, "price": { "format": "double", "type": "number" }, "startDate": { "format": "date-time", "type": "string" }, "endDate": { "format": "date-time", "type": "string" }, "allowPerOrderMax": { "format": "int32", "type": "integer" }, "availability": { "format": "int32", "enum": [ 0, 1, 2 ], "type": "integer" }, "customMemberTypeId": { "format": "uuid", "type": "string" }, "customMemberType": { "$ref": "#/components/schemas/CustomMemberType" }, "isArchived": { "type": "boolean" }, "createdOn": { "format": "date-time", "type": "string" }, "lastModifiedOn": { "format": "date-time", "type": "string" } } }, "SmsBlast": { "type": "object", "properties": { "id": { "format": "uuid", "type": "string" }, "fromName": { "type": "string" }, "organisationId": { "format": "uuid", "type": "string" }, "organisation": { "$ref": "#/components/schemas/Organisation" }, "memberSelectorId": { "format": "uuid", "type": "string" }, "memberSelector": { "$ref": "#/components/schemas/MemberSelector" }, "smsBlastCategoryId": { "format": "uuid", "type": "string" }, "smsBlastCategory": { "$ref": "#/components/schemas/SmsBlastCategory" }, "smsBlastStatus": { "format": "int32", "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, -1 ], "type": "integer" }, "text": { "type": "string" }, "createdById": { "format": "uuid", "type": "string" }, "createdByFullName": { "type": "string" }, "createdOn": { "format": "date-time", "type": "string" }, "lastModifiedOn": { "format": "date-time", "type": "string" }, "isArchived": { "type": "boolean" }, "smsIdentityId": { "format": "uuid", "type": "string" }, "smsIdentity": { "$ref": "#/components/schemas/SmsIdentity" } } }, "SmsBlastCategory": { "type": "object", "properties": { "id": { "format": "uuid", "type": "string" }, "organisationId": { "format": "uuid", "type": "string" }, "organisation": { "$ref": "#/components/schemas/Organisation" }, "name": { "type": "string" }, "isArchived": { "type": "boolean" }, "createdOn": { "format": "date-time", "type": "string" }, "lastModifiedOn": { "format": "date-time", "type": "string" }, "smsBlastCategoryUnsubscribes": { "type": "array", "items": { "$ref": "#/components/schemas/SmsBlastCategoryUnsubscribe" } } } }, "ChargeCreditCardSubscription": { "type": "object", "properties": { "id": { "format": "uuid", "type": "string" }, "createdOn": { "format": "date-time", "type": "string" }, "lastModifiedOn": { "format": "date-time", "type": "string" }, "chargingPeriod": { "format": "int32", "type": "integer" }, "creditCardSubscriptionId": { "format": "uuid", "type": "string" }, "creditCardSubscription": { "$ref": "#/components/schemas/CreditCardSubscription" }, "paymentId": { "format": "uuid", "type": "string" }, "payment": { "$ref": "#/components/schemas/Payment" }, "chargingStatus": { "format": "int32", "enum": [ 0, 1, 2 ], "type": "integer" }, "errorMessage": { "type": "string" } } }, "AnnouncementAttachment": { "required": [ "createdOn" ], "type": "object", "properties": { "id": { "format": "uuid", "type": "string" }, "fileName": { "type": "string" }, "title": { "type": "string" }, "size": { "format": "int32", "type": "integer" }, "announcementId": { "format": "uuid", "type": "string" }, "announcement": { "$ref": "#/components/schemas/Announcement" }, "createdOn": { "format": "date-time", "type": "string" } } }, "Link": { "type": "object", "properties": { "id": { "format": "uuid", "type": "string" }, "url": { "type": "string" }, "siteName": { "type": "string" }, "description": { "type": "string" }, "title": { "type": "string" }, "imageUrl": { "type": "string" }, "announcements": { "type": "array", "items": { "$ref": "#/components/schemas/Announcement" } } } }, "PollOption": { "required": [ "text", "createdOn" ], "type": "object", "properties": { "id": { "format": "uuid", "type": "string" }, "announcementId": { "format": "uuid", "type": "string" }, "announcement": { "$ref": "#/components/schemas/Announcement" }, "text": { "type": "string" }, "displayOrder": { "format": "int32", "type": "integer" }, "createdOn": { "format": "date-time", "type": "string" }, "votes": { "type": "array", "items": { "$ref": "#/components/schemas/PollVote" } } } }, "PollVote": { "required": [ "createdOn" ], "type": "object", "properties": { "id": { "format": "uuid", "type": "string" }, "announcementId": { "format": "uuid", "type": "string" }, "announcement": { "$ref": "#/components/schemas/Announcement" }, "pollOptionId": { "format": "uuid", "type": "string" }, "pollOption": { "$ref": "#/components/schemas/PollOption" }, "organisationMembershipId": { "format": "uuid", "type": "string" }, "organisationMembership": { "$ref": "#/components/schemas/OrganisationMembership" }, "createdOn": { "format": "date-time", "type": "string" } } }, "BulkSmsActivity": { "required": [ "createdOn" ], "type": "object", "properties": { "id": { "format": "uuid", "type": "string" }, "bulkSmsId": { "format": "uuid", "type": "string" }, "bulkSms": { "$ref": "#/components/schemas/BulkSms" }, "type": { "format": "int32", "enum": [ 0, 1, 2, 3, 4, -1 ], "type": "integer" }, "errorType": { "format": "int32", "enum": [ 0, 1, 2, 3, 4 ], "type": "integer" }, "errorMessage": { "type": "string" }, "organisationMembershipId": { "format": "uuid", "type": "string" }, "organisationMembership": { "$ref": "#/components/schemas/OrganisationMembership" }, "fullName": { "type": "string" }, "phoneNumber": { "type": "string" }, "smsId": { "format": "uuid", "type": "string" }, "createdOn": { "format": "date-time", "type": "string" } } }, "DonationCampaignPaymentButton": { "type": "object", "properties": { "id": { "format": "uuid", "type": "string" }, "donationCampaignId": { "format": "uuid", "type": "string" }, "donationCampaign": { "$ref": "#/components/schemas/DonationCampaign" }, "description": { "type": "string" }, "amount": { "format": "double", "type": "number" }, "paymentMethod": { "format": "int32", "enum": [ 0, 1, 2, 3, 4, 5, 10 ], "type": "integer" }, "paymentMode": { "format": "int32", "enum": [ 0, 1, 2 ], "type": "integer" }, "paymentPeriod": { "format": "int32", "enum": [ 0 ], "type": "integer" }, "createdOn": { "format": "date-time", "type": "string" }, "lastModifiedOn": { "format": "date-time", "type": "string" } } }, "EventRsvp": { "type": "object", "properties": { "id": { "format": "uuid", "type": "string" }, "eventId": { "format": "uuid", "type": "string" }, "event": { "$ref": "#/components/schemas/Event" }, "organisationMembershipId": { "format": "uuid", "type": "string" }, "organisationMembership": { "$ref": "#/components/schemas/OrganisationMembership" }, "_FullName": { "type": "string" }, "createdOn": { "format": "date-time", "type": "string" }, "lastModifiedOn": { "format": "date-time", "type": "string" }, "rsvpType": { "format": "int32", "enum": [ 0, 1, 2, -1 ], "type": "integer" } } }, "EventSmsTemplate": { "required": [ "name", "text" ], "type": "object", "properties": { "id": { "format": "uuid", "type": "string" }, "eventId": { "format": "uuid", "type": "string" }, "event": { "$ref": "#/components/schemas/Event" }, "name": { "pattern": "^[^<>]*$", "type": "string" }, "text": { "pattern": "^[^<>]*$", "type": "string" }, "createdOn": { "format": "date-time", "type": "string" }, "lastModifiedOn": { "format": "date-time", "type": "string" }, "isWelcomeMessage": { "type": "boolean" } } }, "ConversationMessage": { "required": [ "text", "createdOn", "lastModifiedOn" ], "type": "object", "properties": { "id": { "format": "uuid", "type": "string" }, "text": { "type": "string" }, "conversationId": { "format": "uuid", "type": "string" }, "conversation": { "$ref": "#/components/schemas/Conversation" }, "organisationMembershipId": { "format": "uuid", "type": "string" }, "_FullName": { "type": "string" }, "organisationMembership": { "$ref": "#/components/schemas/OrganisationMembership" }, "mailId": { "format": "uuid", "type": "string" }, "createdOn": { "format": "date-time", "type": "string" }, "lastModifiedOn": { "format": "date-time", "type": "string" }, "fullName": { "type": "string", "readOnly": true } } }, "InvoiceLineItem": { "type": "object", "properties": { "id": { "format": "uuid", "type": "string" }, "invoiceId": { "format": "uuid", "type": "string" }, "invoice": { "$ref": "#/components/schemas/Invoice" }, "description": { "type": "string" }, "quantity": { "format": "int32", "type": "integer" }, "unitAmount": { "format": "double", "type": "number" }, "discountRate": { "format": "double", "type": "number" }, "rakletPackage": { "format": "int32", "enum": [ 0, 1, 2, 99 ], "type": "integer" } } }, "SignUpFormFieldObject": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "isRequired": { "type": "boolean" }, "isIncluded": { "type": "boolean" }, "isDeleted": { "type": "boolean" } } }, "PublicDonationPaymentOption": { "type": "object", "properties": { "id": { "format": "uuid", "type": "string" }, "organisationId": { "format": "uuid", "type": "string" }, "publicDonationId": { "format": "uuid", "type": "string" }, "publicDonation": { "$ref": "#/components/schemas/PublicDonation" }, "amount": { "format": "double", "type": "number" }, "createdOn": { "format": "date-time", "type": "string" }, "lastModifiedOn": { "format": "date-time", "type": "string" }, "isDeleted": { "type": "boolean" } } }, "RakletApp": { "required": [ "id", "name", "keyName", "createdOn", "lastModifiedOn" ], "type": "object", "properties": { "id": { "format": "uuid", "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "keyName": { "type": "string" }, "type": { "format": "int32", "enum": [ 0, 1, 2 ], "type": "integer" }, "isDeleted": { "type": "boolean" }, "createdOn": { "format": "date-time", "type": "string" }, "lastModifiedOn": { "format": "date-time", "type": "string" } } }, "CategoryMember": { "required": [ "categoryId", "organisationMembershipId" ], "type": "object", "properties": { "id": { "format": "uuid", "type": "string" }, "categoryId": { "format": "uuid", "type": "string" }, "organisationMembershipId": { "format": "uuid", "type": "string" }, "createdOn": { "format": "date-time", "type": "string" }, "createdBy": { "format": "uuid", "type": "string" }, "category": { "$ref": "#/components/schemas/Category" }, "organisationMembership": { "$ref": "#/components/schemas/OrganisationMembership" } } }, "BulkEmailItemActivity": { "required": [ "createdOn" ], "type": "object", "properties": { "id": { "format": "uuid", "type": "string" }, "type": { "format": "int32", "enum": [ 0, 1 ], "type": "integer" }, "bulkEmailItemId": { "format": "uuid", "type": "string" }, "bulkEmailItem": { "$ref": "#/components/schemas/BulkEmailItem" }, "bulkEmailAttachmentId": { "format": "uuid", "type": "string" }, "bulkEmailAttachment": { "$ref": "#/components/schemas/BulkEmailAttachment" }, "createdOn": { "format": "date-time", "type": "string" } } }, "CreditCardChargeTicketResponseDto": { "type": "object", "properties": {} }, "JobPostingDto": { "required": [ "description" ], "type": "object", "properties": { "description": { "type": "string" }, "position": { "pattern": "^[^<>]*$", "type": "string" }, "company": { "pattern": "^[^<>]*$", "type": "string" }, "jobPostingStatus": { "format": "int32", "enum": [ 0, 1, 2, 3, -1 ], "type": "integer" }, "fullName": { "pattern": "^[^<>]*$", "type": "string" }, "publishedOn": { "format": "date-time", "type": "string" }, "viewCount": { "format": "int32", "type": "integer" }, "jobType": { "format": "int32", "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8 ], "type": "integer" }, "workPlaceType": { "format": "int32", "enum": [ 0, 1, 2, 3 ], "type": "integer" }, "validUntil": { "format": "date-time", "type": "string" }, "country": { "type": "string" }, "city": { "type": "string" }, "slug": { "type": "string" }, "id": { "format": "uuid", "type": "string" } } }, "JobSeekersController_JobSeekerDto": { "type": "object", "properties": { "id": { "format": "uuid", "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "pictureUrl": { "type": "string" }, "title": { "type": "string" }, "type": { "format": "int32", "enum": [ 0, 1, 2, 3, 4, 5, 6 ], "type": "integer" }, "jobDescription": { "type": "string" }, "jobType": { "format": "int32", "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8 ], "type": "integer" }, "fullName": { "type": "string" } } }, "MemberEventSubmissionCommand": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "shortDescription": { "type": "string" }, "startDateTimeUtc": { "format": "date-time", "type": "string" }, "endDateTimeUtc": { "format": "date-time", "type": "string" }, "timeZone": { "type": "string" }, "address": { "type": "string" }, "county": { "type": "string" }, "city": { "type": "string" }, "country": { "type": "string" }, "isOnlineEvent": { "type": "boolean" }, "url": { "type": "string" }, "currency": { "format": "int32", "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62, 63, 64, 65, 66, 67, 68, 69, 70, 71, 72, 73, 74, 75, 76, 77, 78, 79, 80, 81, 82, 83, 84, 85, 86, 87, 88, 89, 90, 91, 92, 93, 94, 95, 96, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 112, 113, 114, 115, 116, 117, 118, 119, 120, 121, 122, 123, 124, 125, 126, 127, 128, 129, 130, 131, 132, 133, 134, 135, 136, 137 ], "type": "integer" }, "availableTicketCount": { "format": "int32", "type": "integer" }, "isPublic": { "type": "boolean" }, "coverImageUrl": { "type": "string" }, "coverThumbnailUrl": { "type": "string" }, "categoryIds": { "type": "array", "items": { "format": "uuid", "type": "string" } }, "ticketOptions": { "type": "array", "items": { "$ref": "#/components/schemas/EventTicketOptions" } } } }, "EventTicketOptions": { "required": [ "id", "name" ], "type": "object", "properties": { "id": { "format": "uuid", "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "salesEndDate": { "format": "int32", "type": "integer" }, "price": { "format": "double", "type": "number" }, "maxQuantity": { "format": "int32", "type": "integer" }, "orderCount": { "format": "int32", "type": "integer" }, "minPrice": { "format": "double", "type": "number" }, "plans": { "type": "object", "additionalProperties": { "type": "boolean" } }, "accessType": { "format": "int32", "enum": [ 0, 1, 2 ], "type": "integer" }, "ticketType": { "format": "int32", "enum": [ 0, 1, 2 ], "type": "integer" }, "availableTicketCount": { "format": "int32", "type": "integer" }, "soldTicketCount": { "format": "int32", "type": "integer" }, "isHidden": { "type": "boolean" }, "isArchive": { "type": "boolean" }, "createdOn": { "format": "int32", "type": "integer" } } }, "MemberEventEditCommand": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "shortDescription": { "type": "string" }, "startDateTimeUtc": { "format": "date-time", "type": "string" }, "endDateTimeUtc": { "format": "date-time", "type": "string" }, "timeZone": { "type": "string" }, "address": { "type": "string" }, "county": { "type": "string" }, "city": { "type": "string" }, "country": { "type": "string" }, "isOnlineEvent": { "type": "boolean" }, "url": { "type": "string" }, "availableTicketCount": { "format": "int32", "type": "integer" }, "coverImageUrl": { "type": "string" }, "action": { "format": "int32", "enum": [ 0, 1 ], "type": "integer" } } }, "MembershipFeeDto": { "type": "object", "properties": { "year": { "format": "int32", "type": "integer" }, "remainingDebt": { "format": "double", "type": "number" }, "debtAmount": { "format": "double", "type": "number" }, "debtType": { "format": "int32", "enum": [ 0, 1, 2 ], "type": "integer" }, "currency": { "format": "int32", "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62, 63, 64, 65, 66, 67, 68, 69, 70, 71, 72, 73, 74, 75, 76, 77, 78, 79, 80, 81, 82, 83, 84, 85, 86, 87, 88, 89, 90, 91, 92, 93, 94, 95, 96, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 112, 113, 114, 115, 116, 117, 118, 119, 120, 121, 122, 123, 124, 125, 126, 127, 128, 129, 130, 131, 132, 133, 134, 135, 136, 137 ], "type": "integer" }, "debtStatus": { "format": "int32", "enum": [ 0, 1, -1 ], "type": "integer" }, "debtDescription": { "type": "string" } } }, "OrganisationSettingsDto": { "type": "object", "properties": { "id": { "format": "uuid", "type": "string" }, "name": { "type": "string" }, "shortName": { "type": "string" }, "permalink": { "type": "string" }, "language": { "type": "string" }, "timeZoneId": { "type": "string" }, "stripeCustomerId": { "type": "string" }, "stripePlanId": { "type": "string" }, "activeUntil": { "format": "date-time", "type": "string" }, "organisationColor1": { "type": "string" }, "organisationColor2": { "type": "string" }, "currency": { "format": "int32", "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62, 63, 64, 65, 66, 67, 68, 69, 70, 71, 72, 73, 74, 75, 76, 77, 78, 79, 80, 81, 82, 83, 84, 85, 86, 87, 88, 89, 90, 91, 92, 93, 94, 95, 96, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 112, 113, 114, 115, 116, 117, 118, 119, 120, 121, 122, 123, 124, 125, 126, 127, 128, 129, 130, 131, 132, 133, 134, 135, 136, 137 ], "type": "integer" }, "state": { "format": "int32", "enum": [ 0, -9 ], "type": "integer" }, "logoUrl": { "type": "string" }, "logoWidth": { "format": "int32", "type": "integer" }, "logoHeight": { "format": "int32", "type": "integer" }, "loginPageTitle": { "type": "string" }, "isDeleted": { "type": "boolean" }, "createdOn": { "format": "date-time", "type": "string" }, "smsProfit": { "format": "double", "type": "number" }, "invoiceAddress": { "type": "string" }, "isLoginSocialNetworkEnabled": { "type": "boolean" }, "isLoginSmsEnabled": { "type": "boolean" }, "isLoginPasswordEnabled": { "type": "boolean" }, "isLoginWithOneTimeLoginEnabled": { "type": "boolean" }, "isLoginTwoFactorEnabled": { "type": "boolean" }, "isMemberListVisible": { "type": "boolean" }, "isCompanyListVisible": { "type": "boolean" }, "isSectorListVisible": { "type": "boolean" }, "isSchoolListVisible": { "type": "boolean" }, "isCityListVisible": { "type": "boolean" }, "isCountryListVisible": { "type": "boolean" }, "isJobPostingsEnabled": { "type": "boolean" }, "isOfferedServicesEnabled": { "type": "boolean" }, "isApplicationFormEnabled": { "type": "boolean" }, "applicationFormTitle": { "type": "string" }, "applicationFormHeader": { "type": "string" }, "applicationFormFooter": { "type": "string" }, "applicationFormBenefits": { "type": "string" }, "membershipTerms": { "type": "string" }, "termsOfUseApp": { "type": "string" }, "termsOfUse2App": { "type": "string" }, "applicationFormIsAddressEnabled": { "type": "boolean" }, "applicationFormIsCommentsEnabled": { "type": "boolean" }, "applicationFormIsGenderEnabled": { "type": "boolean" }, "applicationFormIsBirthDateEnabled": { "type": "boolean" }, "applicationFormIsBirthPlaceEnabled": { "type": "boolean" }, "applicationFormIsNationalityEnabled": { "type": "boolean" }, "applicationFormIsTaxNumberEnabled": { "type": "boolean" }, "applicationFormIsUnder18ControlEnabled": { "type": "boolean" }, "applicationFormRegistrationFee": { "format": "double", "type": "number" }, "applicationFormAgreement": { "type": "string" }, "smsIsEnabled": { "type": "boolean" }, "isPaymentEnabled": { "type": "boolean" }, "isDonationEnabled": { "type": "boolean" }, "isCustomPaymentEnabled": { "type": "boolean" }, "paymentHeader": { "type": "string" }, "paymentFooter": { "type": "string" }, "isOnlineCreditCardEnabled": { "type": "boolean" }, "onlineCreditCardSubMerchantId": { "type": "string" }, "creditCardProcessor": { "format": "int32", "enum": [ 0, 1, 2, 4, 5, 6 ], "type": "integer" }, "commissionRate": { "format": "double", "type": "number" }, "commissionFee": { "format": "double", "type": "number" }, "commissionFeeCurrency": { "format": "int32", "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62, 63, 64, 65, 66, 67, 68, 69, 70, 71, 72, 73, 74, 75, 76, 77, 78, 79, 80, 81, 82, 83, 84, 85, 86, 87, 88, 89, 90, 91, 92, 93, 94, 95, 96, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 112, 113, 114, 115, 116, 117, 118, 119, 120, 121, 122, 123, 124, 125, 126, 127, 128, 129, 130, 131, 132, 133, 134, 135, 136, 137 ], "type": "integer" }, "organisationSupportEmail": { "type": "string" }, "organisationSupportPhone": { "type": "string" }, "welcomeImageUrl": { "type": "string" }, "welcomeSubject": { "type": "string" }, "welcomeText": { "type": "string" }, "defaultPhoneCountryCode": { "type": "string" }, "defaultAddressCountry": { "type": "string" }, "defaultSmsIdentityId": { "format": "uuid", "type": "string" }, "defaultEmailIdentityId": { "format": "uuid", "type": "string" }, "memberNoType": { "format": "int32", "enum": [ 0, 1, 2 ], "type": "integer" }, "legalEntityVerificationDocumentUrl": { "type": "string" }, "legalEntityOwnersVerificationDocumentUrl": { "type": "string" }, "isWeeklyNewsletterEnabled": { "type": "boolean" }, "isWeeklyNewsletterAnnouncements": { "type": "boolean" }, "isWeeklyNewsletterDonationCampaigns": { "type": "boolean" }, "isWeeklyNewsletterNewMembersEnabled": { "type": "boolean" }, "isWeeklyNewsletterJobOffers": { "type": "boolean" }, "isWeeklyNewsletterJobSeekers": { "type": "boolean" }, "isWeeklyNewsletterServices": { "type": "boolean" }, "isWeeklyNewsletterMemberUnreadMessages": { "type": "boolean" }, "isWeeklyNewsletterMemberDebt": { "type": "boolean" }, "googleAnalyticsTrackerId": { "type": "string" }, "balance": { "format": "double", "type": "number" }, "totalCost": { "format": "double", "type": "number" }, "totalProfit": { "format": "double", "type": "number" }, "isTermsOfUseRequiredForAccess": { "type": "boolean" } } }, "ApiResult_PageDto": { "type": "object", "properties": { "code": { "format": "int32", "type": "integer" }, "message": { "type": "string" }, "internalMessage": { "type": "string" }, "data": { "$ref": "#/components/schemas/PageDto" }, "paging": { "$ref": "#/components/schemas/PagingDto" }, "isSuccess": { "type": "boolean" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ErrorItem" } } } }, "PageDto": { "required": [ "title", "content" ], "type": "object", "properties": { "slug": { "type": "string" }, "title": { "type": "string" }, "content": { "type": "string" }, "metaDesc": { "type": "string" }, "imageUrl": { "type": "string" }, "createdOn": { "format": "int32", "type": "integer" }, "publishedOn": { "format": "int32", "type": "integer" }, "isApproved": { "type": "boolean" }, "layout": { "format": "int32", "enum": [ 0, 1 ], "type": "integer" }, "status": { "format": "int32", "enum": [ 0, 1 ], "type": "integer" }, "permissionType": { "format": "int32", "enum": [ 0, 1, 2, 3, 4, 5 ], "type": "integer" }, "plans": { "type": "object", "additionalProperties": { "type": "boolean" } }, "id": { "type": "string" } } }, "PaymentDto": { "type": "object", "properties": { "id": { "format": "uuid", "type": "string" }, "amount": { "format": "double", "type": "number" }, "currency": { "format": "int32", "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62, 63, 64, 65, 66, 67, 68, 69, 70, 71, 72, 73, 74, 75, 76, 77, 78, 79, 80, 81, 82, 83, 84, 85, 86, 87, 88, 89, 90, 91, 92, 93, 94, 95, 96, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 112, 113, 114, 115, 116, 117, 118, 119, 120, 121, 122, 123, 124, 125, 126, 127, 128, 129, 130, 131, 132, 133, 134, 135, 136, 137 ], "type": "integer" }, "paymentMethod": { "format": "int32", "enum": [ 0, 1, 2, 3, 4, 5, 10 ], "type": "integer" }, "paymentDate": { "format": "date-time", "type": "string" }, "referenceNumber": { "type": "string" }, "identifier": { "type": "string" }, "createdOn": { "format": "date-time", "type": "string" } } }, "PaymentTicketDto": { "required": [ "amount", "currency" ], "type": "object", "properties": { "id": { "format": "uuid", "type": "string" }, "amount": { "format": "double", "type": "number" }, "currency": { "format": "int32", "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62, 63, 64, 65, 66, 67, 68, 69, 70, 71, 72, 73, 74, 75, 76, 77, 78, 79, 80, 81, 82, 83, 84, 85, 86, 87, 88, 89, 90, 91, 92, 93, 94, 95, 96, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 112, 113, 114, 115, 116, 117, 118, 119, 120, 121, 122, 123, 124, 125, 126, 127, 128, 129, 130, 131, 132, 133, 134, 135, 136, 137 ], "type": "integer" }, "donationCampaignId": { "format": "uuid", "type": "string" }, "_DonationCampaignName": { "type": "string" }, "isDonorNameHidden": { "type": "boolean" }, "paymentType": { "format": "int32", "enum": [ 0, 1, 2, 3 ], "type": "integer" } } }, "FilterResultDto_AnnouncementDto": { "type": "object", "properties": { "paging": { "$ref": "#/components/schemas/PagingDto" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/AnnouncementDto" } } } }, "AnnouncementDto": { "type": "object", "properties": { "id": { "format": "uuid", "type": "string" }, "subject": { "type": "string" }, "description": { "type": "string" }, "shortDescription": { "type": "string" }, "summary": { "type": "string" }, "imageFile": { "type": "string" }, "imageUrl": { "type": "string" }, "url": { "type": "string" }, "slug": { "type": "string" }, "createdOn": { "type": "string" }, "publishedOn": { "type": "string" }, "attachmentsCount": { "format": "int32", "type": "integer" }, "status": { "format": "int32", "enum": [ 0, 1, 2, 3, 4, 5 ], "type": "integer" }, "statusText": { "type": "string" }, "permissionType": { "format": "int32", "enum": [ 0, 1, 2, 3, 4, 5 ], "type": "integer" }, "permissionTypeText": { "type": "string" }, "organisation": { "$ref": "#/components/schemas/OrganisationBasicDto" }, "plans": { "type": "object", "additionalProperties": { "type": "boolean" } }, "categories": { "type": "object", "additionalProperties": { "type": "boolean" } }, "attachmentDtos": { "type": "array", "items": { "$ref": "#/components/schemas/AnnouncementAttachmentDto" } }, "like": { "format": "int32", "enum": [ 0, 1, 2 ], "type": "integer" }, "comment": { "format": "int32", "enum": [ 0, 1, 2 ], "type": "integer" }, "share": { "format": "int32", "enum": [ 0, 1, 2 ], "type": "integer" }, "isPinned": { "type": "boolean" }, "announcementType": { "format": "int32", "enum": [ 0, 1 ], "type": "integer" }, "pollStatus": { "format": "int32", "enum": [ 0, 1 ], "type": "integer" }, "pollClosesOn": { "format": "date-time", "type": "string" }, "pollSelectionMode": { "format": "int32", "enum": [ 0, 1 ], "type": "integer" }, "pollMaxSelections": { "format": "int32", "type": "integer" }, "pollResultsVisibility": { "format": "int32", "enum": [ 0, 1, 2 ], "type": "integer" }, "pollVoteVisibility": { "format": "int32", "enum": [ 0, 1 ], "type": "integer" }, "pollOptions": { "type": "array", "items": { "$ref": "#/components/schemas/PollOptionDto" } } } }, "AnnouncementAttachmentDto": { "type": "object", "properties": { "id": { "format": "uuid", "type": "string" }, "file": { "type": "string" }, "fileName": { "type": "string" }, "title": { "type": "string" }, "size": { "format": "int32", "type": "integer" }, "mgUrl": { "type": "string" } } }, "PollOptionDto": { "description": "Polls v1.x — flat option row, surfaced on the admin SPA edit page so\r\nmanagers can SEE the existing options without us having to expose the\r\nfull Polls API surface here. Read-only on this DTO: editing options on\r\na poll that already has votes would invalidate the vote-after-lock\r\nguarantee, so option edits stay out of the v1 admin update path.", "type": "object", "properties": { "id": { "format": "uuid", "type": "string" }, "text": { "type": "string" }, "displayOrder": { "format": "int32", "type": "integer" } } }, "SchoolDto": { "type": "object", "properties": { "name": { "type": "string" }, "count": { "format": "int32", "type": "integer" }, "slug": { "type": "string", "readOnly": true }, "members": { "type": "array", "items": { "$ref": "#/components/schemas/SchoolMemberDto" } } } }, "SchoolMemberDto": { "type": "object", "properties": { "id": { "format": "uuid", "type": "string" }, "pictureUrl": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "fullName": { "type": "string" }, "school": { "type": "string" }, "department": { "type": "string" }, "isCurrent": { "type": "boolean" }, "startYear": { "format": "int32", "type": "integer" }, "endYear": { "format": "int32", "type": "integer" } } }, "ApiResult_List_OrganisationDto": { "type": "object", "properties": { "code": { "format": "int32", "type": "integer" }, "message": { "type": "string" }, "internalMessage": { "type": "string" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/OrganisationDto" } }, "paging": { "$ref": "#/components/schemas/PagingDto" }, "isSuccess": { "type": "boolean" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ErrorItem" } } } }, "OrganisationDto": { "type": "object", "properties": { "name": { "type": "string" }, "shortName": { "type": "string" }, "permalink": { "type": "string" }, "url": { "type": "string" }, "logoUrl": { "type": "string" }, "language": { "type": "string" }, "primaryColor": { "type": "string" }, "secondaryColor": { "type": "string" }, "currency": { "format": "int32", "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62, 63, 64, 65, 66, 67, 68, 69, 70, 71, 72, 73, 74, 75, 76, 77, 78, 79, 80, 81, 82, 83, 84, 85, 86, 87, 88, 89, 90, 91, 92, 93, 94, 95, 96, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 112, 113, 114, 115, 116, 117, 118, 119, 120, 121, 122, 123, 124, 125, 126, 127, 128, 129, 130, 131, 132, 133, 134, 135, 136, 137 ], "type": "integer" }, "supportEmail": { "type": "string" }, "supportPhone": { "type": "string" }, "timeZoneId": { "type": "string" }, "dateFormat": { "type": "string" }, "timeFormat": { "type": "string" }, "invoiceAddress": { "type": "string" }, "contactCount": { "format": "int32", "type": "integer" }, "notificationCount": { "format": "int32", "type": "integer" }, "applicationFormRegistrationFee": { "format": "double", "type": "number" }, "isApplicationFormEnabled": { "type": "boolean" }, "onlineCreditCardSubMerchantId": { "type": "string" }, "defaultPaymentAccountId": { "format": "uuid", "type": "string" }, "defaultEmailIdentityId": { "format": "uuid", "type": "string" }, "isMembershipBankTransferEnabled": { "type": "boolean" }, "organisationNewApplicationCount": { "format": "int32", "type": "integer" }, "organisationPendingCommentsCount": { "format": "int32", "type": "integer" }, "organisationPendingPostsCount": { "format": "int32", "type": "integer" }, "organisationPendingJobsCount": { "format": "int32", "type": "integer" }, "organisationPendingEventsCount": { "format": "int32", "type": "integer" }, "organisationPendingSocialItemsCount": { "format": "int32", "type": "integer", "readOnly": true }, "navigationData": { "type": "object" }, "isPaymentEnabled": { "type": "boolean" }, "organisationLoginActivityCount": { "type": "string" }, "organisationMissingInfoCount": { "type": "string" }, "isManager": { "type": "boolean" }, "isSubscriptionPastDue": { "type": "boolean" }, "hasNonSubscriptionPastDueInvoices": { "type": "boolean" }, "subscriptionTrialEnd": { "format": "date-time", "type": "string" }, "categoryPrimary": { "type": "string" }, "contactPlanLimit": { "type": "boolean" }, "subscriptionPlan": { "$ref": "#/components/schemas/RakletSubscriptionPlanDto" }, "createdOnUnix": { "format": "int32", "type": "integer" }, "organisationIsOfferedServiceEnabled": { "type": "boolean" }, "customDomain": { "type": "string" }, "isMessagingEnabled": { "type": "boolean" }, "isLoginSocialNetworkEnabled": { "type": "boolean" }, "isMemberListVisible": { "type": "boolean" }, "isCompanyListVisible": { "type": "boolean" }, "isSectorListVisible": { "type": "boolean" }, "isSchoolListVisible": { "type": "boolean" }, "isCityListVisible": { "type": "boolean" }, "isCountryListVisible": { "type": "boolean" }, "membersDirectoryVisibility": { "format": "int32", "enum": [ 0, 1, 2 ], "type": "integer" }, "invoiceText": { "type": "string" }, "creditCardProcessor": { "type": "string" }, "useNewEmailModule": { "type": "boolean" }, "defaultEmailV2TemplateId": { "type": "string" }, "legalEntityActivation": { "type": "boolean" }, "id": { "format": "uuid", "type": "string" } } }, "RakletSubscriptionPlanDto": { "type": "object", "properties": { "subscriptionId": { "type": "string" }, "subscriptionInterval": { "type": "string" }, "subscriptionAmount": { "format": "double", "type": "number" }, "stripeCustomerId": { "type": "string" }, "planId": { "type": "string" }, "planName": { "type": "string" }, "customCss": { "type": "boolean" }, "customJs": { "type": "boolean" }, "apiAccess": { "type": "boolean" }, "digitalCard": { "type": "boolean" }, "customDomain": { "type": "boolean" }, "roleBasedAccess": { "type": "boolean" }, "zapierIntegration": { "type": "boolean" }, "boardSettingsAccess": { "type": "boolean" }, "customEmailSenderName": { "type": "boolean" }, "loginTwoFactorAccess": { "type": "boolean" }, "contactUsage": { "format": "int64", "type": "integer" }, "adminSeatUsage": { "format": "int64", "type": "integer" }, "emailCreditsUsage": { "format": "int64", "type": "integer" }, "customFieldsCreditsUsage": { "format": "int64", "type": "integer" }, "roleCreditsUsage": { "format": "int64", "type": "integer" }, "contactCredits": { "format": "int64", "type": "integer" }, "adminSeatCredits": { "format": "int64", "type": "integer" }, "emailCredits": { "format": "int64", "type": "integer" }, "customFieldsCredits": { "format": "int64", "type": "integer" }, "emailSenderNameCredits": { "format": "int64", "type": "integer" }, "roleCredits": { "format": "int64", "type": "integer" }, "directoryCredits": { "format": "int64", "type": "integer" }, "directoryCreditsUsage": { "format": "int64", "type": "integer" }, "prioritySupportCredits": { "format": "int64", "type": "integer" }, "prioritySupportCreditsUsage": { "format": "int64", "type": "integer" }, "customDomainIncluded": { "type": "boolean" }, "customDomainActivated": { "type": "boolean" }, "isYearly": { "type": "boolean" } } }, "SectorDto": { "type": "object", "properties": { "name": { "type": "string" }, "count": { "format": "int32", "type": "integer" }, "slug": { "type": "string", "readOnly": true }, "members": { "type": "array", "items": { "$ref": "#/components/schemas/SectorMemberDto" } } } }, "SectorMemberDto": { "type": "object", "properties": { "id": { "format": "uuid", "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "pictureUrl": { "type": "string" }, "title": { "type": "string" }, "fullName": { "type": "string" }, "type": { "format": "int32", "enum": [ 0, 1, 2, 3, 4, 5, 6 ], "type": "integer" }, "company": { "type": "string" }, "position": { "type": "string" }, "isCurrent": { "type": "boolean" }, "endYear": { "format": "int32", "type": "integer" }, "startYear": { "format": "int32", "type": "integer" } } }, "ApiResult_Dictionary_String": { "type": "object", "properties": { "code": { "format": "int32", "type": "integer" }, "message": { "type": "string" }, "internalMessage": { "type": "string" }, "data": { "type": "object", "additionalProperties": { "type": "string" } }, "paging": { "$ref": "#/components/schemas/PagingDto" }, "isSuccess": { "type": "boolean" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ErrorItem" } } } }, "ApiResult_Dictionary_String_2": { "type": "object", "properties": { "code": { "format": "int32", "type": "integer" }, "message": { "type": "string" }, "internalMessage": { "type": "string" }, "data": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": { "type": "string" } } }, "paging": { "$ref": "#/components/schemas/PagingDto" }, "isSuccess": { "type": "boolean" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ErrorItem" } } } }, "OrganisationSettingsSocialNetworkDto": { "type": "object", "properties": { "isLoginSocialNetworkEnabled": { "type": "boolean" }, "isMemberListVisible": { "type": "boolean" }, "isCompanyListVisible": { "type": "boolean" }, "isSectorListVisible": { "type": "boolean" }, "isSchoolListVisible": { "type": "boolean" }, "isCityListVisible": { "type": "boolean" }, "isCountryListVisible": { "type": "boolean" }, "membersDirectoryVisibility": { "format": "int32", "enum": [ 0, 1, 2 ], "type": "integer" }, "id": { "format": "uuid", "type": "string" } } }, "OrganisationSettingsMessagingDto": { "type": "object", "properties": { "isMessagingEnabled": { "type": "boolean" }, "id": { "format": "uuid", "type": "string" } } }, "FieldObject": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "shortName": { "type": "string" }, "description": { "type": "string" }, "dataType": { "type": "string" }, "defaultValue": { "type": "object" }, "options": { "type": "array", "items": { "$ref": "#/components/schemas/OptionItem" } }, "isRequired": { "type": "boolean" }, "validator": { "type": "object" }, "isContactVisible": { "type": "boolean" }, "isContactEditable": { "type": "boolean" }, "isSystemAttribute": { "type": "boolean" }, "isImportable": { "type": "boolean" }, "isDeleted": { "type": "boolean" }, "isVisibleOnGrid": { "type": "boolean" }, "isActivated": { "type": "boolean" }, "contactVisibility": { "format": "int32", "type": "integer" }, "category": { "type": "string" }, "order": { "format": "int32", "type": "integer" }, "inputType": { "type": "string" }, "returnValue": { "type": "string" }, "plans": { "type": "object", "additionalProperties": { "type": "boolean" } }, "isDropdown": { "type": "boolean" }, "showContactGrid": { "type": "boolean" } } }, "OptionItem": { "type": "object", "properties": { "label": { "type": "string" }, "value": { "type": "string" } } }, "ApiResult_List_CustomMembershipDto": { "type": "object", "properties": { "code": { "format": "int32", "type": "integer" }, "message": { "type": "string" }, "internalMessage": { "type": "string" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/CustomMembershipDto" } }, "paging": { "$ref": "#/components/schemas/PagingDto" }, "isSuccess": { "type": "boolean" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ErrorItem" } } } }, "CustomMembershipDto": { "type": "object", "properties": { "id": { "format": "uuid", "type": "string" }, "customMemberTypeId": { "format": "uuid", "type": "string" }, "planName": { "type": "string" }, "planBenefit": { "type": "string" }, "planInterval": { "type": "string" }, "memberFullName": { "type": "string" }, "memberNo": { "type": "string" }, "memberPictureUrl": { "type": "string" }, "customAttributesValues": { "type": "string" }, "memberPlanBalance": { "format": "double", "type": "number" }, "subscriptionDebtsTotal": { "format": "double", "type": "number" }, "subscriptionPaymentsTotal": { "format": "double", "type": "number" }, "renewalDate": { "format": "date-time", "type": "string" }, "gracePeriodEndDate": { "format": "date-time", "type": "string" }, "nextReminderDate": { "format": "date-time", "type": "string" }, "renewalDateString": { "type": "string" }, "creditCardNo": { "type": "string" }, "organisationMembershipId": { "format": "uuid", "type": "string" }, "startDate": { "format": "date-time", "type": "string" }, "endDate": { "format": "date-time", "type": "string" }, "status": { "format": "int32", "enum": [ 0, 4, -3, -2, -1 ], "type": "integer" }, "statusStr": { "type": "string", "readOnly": true }, "disableReminder": { "type": "boolean" }, "updateMemberStatus": { "type": "boolean" }, "summaryText": { "type": "string" }, "updateScheduledPaymentDate": { "type": "boolean" }, "parentCustomMembershipId": { "format": "uuid", "type": "string" }, "resolvedPaymentAccountId": { "format": "uuid", "type": "string" }, "currency": { "format": "int32", "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62, 63, 64, 65, 66, 67, 68, 69, 70, 71, 72, 73, 74, 75, 76, 77, 78, 79, 80, 81, 82, 83, 84, 85, 86, 87, 88, 89, 90, 91, 92, 93, 94, 95, 96, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 112, 113, 114, 115, 116, 117, 118, 119, 120, 121, 122, 123, 124, 125, 126, 127, 128, 129, 130, 131, 132, 133, 134, 135, 136, 137 ], "type": "integer" }, "isScheduledPaymentEligible": { "type": "boolean" }, "membershipFee": { "format": "double", "type": "number" }, "planHasSpecificStartDate": { "type": "boolean" }, "couponId": { "type": "string" }, "couponName": { "type": "string" }, "couponDiscountType": { "type": "string" }, "couponDiscountAmount": { "format": "double", "type": "number" }, "couponDuration": { "type": "string" }, "remainingDiscountedRenewals": { "format": "int32", "type": "integer" } } }, "ApiResult_CustomMembershipDto": { "type": "object", "properties": { "code": { "format": "int32", "type": "integer" }, "message": { "type": "string" }, "internalMessage": { "type": "string" }, "data": { "$ref": "#/components/schemas/CustomMembershipDto" }, "paging": { "$ref": "#/components/schemas/PagingDto" }, "isSuccess": { "type": "boolean" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ErrorItem" } } } }, "TagDto": { "type": "object", "properties": { "id": { "format": "uuid", "type": "string" }, "name": { "type": "string" }, "isMemberSelectable": { "type": "boolean" }, "memberCount": { "format": "int32", "type": "integer" }, "members": { "type": "array", "items": { "$ref": "#/components/schemas/TagMemberDto" } } } }, "TagMemberDto": { "type": "object", "properties": { "id": { "format": "uuid", "type": "string" }, "name": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "pictureUrl": { "type": "string" }, "title": { "type": "string" }, "fullName": { "type": "string" }, "membershipType": { "format": "int32", "type": "integer" } } } } }, "x-raklet": { "sourceDocument": "https://api.raklet.com/swagger/docs/v1", "swaggerUi": "https://api.raklet.com/swagger/ui/index/", "developerPortal": "https://www.raklet.com/developers/", "llmsTxt": "https://www.raklet.com/llms.txt", "permissionModel": "role-based; token = admin user; no OAuth scopes", "generator": "scripts/build_openapi_spec.py" } }