Managed Entity and Task Resource Models
For every single resource managed by the API provide a JSON based representation of the managed entities and tasks.
Individual Resource
An Individual represents a physical person.
JSON representation of an Individual
...
Field | Description |
id | Unique identifier of related party |
href | Reference of the relatedParty, could be a party reference or a partyRole reference |
role | Role of the related party |
name | Name of the related party |
validFor | The period for which the related party is valid |
UML Model:
Organization Resource
JSON representation of an Organization
...
Field | Description |
id | Unique identifier of related party |
href | Reference of the relatedParty, could be a party reference or a partyRole reference |
role | Role of the related party |
name | Name of the related party |
validFor | The period for which the related party is valid |
UML Model:
Export Job Resource
An ExportJob resource represents a TASK used to export resources to a File
The ExportJob resource supports the following properties:
...
{ |
UML Model:
Import Job Resource
An ImportJob resource represent a TASK used to import resources from a File
The ImportJob resource supports the following properties:
...
{ |
UML Model:
Notification Resource Models
8 notification event types are defined :
...