AgreementSocietyRelationshipResource Resource

GET /agreementsocietyrelationships

Returns all relationships between agreements and societies optionally filtered by one or more available filtering options.

Request Parameters
name type description
agreementSocietyRelationshipIds query a String holding one or more SerialAgreementSocietyRelationship ids (separated by comma) which results are to be filtered by
agreementSocietyRelationshipNumbers query a String holding one or more SerialAgreementSocietyRelationship numbers (separated by comma) which results are to be filtered by
Response Codes
code condition
200 Zero or more relationships were returned.
500 An error occured.
Response Body
media type data type description
application/xml;charset=utf-8 (custom) zero or more SerialAgreementSocietyRelationship.

Example

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

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

                
...
                
              

POST /agreementsocietyrelationships

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

Example

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

                
<agreementSocietyRelationship>
  <agreement>
    <comment>...</comment>
    <name>...</name>
    <originalPublisher>
      <id>...</id>
      <ipi>...</ipi>
      <originalPublisherLibraryRelationships>
        <originalPublisherLibraryRelationship/>
      </originalPublisherLibraryRelationships>
      <name>...</name>
      <society/>
      <updated>...</updated>
    </originalPublisher>
    <originalPublisherShare>...</originalPublisherShare>
    <subPublisherShare>...</subPublisherShare>
    <societyRelationships>
      <societyRelationship/>
    </societyRelationships>
    <id>...</id>
    <updated>...</updated>
  </agreement>
  <id>...</id>
  <name>...</name>
  <number>...</number>
  <society>
    <name>...</name>
    <id>...</id>
    <updated>...</updated>
  </society>
  <status>...</status>
  <subPublisher>
    <id>...</id>
    <ipi>...</ipi>
    <name>...</name>
    <updated>...</updated>
  </subPublisher>
  <subStatus>...</subStatus>
  <updated>...</updated>
</agreementSocietyRelationship>

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

                
...
                
              

DELETE /agreementsocietyrelationships/{agreementSocietyRelationshipId}

Deletes a relationship between an agreement and a society.

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

Example

Request
DELETE /agreementsocietyrelationships/{agreementSocietyRelationshipId}
Content-Type: */*

                
...
                
              
Response
HTTP/1.1 204 No Content

              

PUT /agreementsocietyrelationships/{agreementSocietyRelationshipId}

Updates a relationship between an agreement and a society.

Request Parameters
name type description
agreementSocietyRelationshipId path a String holding an id which represents the agreement which is to be updated.
Request Body
media type data type description
application/xml MTAgreementSocietyRelationship (XML) the SerialAgreementSocietyRelationship which is to be updated.
Response Codes
code condition
200 The relationship was updated.
400 The resource ID does not match the payload ID.
404 The relationship does not exist.
409 The relationship 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 SerialAgreementSocietyRelationship.

Example

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

                
<agreementSocietyRelationship>
  <agreement>
    <comment>...</comment>
    <name>...</name>
    <originalPublisher>
      <id>...</id>
      <ipi>...</ipi>
      <originalPublisherLibraryRelationships>
        <originalPublisherLibraryRelationship/>
      </originalPublisherLibraryRelationships>
      <name>...</name>
      <society/>
      <updated>...</updated>
    </originalPublisher>
    <originalPublisherShare>...</originalPublisherShare>
    <subPublisherShare>...</subPublisherShare>
    <societyRelationships>
      <societyRelationship/>
    </societyRelationships>
    <id>...</id>
    <updated>...</updated>
  </agreement>
  <id>...</id>
  <name>...</name>
  <number>...</number>
  <society>
    <name>...</name>
    <id>...</id>
    <updated>...</updated>
  </society>
  <status>...</status>
  <subPublisher>
    <id>...</id>
    <ipi>...</ipi>
    <name>...</name>
    <updated>...</updated>
  </subPublisher>
  <subStatus>...</subStatus>
  <updated>...</updated>
</agreementSocietyRelationship>

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

                
...