API

PreviousIntegration with e-Signet NextTesting

Last updated 1 year ago

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

get

Authorizations

Query parameters

idintegerOptional

include_members_fullbooleanOptional

namestringOptional

Responses

200Success

application/json

400

One of the given parameter is not valid

401

The user is not authorized. Authentication is required

403

You don't have the permission to access the requested resource.

404

Requested resource not found

get

GET /api/v1/registry/group/ HTTP/1.1
Host: mec.openg2p.net
Accept: */*

[
  {
    "id": 1,
    "name": "text",
    "reg_ids": [
      {
        "id": 1,
        "id_type_as_str": "text",
        "value": "text",
        "expiry_date": "2025-05-16"
      }
    ],
    "is_group": true,
    "registration_date": "2025-05-16",
    "phone_number_ids": [
      {
        "id": 1,
        "phone_no": "text",
        "phone_sanitized": "text",
        "date_collected": "2025-05-16",
        "disabled": "2025-05-16"
      }
    ],
    "email": "text",
    "address": "text",
    "additional_g2p_info": "",
    "program_membership_ids": [
      {
        "program_id": 1,
        "state": "text",
        "enrollment_date": "2025-05-16",
        "exit_date": "2025-05-16"
      }
    ],
    "notification_preference": "none"
  }
]

Get partner's information

get

Authorizations

Path parameters

idinteger · int32Required

Responses

200Success

application/json

400

One of the given parameter is not valid

401

The user is not authorized. Authentication is required

403

You don't have the permission to access the requested resource.

404

Requested resource not found

get

GET /api/v1/registry/group/{id} HTTP/1.1
Host: mec.openg2p.net
Accept: */*

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

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

get

Authorizations

Query parameters

idintegerOptional

include_members_fullbooleanOptional

namestringOptional

Responses

200Success

application/json

400

One of the given parameter is not valid

401

The user is not authorized. Authentication is required

403

You don't have the permission to access the requested resource.

404

Requested resource not found

get

GET /api/v1/registry/group/search HTTP/1.1
Host: mec.openg2p.net
Accept: */*

[
  {
    "id": 1,
    "name": "text",
    "reg_ids": [
      {
        "id": 1,
        "id_type_as_str": "text",
        "value": "text",
        "expiry_date": "2025-05-16"
      }
    ],
    "is_group": true,
    "registration_date": "2025-05-16",
    "phone_number_ids": [
      {
        "id": 1,
        "phone_no": "text",
        "phone_sanitized": "text",
        "date_collected": "2025-05-16",
        "disabled": "2025-05-16"
      }
    ],
    "email": "text",
    "address": "text",
    "additional_g2p_info": "",
    "program_membership_ids": [
      {
        "program_id": 1,
        "state": "text",
        "enrollment_date": "2025-05-16",
        "exit_date": "2025-05-16"
      }
    ],
    "notification_preference": "none"
  }
]

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

post

Authorizations

Body

namestringRequired

registration_datestring · dateOptional

is_groupbooleanOptionalDefault: true

emailstringOptional

addressstringOptional

additional_g2p_infoany ofOptional

object[]Optional

objectOptional

notification_preferencestringOptionalDefault: none

kindstringOptional

is_partial_groupbooleanOptional

Responses

200Success

application/json

400

One of the given parameter is not valid

401

The user is not authorized. Authentication is required

403

You don't have the permission to access the requested resource.

404

Requested resource not found

post

POST /api/v1/registry/group/ HTTP/1.1
Host: mec.openg2p.net
Content-Type: application/json
Accept: */*
Content-Length: 927

{
  "name": "text",
  "ids": [
    {
      "id_type": "text",
      "value": "text",
      "expiry_date": "2025-05-16"
    }
  ],
  "registration_date": "2025-05-16",
  "is_group": true,
  "phone_numbers": [
    {
      "phone_no": "text",
      "date_collected": "2025-05-16"
    }
  ],
  "email": "text",
  "address": "text",
  "additional_g2p_info": [
    {}
  ],
  "program_memberships": [
    {
      "name": "text",
      "enrollment_date": "2025-05-16"
    }
  ],
  "notification_preference": "none",
  "members": [
    {
      "name": "text",
      "given_name": "text",
      "addl_name": "text",
      "family_name": "text",
      "ids": [
        {
          "id_type": "text",
          "value": "text",
          "expiry_date": "2025-05-16"
        }
      ],
      "registration_date": "2025-05-16",
      "phone_numbers": [
        {
          "phone_no": "text",
          "date_collected": "2025-05-16"
        }
      ],
      "email": "text",
      "address": "text",
      "gender": "text",
      "birthdate": "2025-05-16",
      "birth_place": "text",
      "kind": [
        {
          "name": "text"
        }
      ],
      "is_group": false,
      "additional_g2p_info": [
        {}
      ],
      "program_memberships": [
        {
          "name": "text",
          "enrollment_date": "2025-05-16"
        }
      ],
      "notification_preference": "none"
    }
  ],
  "kind": "text",
  "is_partial_group": true
}

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

