...
Filtering and attribute selection rules are described in the TMF REST Design Guidelines.
Notifications are also described in a subsequent section.
...
GET /partyManagement/individual/{ID}
Note that collections can be retrieved via GET /api/INDIVIDUAL with no {ID}
Description :
...
REQUEST |
GET /partyManagement/individual/11?fields=fullName |
RESPONSE |
200 |
...
...
GET /partyManagement/organization/{ID}
Note that collections can be retrieved via GET /api/<RESOURCE> with no {ID}
Description :
...
REQUEST |
GET /partyManagement/organization/128 |
RESPONSE |
200 |
...
PUT partyManagement/individual/{ID}
Description :
- Allows to overwrite an existing individual entry in the party repository
- The resource is a managed entity
...
REQUEST |
PUT partyManagement/individual/i42 |
RESPONSE |
201 |
...
...
PUT partyManagement/organization/{ID}
Description :
- Allows to overwrite an existing organization entry in the party repository
- The resource is a managed entity
...
REQUEST |
PUT /partyManagement/organization/128 |
RESPONSE |
201 |
...
...
PATCH partyManagement/individual/{ID}
This Uniform Contract operation is used to partially update the representation of an individual.
Description:
...
REQUEST |
PATCH partyManagement/individual/11 |
RESPONSE |
201 |
...
...
PATCH partyManagement/organization/{ID}
This Uniform Contract operation is used to partially update the representation of an organization
Description:
...
REQUEST |
PATCH partyManagement/organization/131 |
RESPONSE |
201 |
...
POST partyManagement/individual
This operation is used to create an individual.
...
REQUEST |
POST partyManagement/organization |
RESPONSE |
201 |
...
...
DELETE partyManagement/individual/{ID} or /organization/{ID}
Only useful and allowed for administration matters
REQUEST |
DELETE partyManagement/individual/11 |
RESPONSE |
200 |
...
...
POST partyManagement/importJob
ImportJob Tasks are created as resources.
The ImportJob is attached to the URL of the root resource where the content of the file specified by the ImportJob will be applied.
For example to apply the content of the import file located at ftp://ftp.myParty.com/party/54 to the partyManagement root.
REQUEST |
POST ../partyManagement/importJob |
RESPONSE |
201 { "url": "ftp://ftp.myParty.com/party/54" |
...
...
POST partyManagement/exportJob
ExportJob Tasks are created as resources.
The ExportJob is attached to a specific resource acting as the root for the collection of resources to be streamed to a File.
An ExportJob can be attached to a specific Resource in the Party Management application or may be attached to the Individual or Organization collections
...
REQUEST |
POST ../partyManagement/exportJob |
RESPONSE |
201 |
...
GET partyManagement/exportJob
ExportJob resources can be found under the API/exportJob collection and may be retrieved using the normal GET constructs.
For example:
REQUEST |
GET ../partyManagement/exportJob/54 |
RESPONSE |
200
{ |
...
GET partyManagement/IMPORTJob
ImportJob resources can be found under the API/importJob collection and may be retrieved using the normal GET constructs.
For example:
...