...
Hide If | |||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||
|
Show If | ||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||
For every single of operation on the entities use the following templates and provide sample REST requests and responses.
|
...
GET /partyManagement/individual/{ID}Note that collections can be retrieved via GET /api/INDIVIDUAL with no {ID}
Example : Retrieve individual with id 11 who is John Doe - with all his attributes.
|
...
|
...
...
GET /partyManagement/organization/{ID}Note that collections can be retrieved via GET /api/<RESOURCE> with no {ID}
Behavior :
Example : Get all names of children organizations of a given one (131)
|
...
|
...
PUT partyManagement/individual/{ID}Description :
Behavior :
Example : Update John Smith (identified by 'i42') : full update
|
...
|
...
|
...
PUT partyManagement/organization/{ID}Description :
Behavior :
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
RESPONSE
|
...
PATCH partyManagement/individual/{ID}This Uniform Contract operation is used to partially update the representation of an individual.
Behavior:
|
...
PATCH partyManagement/organization/{ID}This Uniform Contract operation is used to partially update the representation of an organization
Behavior:
Patchable attributes for an organization:
|
...
...
POST partyManagement/individualThis operation is used to create an individual.
When using following elements there are some mandatory attributes within each element:
Behavior:
|
...
|
...
This operation is used to create an organization.
When using following elements there are some mandatory attributes within each element:
Behavior:
Specify the attributes required when an entity is created (and their default values if not):
|
...
|
...
|
...
...
...
DELETE partyManagement/individual/{ID} or /organization/{ID}Only useful and allowed for administration matters
|
...
POST partyManagement/importJobImportJob Tasks are created as resources.
|
...
...
POST partyManagement/exportJobExportJob Tasks are created as resources.
Export all the resources within partyManagement subject to query and path assignments.
Export all the individual resources within partyManagement subject to query and path assignments.
|
...
...
GET partyManagement/exportJob
|
...
...
GET partyManagement/IMPORTJob
|
© TM Forum 2015. All Rights Reserved