Invite An Entity
To invite an entity, we need to make the following HTTP request
Invite an Entity
POST
/api/v1/{entity-type}/invite
Path Parameters
Headers
Request Body
Important Fields in Response Body
Usage
So to create a Teacher
entity named Pranav Agate who teaches Math at UP Public School, we would make the following API call:
cURL
HTTPie
{registry-url}
is usually http://localhost:{port}. The port can be found under theregistry
section in thedocker-compose.yml
file and is usually8081
.
Note: Invite API doesn't validate the required parameters. Invite API is designed to be used to invite another actor to the system with minimal information, hence required validations will not be applied. Instead, use create an entity API.
Last updated