Responses

400

One of the given parameter is not valid

401

The user is not authorized. Authentication is required

403

You don't have the permission to access the requested resource.

404

Requested resource not found

post

POST /session/auth/login HTTP/1.1
Host: mec.openg2p.net
Accept: */*

No content

post

Authorizations

Responses

400

One of the given parameter is not valid

401

The user is not authorized. Authentication is required

403

You don't have the permission to access the requested resource.

404

Requested resource not found

post

POST /session/auth/logout HTTP/1.1
Host: mec.openg2p.net
Accept: */*

No content

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

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

post

Authorizations

Body

namestringRequired

registration_datestring · dateOptional

is_groupbooleanOptionalDefault: false

emailstringOptional

addressstringOptional

additional_g2p_infoany ofOptional

object[]Optional

objectOptional

notification_preferencestringOptionalDefault: none

given_namestringOptional

addl_namestringOptional

family_namestringOptional

genderstringOptional

birthdatestring · dateOptional

birth_placestringOptional

Responses

200Success

application/json

400

One of the given parameter is not valid

401

The user is not authorized. Authentication is required

403

You don't have the permission to access the requested resource.

404

Requested resource not found

post

POST /api/v1/registry/individual/ HTTP/1.1
Host: mec.openg2p.net
Content-Type: application/json
Accept: */*
Content-Length: 487

{
  "name": "text",
  "ids": [
    {
      "id_type": "text",
      "value": "text",
      "expiry_date": "2025-05-16"
    }
  ],
  "registration_date": "2025-05-16",
  "is_group": false,
  "phone_numbers": [
    {
      "phone_no": "text",
      "date_collected": "2025-05-16"
    }
  ],
  "email": "text",
  "address": "text",
  "additional_g2p_info": [
    {}
  ],
  "program_memberships": [
    {
      "name": "text",
      "enrollment_date": "2025-05-16"
    }
  ],
  "notification_preference": "none",
  "given_name": "text",
  "addl_name": "text",
  "family_name": "text",
  "gender": "text",
  "birthdate": "2025-05-16",
  "birth_place": "text"
}

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

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

[
  {
    "id": 1,
    "name": "text",
    "reg_ids": [
      {
        "id": 1,
        "id_type_as_str": "text",
        "value": "text",
        "expiry_date": "2025-05-16"
      }
    ],
    "is_group": false,
    "registration_date": "2025-05-16",
    "phone_number_ids": [
      {
        "id": 1,
        "phone_no": "text",
        "phone_sanitized": "text",
        "date_collected": "2025-05-16",
        "disabled": "2025-05-16"
      }
    ],
    "email": "text",
    "address": "text",
    "additional_g2p_info": "",
    "program_membership_ids": [
      {
        "program_id": 1,
        "state": "text",
        "enrollment_date": "2025-05-16",
        "exit_date": "2025-05-16"
      }
    ],
    "notification_preference": "none",
    "given_name": "text",
    "addl_name": "text",
    "family_name": "text",
    "gender": "text",
    "birthdate": "2025-05-16",
    "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

patch

Authorizations

Body

id_typestringOptional

valuestringOptional

expiry_datestring · dateOptional

partner_idintegerRequired

Responses

200Success

application/json

400

One of the given parameter is not valid

401

The user is not authorized. Authentication is required

403

You don't have the permission to access the requested resource.

404

Requested resource not found

patch

PATCH /api/v1/registry/individual/updateIdentification HTTP/1.1
Host: mec.openg2p.net
Content-Type: application/json
Accept: */*
Content-Length: 75

{
  "id_type": "text",
  "value": "text",
  "expiry_date": "2025-05-16",
  "partner_id": 1
}

{
  "id": 1,
  "id_type_as_str": "text",
  "value": "text",
  "expiry_date": "2025-05-16",
  "partner_id": 1
}

API

API

User authentication

Individual Registration

Group Registration

User authentication

Individual Registration

Group Registration

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

Get partner's information

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

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

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

Get partner's information

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

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

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