↔️API

User authentication

POSThttps://mec.openg2p.net/session/auth/login

Response

400401403404

One of the given parameter is not valid

Request

JavaScriptCurl

const response = await fetch('https://mec.openg2p.net/session/auth/login', {
    method: 'POST',
    headers: {},
});
const data = await response.json();

POSThttps://mec.openg2p.net/session/auth/logout

Authorization

user

Response

400401403404

One of the given parameter is not valid

Request

JavaScriptCurl

const response = await fetch('https://mec.openg2p.net/session/auth/logout', {
    method: 'POST',
    headers: {},
});
const data = await response.json();

Individual Registration

Search for partners :param partner_search_param: An instance of partner.search.param :return: List of partner.info

GEThttps://mec.openg2p.net/api/v1/registry/individual/

Authorization

user

Query parameters

Response

200400401403404

Body

application/json

id*Id

name*Name

reg_ids*Reg Ids

is_groupIs Group

registration_dateRegistration Date

phone_number_ids*Phone Number Ids

emailEmail

addressAddress

additional_g2p_infoAdditional G2P Info

program_membership_idsProgram Membership Ids

notification_preferenceNotification Preference

given_nameGiven Name

addl_nameAddl Name

family_nameFamily Name

genderGender

birthdateBirthdate

age*Age

birth_placeBirth Place

Request

JavaScriptCurl

const response = await fetch('https://mec.openg2p.net/api/v1/registry/individual/', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

[
  {
    "name": "text",
    "reg_ids": [
      {
        "id_type_as_str": "text",
        "value": "text",
        "expiry_date": "2024-05-08"
      }
    ],
    "is_group": false,
    "registration_date": "2024-05-08",
    "phone_number_ids": [
      {
        "phone_no": "text",
        "phone_sanitized": "text",
        "date_collected": "2024-05-08",
        "disabled": "2024-05-08"
      }
    ],
    "email": "text",
    "address": "text",
    "additional_g2p_info": "text",
    "program_membership_ids": [
      {
        "state": "text",
        "enrollment_date": "2024-05-08",
        "exit_date": "2024-05-08"
      }
    ],
    "notification_preference": "none",
    "given_name": "text",
    "addl_name": "text",
    "family_name": "text",
    "gender": "text",
    "birthdate": "2024-05-08",
    "age": "text",
    "birth_place": "text"
  }
]

Create a new Individual :param individual_info: An instance of the individual info :return: An instance of partner info

POSThttps://mec.openg2p.net/api/v1/registry/individual/

Authorization

user

Body

application/json

name*Name

idsIds

registration_dateRegistration Date

is_groupIs Group

phone_numbersPhone Numbers

emailEmail

addressAddress

additional_g2p_infoAdditional G2P Info

array of objectobject

program_membershipsProgram Memberships

notification_preferenceNotification Preference

given_nameGiven Name

addl_nameAddl Name

family_nameFamily Name

genderGender

birthdateBirthdate

birth_placeBirth Place

Response

200400401403404

Body

application/json

id*Id

name*Name

reg_ids*Reg Ids

is_groupIs Group

registration_dateRegistration Date

phone_number_ids*Phone Number Ids

emailEmail

addressAddress

additional_g2p_infoAdditional G2P Info

program_membership_idsProgram Membership Ids

notification_preferenceNotification Preference

given_nameGiven Name

addl_nameAddl Name

family_nameFamily Name

genderGender

birthdateBirthdate

age*Age

birth_placeBirth Place

Request

JavaScriptCurl

const response = await fetch('https://mec.openg2p.net/api/v1/registry/individual/', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": "text"
    }),
});
const data = await response.json();

Response

{
  "name": "text",
  "reg_ids": [
    {
      "id_type_as_str": "text",
      "value": "text",
      "expiry_date": "2024-05-08"
    }
  ],
  "is_group": false,
  "registration_date": "2024-05-08",
  "phone_number_ids": [
    {
      "phone_no": "text",
      "phone_sanitized": "text",
      "date_collected": "2024-05-08",
      "disabled": "2024-05-08"
    }
  ],
  "email": "text",
  "address": "text",
  "additional_g2p_info": "text",
  "program_membership_ids": [
    {
      "state": "text",
      "enrollment_date": "2024-05-08",
      "exit_date": "2024-05-08"
    }
  ],
  "notification_preference": "none",
  "given_name": "text",
  "addl_name": "text",
  "family_name": "text",
  "gender": "text",
  "birthdate": "2024-05-08",
  "age": "text",
  "birth_place": "text"
}

