SubPublisherResource Resource

GET /subpublishers

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

Request Parameters
name type description
subPublisherIds query a String holding one or more ids (separated by comma) for which corresponding sub publisher is to be returned.
Response Codes
code condition
200 One or more sub publishers was successfully returned.
404 No sub publishers corresponds to the provided filters.
500 An error occured.
Response Body
media type data type description
application/xml;charset=utf-8 (custom) zero or more SubPublisher.

Example

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

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

                
...
                
              

POST /subpublishers

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

Example

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

                
<subPublisher>
  <id>...</id>
  <ipi>...</ipi>
  <name>...</name>
  <updated>...</updated>
</subPublisher>

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

                
...
                
              

DELETE /subpublishers/{subPublisherId}

Deletes a sub publisher.

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

Example

Request
DELETE /subpublishers/{subPublisherId}
Content-Type: */*

                
...
                
              
Response
HTTP/1.1 204 No Content

              

PUT /subpublishers/{subPublisherId}

Updates a sub publisher.

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

Example

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

                
<subPublisher>
  <id>...</id>
  <ipi>...</ipi>
  <name>...</name>
  <updated>...</updated>
</subPublisher>

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

                
...