Deposit API explain serialisation

From DigiRepWiki

This page is part of Deposit API.

<response>
  ...
  <explain>
    <responseCode/>
    <responseMessage/>
    <!-- If response code is success: - -->
    <repository>
      <globals>
        <repositoryId>[CDATA]</repositoryId>
        <!-- Description -->
        <policies/>
      </global>
      <!-- Same schema as //explain/repository/collections/collection -->
      <defaultCollection>
      </defaultCollection>

      <!-- For depth >0 requests --> 
      <collections>
        <collection>
          <id>[CDATA]</id>
          <description>[CDATA]</description>
          <displayURL>[URL]</display>
          <acceptedFormats>
            <!-- Contains uri & description -->
            *<format/>
          </acceptedFormats>
          <defaultFormat>[As per format, above]</defaultFormat>
         
          <treatment>
            <uri>[URI]</uri>
            <!-- Mandatory. Includes descriptions of 
            metadata migrations, content transformation, 
            PID handling and so on. -->
            <description>[CDATA]</description>
          </treatment>

          <noOpSupported>[BOOLEAN]</noOpSupported>
          <verboseSupported>[BOOLEAN]</verboseSupported>
          <deleteCodeSupported>[BOOLEAN]</deleteCodeSupported>

          <supportedChecksumAlgorithms>
            *<algorithm>[CDATA]</algorithm>
          </supportedChecksumAlgorithms>

          <defaultChecksumAlgorithm>[CDATA]</defaultChecksumAlgorithm>

          <depositAllowed>[BOOLEAN]</depositAllowed>

          <policy>[URL and or Description]</policy>
          *<depositOption>
             <name>[CDATA]</name>
             <hasValue>[BOOL]</hasValue>
             <description>[CDATA]</description>
          </depositOption>

          <availableTargetStates>
            *<state>
              <id>[CDATA]</id>
              <description>[CDATA]</description>
            </state>
          </availableTargetStates>

          <!-- One of collectionIds or collections -->
          <collectionIds>
            <collectionId/>
          </collectionIds>
          <collections/>
        </collection>
      </collections>
    </repository>
  </explain>

</response>