StakeholderResource Resource

GET /stakeholders

Returns all stakeholders optionally filtered by one or more available filtering options.

Request Parameters
name type description
stakeholderIds query a String holding one or more ids (separated by comma) for which corresponding stakeholders are to be returned.
Response Codes
code condition
200 One or more stakeholders was successfully returned.
500 An error occured.
Response Body
media type data type description
application/xml;charset=utf-8 (custom) zero or more SerialStakeholder.

Example

Request
GET /stakeholders
Content-Type: */*
Accept: application/xml;charset=utf-8

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/xml;charset=utf-8

                
...
                
              

POST /stakeholders

Creates a stakeholder. Regardless of the provided state of the fields id and updated, these fields will be automatically populated upon creation.

Request Body
media type data type description
application/xml MTStakeholder (XML) the SerialStakeholder which is to be created.
Response Codes
code condition
200 The stakeholder was created.
500 An error occured.
Response Body
media type data type description
application/xml;charset=utf-8 (custom) the created SerialStakeholder.

Example

Request
POST /stakeholders
Content-Type: application/xml
Accept: application/xml;charset=utf-8

                
<stakeholder>
  <cae>...</cae>
  <comment>...</comment>
  <id>...</id>
  <name>...</name>
  <type>...</type>
  <updated>...</updated>
</stakeholder>

                
              
Response
HTTP/1.1 200 OK
Content-Type: application/xml;charset=utf-8

                
...
                
              

DELETE /stakeholders/{stakeholderId}

Deletes a stakeholder.

Request Parameters
name type description
stakeholderId path a String holding an id which represents the stakeholder which is to be deleted.
Response Codes
code condition
204 The stakeholder was deleted.
404 The stakeholder does not exist.
500 An error occured.

Example

Request
DELETE /stakeholders/{stakeholderId}
Content-Type: */*

                
...
                
              
Response
HTTP/1.1 204 No Content

              

PUT /stakeholders/{stakeholderId}

Updates a stakeholder.

Request Parameters
name type description
stakeholderId path a String holding an id which represents the stakeholder which is to be updated.
Request Body
media type data type description
application/xml MTStakeholder (XML) the SerialStakeholder which is to be updated.
Response Codes
code condition
200 The stakeholder was updated.
400 The resource ID does not match the payload ID.
404 The stakeholder does not exist.
409 The stakeholder has been updated by another process.
422 The stakeholder could not be validated.
500 An error occured.
Response Body
media type data type description
application/xml;charset=utf-8 (custom) the updated SerialStakeholder.

Example

Request
PUT /stakeholders/{stakeholderId}
Content-Type: application/xml
Accept: application/xml;charset=utf-8

                
<stakeholder>
  <cae>...</cae>
  <comment>...</comment>
  <id>...</id>
  <name>...</name>
  <type>...</type>
  <updated>...</updated>
</stakeholder>

                
              
Response
HTTP/1.1 200 OK
Content-Type: application/xml;charset=utf-8

                
...