group.json

{"info": {"description": "\nRegistrant Group API Services\n", "title": "group REST services", "version": ""}, "servers": [{"url": "https://mec.openg2p.net/api/v1/registry/group"}], "paths": {"/": {"post": {"summary": "\nCreate a new Group\n:param group_info: An instance of the group info\n:return: An instance of partner.info\n", "requestBody": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/GroupInfoIn"}}}}, "responses": {"400": {"description": "One of the given parameter is not valid"}, "401": {"description": "The user is not authorized. Authentication is required"}, "404": {"description": "Requested resource not found"}, "403": {"description": "You don't have the permission to access the requested resource."}, "200": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/GroupInfoOut"}}}}}, "security": [{"user": []}]}, "get": {"summary": "\nSearch for partners\n:param partner_search_param: An instance of partner.search.param\n:return: List of partner.short.info\n", "parameters": [{"name": "id", "in": "query", "required": false, "allowEmptyValue": false, "default": null, "schema": {"type": "integer"}}, {"name": "include_members_full", "in": "query", "required": false, "allowEmptyValue": false, "default": false, "schema": {"type": "boolean"}}, {"name": "name", "in": "query", "required": false, "allowEmptyValue": false, "default": null, "schema": {"type": "string"}}], "responses": {"400": {"description": "One of the given parameter is not valid"}, "401": {"description": "The user is not authorized. Authentication is required"}, "404": {"description": "Requested resource not found"}, "403": {"description": "You don't have the permission to access the requested resource."}, "200": {"content": {"application/json": {"schema": {"type": "array", "items": {"$ref": "#/components/schemas/GroupShortInfoOut"}}}}}}, "security": [{"user": []}]}}, "/{id}": {"get": {"summary": "\nGet partner's information\n", "responses": {"400": {"description": "One of the given parameter is not valid"}, "401": {"description": "The user is not authorized. Authentication is required"}, "404": {"description": "Requested resource not found"}, "403": {"description": "You don't have the permission to access the requested resource."}, "200": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/GroupInfoOut"}}}}}, "security": [{"user": []}]}, "parameters": [{"in": "path", "name": "id", "required": true, "schema": {"type": "integer", "format": "int32"}}]}, "/search": {"get": {"summary": "\nSearch for partners\n:param partner_search_param: An instance of partner.search.param\n:return: List of partner.short.info\n", "parameters": [{"name": "id", "in": "query", "required": false, "allowEmptyValue": false, "default": null, "schema": {"type": "integer"}}, {"name": "include_members_full", "in": "query", "required": false, "allowEmptyValue": false, "default": false, "schema": {"type": "boolean"}}, {"name": "name", "in": "query", "required": false, "allowEmptyValue": false, "default": null, "schema": {"type": "string"}}], "responses": {"400": {"description": "One of the given parameter is not valid"}, "401": {"description": "The user is not authorized. Authentication is required"}, "404": {"description": "Requested resource not found"}, "403": {"description": "You don't have the permission to access the requested resource."}, "200": {"content": {"application/json": {"schema": {"type": "array", "items": {"$ref": "#/components/schemas/GroupShortInfoOut"}}}}}}, "security": [{"user": []}]}}}, "openapi": "3.0.0", "components": {"schemas": {"RegistrantIDIn": {"title": "RegistrantIDIn", "type": "object", "properties": {"id_type": {"title": "Id Type", "type": "string"}, "value": {"title": "Value", "type": "string"}, "expiry_date": {"title": "Expiry Date", "type": "string", "format": "date"}}}, "PhoneNumberIn": {"title": "PhoneNumberIn", "type": "object", "properties": {"phone_no": {"title": "Phone No", "type": "string"}, "date_collected": {"title": "Date Collected", "type": "string", "format": "date"}}, "required": ["phone_no"]}, "RegistrantProgramMembershipIn": {"title": "RegistrantProgramMembershipIn", "type": "object", "properties": {"name": {"title": "Name", "type": "string"}, "enrollment_date": {"title": "Enrollment Date", "type": "string", "format": "date"}}}, "GroupMembershipKindInfo": {"title": "GroupMembershipKindInfo", "type": "object", "properties": {"name": {"title": "Name", "type": "string"}}, "required": ["name"]}, "GroupMembersInfoIn": {"title": "GroupMembersInfoIn", "type": "object", "properties": {"name": {"title": "Name", "type": "string"}, "given_name": {"title": "Given Name", "type": "string"}, "addl_name": {"title": "Addl Name", "type": "string"}, "family_name": {"title": "Family Name", "type": "string"}, "ids": {"title": "Ids", "type": "array", "items": {"$ref": "#/components/schemas/RegistrantIDIn"}}, "registration_date": {"title": "Registration Date", "type": "string", "format": "date"}, "phone_numbers": {"title": "Phone Numbers", "type": "array", "items": {"$ref": "#/components/schemas/PhoneNumberIn"}}, "email": {"title": "Email", "type": "string"}, "address": {"title": "Address", "type": "string"}, "gender": {"title": "Gender", "type": "string"}, "birthdate": {"title": "Birthdate", "type": "string", "format": "date"}, "birth_place": {"title": "Birth Place", "type": "string"}, "kind": {"title": "Kind", "type": "array", "items": {"$ref": "#/components/schemas/GroupMembershipKindInfo"}}, "is_group": {"title": "Is Group", "default": false, "type": "boolean"}, "additional_g2p_info": {"title": "Additional G2P Info", "anyOf": [{"type": "array", "items": {"type": "object"}}, {"type": "object"}]}, "program_memberships": {"title": "Program Memberships", "type": "array", "items": {"$ref": "#/components/schemas/RegistrantProgramMembershipIn"}}, "notification_preference": {"title": "Notification Preference", "default": "none", "type": "string"}}, "required": ["name"]}, "GroupInfoIn": {"title": "GroupInfoIn", "type": "object", "properties": {"name": {"title": "Name", "type": "string"}, "ids": {"title": "Ids", "type": "array", "items": {"$ref": "#/components/schemas/RegistrantIDIn"}}, "registration_date": {"title": "Registration Date", "type": "string", "format": "date"}, "is_group": {"title": "Is Group", "default": true, "type": "boolean"}, "phone_numbers": {"title": "Phone Numbers", "type": "array", "items": {"$ref": "#/components/schemas/PhoneNumberIn"}}, "email": {"title": "Email", "type": "string"}, "address": {"title": "Address", "type": "string"}, "additional_g2p_info": {"title": "Additional G2P Info", "anyOf": [{"type": "array", "items": {"type": "object"}}, {"type": "object"}]}, "program_memberships": {"title": "Program Memberships", "type": "array", "items": {"$ref": "#/components/schemas/RegistrantProgramMembershipIn"}}, "notification_preference": {"title": "Notification Preference", "default": "none", "type": "string"}, "members": {"title": "Members", "type": "array", "items": {"$ref": "#/components/schemas/GroupMembersInfoIn"}}, "kind": {"title": "Kind", "type": "string"}, "is_partial_group": {"title": "Is Partial Group", "type": "boolean"}}, "required": ["name", "members"], "definitions": {"RegistrantIDIn": {"title": "RegistrantIDIn", "type": "object", "properties": {"id_type": {"title": "Id Type", "type": "string"}, "value": {"title": "Value", "type": "string"}, "expiry_date": {"title": "Expiry Date", "type": "string", "format": "date"}}}, "PhoneNumberIn": {"title": "PhoneNumberIn", "type": "object", "properties": {"phone_no": {"title": "Phone No", "type": "string"}, "date_collected": {"title": "Date Collected", "type": "string", "format": "date"}}, "required": ["phone_no"]}, "RegistrantProgramMembershipIn": {"title": "RegistrantProgramMembershipIn", "type": "object", "properties": {"name": {"title": "Name", "type": "string"}, "enrollment_date": {"title": "Enrollment Date", "type": "string", "format": "date"}}}, "GroupMembershipKindInfo": {"title": "GroupMembershipKindInfo", "type": "object", "properties": {"name": {"title": "Name", "type": "string"}}, "required": ["name"]}, "GroupMembersInfoIn": {"title": "GroupMembersInfoIn", "type": "object", "properties": {"name": {"title": "Name", "type": "string"}, "given_name": {"title": "Given Name", "type": "string"}, "addl_name": {"title": "Addl Name", "type": "string"}, "family_name": {"title": "Family Name", "type": "string"}, "ids": {"title": "Ids", "type": "array", "items": {"$ref": "#/components/schemas/RegistrantIDIn"}}, "registration_date": {"title": "Registration Date", "type": "string", "format": "date"}, "phone_numbers": {"title": "Phone Numbers", "type": "array", "items": {"$ref": "#/components/schemas/PhoneNumberIn"}}, "email": {"title": "Email", "type": "string"}, "address": {"title": "Address", "type": "string"}, "gender": {"title": "Gender", "type": "string"}, "birthdate": {"title": "Birthdate", "type": "string", "format": "date"}, "birth_place": {"title": "Birth Place", "type": "string"}, "kind": {"title": "Kind", "type": "array", "items": {"$ref": "#/components/schemas/GroupMembershipKindInfo"}}, "is_group": {"title": "Is Group", "default": false, "type": "boolean"}, "additional_g2p_info": {"title": "Additional G2P Info", "anyOf": [{"type": "array", "items": {"type": "object"}}, {"type": "object"}]}, "program_memberships": {"title": "Program Memberships", "type": "array", "items": {"$ref": "#/components/schemas/RegistrantProgramMembershipIn"}}, "notification_preference": {"title": "Notification Preference", "default": "none", "type": "string"}}, "required": ["name"]}}}, "RegistrantIDOut": {"title": "RegistrantIDOut", "type": "object", "properties": {"id": {"title": "Id", "type": "integer"}, "id_type_as_str": {"title": "Id Type As Str", "type": "string"}, "value": {"title": "Value", "type": "string"}, "expiry_date": {"title": "Expiry Date", "type": "string", "format": "date"}}, "required": ["id", "id_type_as_str", "value"]}, "PhoneNumberOut": {"title": "PhoneNumberOut", "type": "object", "properties": {"id": {"title": "Id", "type": "integer"}, "phone_no": {"title": "Phone No", "type": "string"}, "phone_sanitized": {"title": "Phone Sanitized", "type": "string"}, "date_collected": {"title": "Date Collected", "type": "string", "format": "date"}, "disabled": {"title": "Disabled", "type": "string", "format": "date"}}, "required": ["id", "phone_no", "phone_sanitized"]}, "RegistrantProgramMembershipOut": {"title": "RegistrantProgramMembershipOut", "type": "object", "properties": {"program_id": {"title": "Program Id", "type": "integer"}, "state": {"title": "State", "type": "string"}, "enrollment_date": {"title": "Enrollment Date", "type": "string", "format": "date"}, "exit_date": {"title": "Exit Date", "type": "string", "format": "date"}}}, "IndividualInfoOut": {"title": "IndividualInfoOut", "type": "object", "properties": {"id": {"title": "Id", "type": "integer"}, "name": {"title": "Name", "type": "string"}, "reg_ids": {"title": "Reg Ids", "type": "array", "items": {"$ref": "#/components/schemas/RegistrantIDOut"}}, "is_group": {"title": "Is Group", "default": false, "type": "boolean"}, "registration_date": {"title": "Registration Date", "type": "string", "format": "date"}, "phone_number_ids": {"title": "Phone Number Ids", "type": "array", "items": {"$ref": "#/components/schemas/PhoneNumberOut"}}, "email": {"title": "Email", "type": "string"}, "address": {"title": "Address", "type": "string"}, "additional_g2p_info": {"title": "Additional G2P Info", "default": "", "type": "string"}, "program_membership_ids": {"title": "Program Membership Ids", "type": "array", "items": {"$ref": "#/components/schemas/RegistrantProgramMembershipOut"}}, "notification_preference": {"title": "Notification Preference", "default": "none", "type": "string"}, "given_name": {"title": "Given Name", "type": "string"}, "addl_name": {"title": "Addl Name", "type": "string"}, "family_name": {"title": "Family Name", "type": "string"}, "gender": {"title": "Gender", "type": "string"}, "birthdate": {"title": "Birthdate", "type": "string", "format": "date"}, "age": {"title": "Age", "type": "string"}, "birth_place": {"title": "Birth Place", "type": "string"}}, "required": ["id", "name", "reg_ids", "phone_number_ids", "age"]}, "GroupMembersInfoOut": {"title": "GroupMembersInfoOut", "type": "object", "properties": {"id": {"title": "Id", "type": "integer"}, "individual": {"$ref": "#/components/schemas/IndividualInfoOut"}, "kind": {"title": "Kind", "type": "array", "items": {"$ref": "#/components/schemas/GroupMembershipKindInfo"}}}, "required": ["id", "individual"]}, "GroupInfoOut": {"title": "GroupInfoOut", "type": "object", "properties": {"id": {"title": "Id", "type": "integer"}, "name": {"title": "Name", "type": "string"}, "reg_ids": {"title": "Reg Ids", "type": "array", "items": {"$ref": "#/components/schemas/RegistrantIDOut"}}, "is_group": {"title": "Is Group", "default": true, "type": "boolean"}, "registration_date": {"title": "Registration Date", "type": "string", "format": "date"}, "phone_number_ids": {"title": "Phone Number Ids", "type": "array", "items": {"$ref": "#/components/schemas/PhoneNumberOut"}}, "email": {"title": "Email", "type": "string"}, "address": {"title": "Address", "type": "string"}, "additional_g2p_info": {"title": "Additional G2P Info", "default": "", "type": "string"}, "program_membership_ids": {"title": "Program Membership Ids", "type": "array", "items": {"$ref": "#/components/schemas/RegistrantProgramMembershipOut"}}, "notification_preference": {"title": "Notification Preference", "default": "none", "type": "string"}, "group_membership_ids": {"title": "Group Membership Ids", "type": "array", "items": {"$ref": "#/components/schemas/GroupMembersInfoOut"}}, "kind_as_str": {"title": "Kind As Str", "type": "string"}, "is_partial_group": {"title": "Is Partial Group", "type": "boolean"}}, "required": ["id", "name", "reg_ids", "phone_number_ids", "group_membership_ids", "kind_as_str", "is_partial_group"], "definitions": {"RegistrantIDOut": {"title": "RegistrantIDOut", "type": "object", "properties": {"id": {"title": "Id", "type": "integer"}, "id_type_as_str": {"title": "Id Type As Str", "type": "string"}, "value": {"title": "Value", "type": "string"}, "expiry_date": {"title": "Expiry Date", "type": "string", "format": "date"}}, "required": ["id", "id_type_as_str", "value"]}, "PhoneNumberOut": {"title": "PhoneNumberOut", "type": "object", "properties": {"id": {"title": "Id", "type": "integer"}, "phone_no": {"title": "Phone No", "type": "string"}, "phone_sanitized": {"title": "Phone Sanitized", "type": "string"}, "date_collected": {"title": "Date Collected", "type": "string", "format": "date"}, "disabled": {"title": "Disabled", "type": "string", "format": "date"}}, "required": ["id", "phone_no", "phone_sanitized"]}, "RegistrantProgramMembershipOut": {"title": "RegistrantProgramMembershipOut", "type": "object", "properties": {"program_id": {"title": "Program Id", "type": "integer"}, "state": {"title": "State", "type": "string"}, "enrollment_date": {"title": "Enrollment Date", "type": "string", "format": "date"}, "exit_date": {"title": "Exit Date", "type": "string", "format": "date"}}}, "IndividualInfoOut": {"title": "IndividualInfoOut", "type": "object", "properties": {"id": {"title": "Id", "type": "integer"}, "name": {"title": "Name", "type": "string"}, "reg_ids": {"title": "Reg Ids", "type": "array", "items": {"$ref": "#/components/schemas/RegistrantIDOut"}}, "is_group": {"title": "Is Group", "default": false, "type": "boolean"}, "registration_date": {"title": "Registration Date", "type": "string", "format": "date"}, "phone_number_ids": {"title": "Phone Number Ids", "type": "array", "items": {"$ref": "#/components/schemas/PhoneNumberOut"}}, "email": {"title": "Email", "type": "string"}, "address": {"title": "Address", "type": "string"}, "additional_g2p_info": {"title": "Additional G2P Info", "default": "", "type": "string"}, "program_membership_ids": {"title": "Program Membership Ids", "type": "array", "items": {"$ref": "#/components/schemas/RegistrantProgramMembershipOut"}}, "notification_preference": {"title": "Notification Preference", "default": "none", "type": "string"}, "given_name": {"title": "Given Name", "type": "string"}, "addl_name": {"title": "Addl Name", "type": "string"}, "family_name": {"title": "Family Name", "type": "string"}, "gender": {"title": "Gender", "type": "string"}, "birthdate": {"title": "Birthdate", "type": "string", "format": "date"}, "age": {"title": "Age", "type": "string"}, "birth_place": {"title": "Birth Place", "type": "string"}}, "required": ["id", "name", "reg_ids", "phone_number_ids", "age"]}, "GroupMembershipKindInfo": {"title": "GroupMembershipKindInfo", "type": "object", "properties": {"name": {"title": "Name", "type": "string"}}, "required": ["name"]}, "GroupMembersInfoOut": {"title": "GroupMembersInfoOut", "type": "object", "properties": {"id": {"title": "Id", "type": "integer"}, "individual": {"$ref": "#/components/schemas/IndividualInfoOut"}, "kind": {"title": "Kind", "type": "array", "items": {"$ref": "#/components/schemas/GroupMembershipKindInfo"}}}, "required": ["id", "individual"]}}}, "GroupShortInfoOut": {"title": "GroupShortInfoOut", "type": "object", "properties": {"id": {"title": "Id", "type": "integer"}, "name": {"title": "Name", "type": "string"}, "reg_ids": {"title": "Reg Ids", "type": "array", "items": {"$ref": "#/components/schemas/RegistrantIDOut"}}, "is_group": {"title": "Is Group", "type": "boolean"}, "registration_date": {"title": "Registration Date", "type": "string", "format": "date"}, "phone_number_ids": {"title": "Phone Number Ids", "type": "array", "items": {"$ref": "#/components/schemas/PhoneNumberOut"}}, "email": {"title": "Email", "type": "string"}, "address": {"title": "Address", "type": "string"}, "additional_g2p_info": {"title": "Additional G2P Info", "default": "", "type": "string"}, "program_membership_ids": {"title": "Program Membership Ids", "type": "array", "items": {"$ref": "#/components/schemas/RegistrantProgramMembershipOut"}}, "notification_preference": {"title": "Notification Preference", "default": "none", "type": "string"}}, "required": ["id", "name", "reg_ids", "is_group", "phone_number_ids"], "definitions": {"RegistrantIDOut": {"title": "RegistrantIDOut", "type": "object", "properties": {"id": {"title": "Id", "type": "integer"}, "id_type_as_str": {"title": "Id Type As Str", "type": "string"}, "value": {"title": "Value", "type": "string"}, "expiry_date": {"title": "Expiry Date", "type": "string", "format": "date"}}, "required": ["id", "id_type_as_str", "value"]}, "PhoneNumberOut": {"title": "PhoneNumberOut", "type": "object", "properties": {"id": {"title": "Id", "type": "integer"}, "phone_no": {"title": "Phone No", "type": "string"}, "phone_sanitized": {"title": "Phone Sanitized", "type": "string"}, "date_collected": {"title": "Date Collected", "type": "string", "format": "date"}, "disabled": {"title": "Disabled", "type": "string", "format": "date"}}, "required": ["id", "phone_no", "phone_sanitized"]}, "RegistrantProgramMembershipOut": {"title": "RegistrantProgramMembershipOut", "type": "object", "properties": {"program_id": {"title": "Program Id", "type": "integer"}, "state": {"title": "State", "type": "string"}, "enrollment_date": {"title": "Enrollment Date", "type": "string", "format": "date"}, "exit_date": {"title": "Exit Date", "type": "string", "format": "date"}}}}}}, "securitySchemes": {"user": {"type": "apiKey", "in": "cookie", "name": "session_id"}}}}