Get partner's information

GEThttps://mec.openg2p.net/api/v1/registry/individual/{id}

Authorization

user

Path parameters

id*integer (int32)

Response

200400401403404

Body

application/json

id*Id

name*Name

reg_ids*Reg Ids

is_groupIs Group

registration_dateRegistration Date

phone_number_ids*Phone Number Ids

emailEmail

addressAddress

additional_g2p_infoAdditional G2P Info

program_membership_idsProgram Membership Ids

notification_preferenceNotification Preference

given_nameGiven Name

addl_nameAddl Name

family_nameFamily Name

genderGender

birthdateBirthdate

age*Age

birth_placeBirth Place

Request

JavaScriptCurl

const response = await fetch('https://mec.openg2p.net/api/v1/registry/individual/{id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "name": "text",
  "reg_ids": [
    {
      "id_type_as_str": "text",
      "value": "text",
      "expiry_date": "2024-05-08"
    }
  ],
  "is_group": false,
  "registration_date": "2024-05-08",
  "phone_number_ids": [
    {
      "phone_no": "text",
      "phone_sanitized": "text",
      "date_collected": "2024-05-08",
      "disabled": "2024-05-08"
    }
  ],
  "email": "text",
  "address": "text",
  "additional_g2p_info": "text",
  "program_membership_ids": [
    {
      "state": "text",
      "enrollment_date": "2024-05-08",
      "exit_date": "2024-05-08"
    }
  ],
  "notification_preference": "none",
  "given_name": "text",
  "addl_name": "text",
  "family_name": "text",
  "gender": "text",
  "birthdate": "2024-05-08",
  "age": "text",
  "birth_place": "text"
}

Search for partners :param partner_search_param: An instance of partner.search.param :return: List of partner.info

GEThttps://mec.openg2p.net/api/v1/registry/individual/search

Authorization

user

Query parameters

Response

200400401403404

Body

application/json

id*Id

name*Name

reg_ids*Reg Ids

is_groupIs Group

registration_dateRegistration Date

phone_number_ids*Phone Number Ids

emailEmail

addressAddress

additional_g2p_infoAdditional G2P Info

program_membership_idsProgram Membership Ids

notification_preferenceNotification Preference

given_nameGiven Name

addl_nameAddl Name

family_nameFamily Name

genderGender

birthdateBirthdate

age*Age

birth_placeBirth Place

Request

JavaScriptCurl

