SocietyResource Resource

GET /societies

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

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

Example

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

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

                
...
                
              

POST /societies

Creates a society. 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 MTSociety (XML) the SerialSociety which is to be created.
Response Codes
code condition
200 The society was created.
500 An error occured.
Response Body
media type data type description
application/xml;charset=utf-8 (custom) the created SerialSociety.

Example

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

                
<society>
  <name>...</name>
  <id>...</id>
  <updated>...</updated>
</society>

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

                
...
                
              

DELETE /societies/{societyId}

Deletes a society.

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

Example

Request
DELETE /societies/{societyId}
Content-Type: */*

                
...
                
              
Response
HTTP/1.1 204 No Content

              

PUT /societies/{societyId}

Updates a society.

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

Example

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

                
<society>
  <name>...</name>
  <id>...</id>
  <updated>...</updated>
</society>

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

                
...