↔️API

User authentication

post
Responses
post
/login

No content

post
Authorizations
session_idstringRequired
Responses
post
/logout

No content

Individual Registration

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

get
Authorizations
session_idstringRequired
Query parameters
idintegerOptional
namestringOptional
Responses
200Success
application/json
get
/

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

post
Authorizations
session_idstringRequired
Body
namestringRequired
registration_datestring Β· dateOptional
is_groupbooleanOptionalDefault: false
emailstringOptional
addressstringOptional
additional_g2p_infoany ofOptional
object[]Optional
or
objectOptional
notification_preferencestringOptionalDefault: none
given_namestringOptional
addl_namestringOptional
family_namestringOptional
genderstringOptional
birthdatestring Β· dateOptional
birth_placestringOptional
Responses
200Success
application/json
post
/

Get partner's information

get
Authorizations
session_idstringRequired
Path parameters
idinteger Β· int32Required
Responses
200Success
application/json
get
/{id}
get
Authorizations
session_idstringRequired
Query parameters
idintegerOptional
namestringOptional
Responses
200Success
application/json
get
/search

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

patch
Authorizations
session_idstringRequired
Body
id_typestringOptional
valuestringOptional
expiry_datestring Β· dateOptional
partner_idintegerRequired
Responses
200Success
application/json
patch
/updateIdentification

Group Registration

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

get
Authorizations
session_idstringRequired
Query parameters
idintegerOptional
include_members_fullbooleanOptional
namestringOptional
Responses
200Success
application/json
get
/

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

post
Authorizations
session_idstringRequired
Body
namestringRequired
registration_datestring Β· dateOptional
is_groupbooleanOptionalDefault: true
emailstringOptional
addressstringOptional
additional_g2p_infoany ofOptional
object[]Optional
or
objectOptional
notification_preferencestringOptionalDefault: none
kindstringOptional
is_partial_groupbooleanOptional
Responses
200Success
application/json
post
/

Get partner's information

get
Authorizations
session_idstringRequired
Path parameters
idinteger Β· int32Required
Responses
200Success
application/json
get
/{id}

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

get
Authorizations
session_idstringRequired
Query parameters
idintegerOptional
include_members_fullbooleanOptional
namestringOptional
Responses
200Success
application/json
get
/search

Last updated