const response = await fetch('https://mec.openg2p.net/api/v1/registry/individual/search', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

[
  {
    "name": "text",
    "reg_ids": [
      {
        "id_type_as_str": "text",
        "value": "text",
        "expiry_date": "2024-05-08"
      }
    ],
    "is_group": false,
    "registration_date": "2024-05-08",
    "phone_number_ids": [
      {
        "phone_no": "text",
        "phone_sanitized": "text",
        "date_collected": "2024-05-08",
        "disabled": "2024-05-08"
      }
    ],
    "email": "text",
    "address": "text",
    "additional_g2p_info": "text",
    "program_membership_ids": [
      {
        "state": "text",
        "enrollment_date": "2024-05-08",
        "exit_date": "2024-05-08"
      }
    ],
    "notification_preference": "none",
    "given_name": "text",
    "addl_name": "text",
    "family_name": "text",
    "gender": "text",
    "birthdate": "2024-05-08",
    "age": "text",
    "birth_place": "text"
  }
]

Update Individual Identification :param reg_id: An instance of the partner.reg_id :return: An instance of partner.reg_id

PATCHhttps://mec.openg2p.net/api/v1/registry/individual/updateIdentification

Authorization

user

Body

application/json

id_typeId Type

valueValue

expiry_dateExpiry Date

partner_id*Partner Id

Response

200400401403404

Body

application/json

id*Id

id_type_as_str*Id Type As Str

value*Value

expiry_dateExpiry Date

partner_id*Partner Id

Request

JavaScriptCurl

const response = await fetch('https://mec.openg2p.net/api/v1/registry/individual/updateIdentification', {
    method: 'PATCH',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "id_type_as_str": "text",
  "value": "text",
  "expiry_date": "2024-05-08"
}

Group Registration

Search for partners :param partner_search_param: An instance of partner.search.param :return: List of partner.short.info

GEThttps://mec.openg2p.net/api/v1/registry/group/

Authorization

user

Query parameters

Response

200400401403404

Body

application/json

id*Id

name*Name

reg_ids*Reg Ids

is_group*Is Group

registration_dateRegistration Date

phone_number_ids*Phone Number Ids

emailEmail

addressAddress

additional_g2p_infoAdditional G2P Info

program_membership_idsProgram Membership Ids

notification_preferenceNotification Preference

Request

JavaScriptCurl

const response = await fetch('https://mec.openg2p.net/api/v1/registry/group/', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

[
  {
    "name": "text",
    "reg_ids": [
      {
        "id_type_as_str": "text",
        "value": "text",
        "expiry_date": "2024-05-08"
      }
    ],
    "is_group": false,
    "registration_date": "2024-05-08",
    "phone_number_ids": [
      {
        "phone_no": "text",
        "phone_sanitized": "text",
        "date_collected": "2024-05-08",
        "disabled": "2024-05-08"
      }
    ],
    "email": "text",
    "address": "text",
    "additional_g2p_info": "text",
    "program_membership_ids": [
      {
        "state": "text",
        "enrollment_date": "2024-05-08",
        "exit_date": "2024-05-08"
      }
    ],
    "notification_preference": "none"
  }
]

Create a new Group :param group_info: An instance of the group info :return: An instance of partner.info

POSThttps://mec.openg2p.net/api/v1/registry/group/

Authorization

user

Body

application/json

name*Name

idsIds

registration_dateRegistration Date

is_groupIs Group

phone_numbersPhone Numbers

emailEmail

addressAddress

additional_g2p_infoAdditional G2P Info

array of objectobject

program_membershipsProgram Memberships

notification_preferenceNotification Preference

members*Members

kindKind

is_partial_groupIs Partial Group

Response

200400401403404

Body

application/json

id*Id

name*Name

reg_ids*Reg Ids

is_groupIs Group

registration_dateRegistration Date

phone_number_ids*Phone Number Ids

emailEmail

addressAddress

additional_g2p_infoAdditional G2P Info

program_membership_idsProgram Membership Ids

notification_preferenceNotification Preference

group_membership_ids*Group Membership Ids

kind_as_str*Kind As Str

is_partial_group*Is Partial Group

Request

JavaScriptCurl

const response = await fetch('https://mec.openg2p.net/api/v1/registry/group/', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": "text",
      "members": [
        {
          "name": "text"
        }
      ]
    }),
});
const data = await response.json();

Response

{
  "name": "text",
  "reg_ids": [
    {
      "id_type_as_str": "text",
      "value": "text",
      "expiry_date": "2024-05-08"
    }
  ],
  "is_group": true,
  "registration_date": "2024-05-08",
  "phone_number_ids": [
    {
      "phone_no": "text",
      "phone_sanitized": "text",
      "date_collected": "2024-05-08",
      "disabled": "2024-05-08"
    }
  ],
  "email": "text",
  "address": "text",
  "additional_g2p_info": "text",
  "program_membership_ids": [
    {
      "state": "text",
      "enrollment_date": "2024-05-08",
      "exit_date": "2024-05-08"
    }
  ],
  "notification_preference": "none",
  "group_membership_ids": [
    {
      "individual": {
        "name": "text",
        "reg_ids": [
          {
            "id_type_as_str": "text",
            "value": "text",
            "expiry_date": "2024-05-08"
          }
        ],
        "is_group": false,
        "registration_date": "2024-05-08",
        "phone_number_ids": [
          {
            "phone_no": "text",
            "phone_sanitized": "text",
            "date_collected": "2024-05-08",
            "disabled": "2024-05-08"
          }
        ],
        "email": "text",
        "address": "text",
        "additional_g2p_info": "text",
        "program_membership_ids": [
          {
            "state": "text",
            "enrollment_date": "2024-05-08",
            "exit_date": "2024-05-08"
          }
        ],
        "notification_preference": "none",
        "given_name": "text",
        "addl_name": "text",
        "family_name": "text",
        "gender": "text",
        "birthdate": "2024-05-08",
        "age": "text",
        "birth_place": "text"
      },
      "kind": [
        {
          "name": "text"
        }
      ]
    }
  ],
  "kind_as_str": "text",
  "is_partial_group": false
}

