Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

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

existsDuring

Details the establishment of the organization and its cessation

href

Reference of the organization

id

Unique identifier for the organization

isLegalEntity

To tag if the organization is a legal entity known by national referential

nameType

"Co.", "Inc.", "Ltd.", "Pty Ltd." , "Plc.", "Gmbh"

status

Status of the organization - Initialized, Validated, Closed

tradingNameanchor

documentationSectiondocumentationSection

The name that the organization (unit) trades under

type

Type of Organization (Company, …)

...

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:

...

{
        "id": "54",
        "href": "http:/api/catalogManagement/exportJob/54",
        "status": "running",
        "path": "partyManagement/",
        "content-type": "application/json",
        "errorLog": "",
        "creationDate": "2013-04-19T16:42:23-04:00",
        "completionDate": "2013-04-21T16:42:23-04:00",
        "url": "ftp://ftp.myParty.com/party/54"
    }   


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:

...

{
        "id": "54",
        "href": "http:/api/ partyManagement/importJob/54",
        "status": "completed",
        "path": "partyManagement/",
        "content-type": "application/json",
        "errorLog": "",
        "creationDate": "2013-04-19T16:42:23-04:00",
        "completionDate": "2013-04-21T16:42:23-04:00",
        "url": "ftp://ftp.myParty.com/party/54"
    }   


UML Model:

...

Notification Resource Models

8 notification event types are defined :

...