Get partner's information

GEThttps://mec.openg2p.net/api/v1/registry/group/{id}

Authorization

user

Path parameters

id*integer (int32)

Response

200400401403404

Body

application/json

id*Id

name*Name

reg_ids*Reg Ids

is_groupIs Group

registration_dateRegistration Date

phone_number_ids*Phone Number Ids

emailEmail

addressAddress

additional_g2p_infoAdditional G2P Info

program_membership_idsProgram Membership Ids

notification_preferenceNotification Preference

group_membership_ids*Group Membership Ids

kind_as_str*Kind As Str

is_partial_group*Is Partial Group

Request

JavaScriptCurl

const response = await fetch('https://mec.openg2p.net/api/v1/registry/group/{id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "name": "text",
  "reg_ids": [
    {
      "id_type_as_str": "text",
      "value": "text",
      "expiry_date": "2024-05-08"
    }
  ],
  "is_group": true,
  "registration_date": "2024-05-08",
  "phone_number_ids": [
    {
      "phone_no": "text",
      "phone_sanitized": "text",
      "date_collected": "2024-05-08",
      "disabled": "2024-05-08"
    }
  ],
  "email": "text",
  "address": "text",
  "additional_g2p_info": "text",
  "program_membership_ids": [
    {
      "state": "text",
      "enrollment_date": "2024-05-08",
      "exit_date": "2024-05-08"
    }
  ],
  "notification_preference": "none",
  "group_membership_ids": [
    {
      "individual": {
        "name": "text",
        "reg_ids": [
          {
            "id_type_as_str": "text",
            "value": "text",
            "expiry_date": "2024-05-08"
          }
        ],
        "is_group": false,
        "registration_date": "2024-05-08",
        "phone_number_ids": [
          {
            "phone_no": "text",
            "phone_sanitized": "text",
            "date_collected": "2024-05-08",
            "disabled": "2024-05-08"
          }
        ],
        "email": "text",
        "address": "text",
        "additional_g2p_info": "text",
        "program_membership_ids": [
          {
            "state": "text",
            "enrollment_date": "2024-05-08",
            "exit_date": "2024-05-08"
          }
        ],
        "notification_preference": "none",
        "given_name": "text",
        "addl_name": "text",
        "family_name": "text",
        "gender": "text",
        "birthdate": "2024-05-08",
        "age": "text",
        "birth_place": "text"
      },
      "kind": [
        {
          "name": "text"
        }
      ]
    }
  ],
  "kind_as_str": "text",
  "is_partial_group": false
}

Search for partners :param partner_search_param: An instance of partner.search.param :return: List of partner.short.info

GEThttps://mec.openg2p.net/api/v1/registry/group/search

Authorization

user

Query parameters

Response

200400401403404

Body

application/json

id*Id

name*Name

reg_ids*Reg Ids

is_group*Is Group

registration_dateRegistration Date

phone_number_ids*Phone Number Ids

emailEmail

addressAddress

additional_g2p_infoAdditional G2P Info

program_membership_idsProgram Membership Ids

notification_preferenceNotification Preference

Request

JavaScriptCurl

const response = await fetch('https://mec.openg2p.net/api/v1/registry/group/search', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

[
  {
    "name": "text",
    "reg_ids": [
      {
        "id_type_as_str": "text",
        "value": "text",
        "expiry_date": "2024-05-08"
      }
    ],
    "is_group": false,
    "registration_date": "2024-05-08",
    "phone_number_ids": [
      {
        "phone_no": "text",
        "phone_sanitized": "text",
        "date_collected": "2024-05-08",
        "disabled": "2024-05-08"
      }
    ],
    "email": "text",
    "address": "text",
    "additional_g2p_info": "text",
    "program_membership_ids": [
      {
        "state": "text",
        "enrollment_date": "2024-05-08",
        "exit_date": "2024-05-08"
      }
    ],
    "notification_preference": "none"
  }
]