Skip to content
This repository has been archived by the owner on Dec 21, 2021. It is now read-only.

Commit

Permalink
Split metadata.select services and include where appropriate
Browse files Browse the repository at this point in the history
  • Loading branch information
mcpgovernance committed Dec 26, 2012
1 parent 86b66b5 commit 21e9531
Show file tree
Hide file tree
Showing 5 changed files with 82 additions and 99 deletions.
5 changes: 3 additions & 2 deletions eng/developer/source/xml_services/index.rst
Expand Up @@ -10,10 +10,11 @@ XML Services
login_xml_services.rst
group_xml_services.rst
user_xml_services.rst
metadata_xml_privileges.rst
metadata_xml_ownership.rst
metadata_xml_search_retrieve.rst
metadata_xml_insert_update_delete.rst
metadata_xml_select.rst
metadata_xml_privileges.rst
metadata_xml_ownership.rst
system_configuration.rst
services_general.rst
services_download.rst
Expand Down
37 changes: 3 additions & 34 deletions eng/developer/source/xml_services/metadata_xml_ownership.rst
Expand Up @@ -7,6 +7,8 @@ These services allow retrieval and management of metadata ownership where the 'o
Only users with **Administrator** and **UserAdmin**
profiles can execute these services.

.. _metadata.batch.newowner:

Batch new owner (metadata.batch.newowner)
-----------------------------------------

Expand All @@ -17,40 +19,7 @@ metadata records.

Requires authentication: Yes

Request to metadata.select service
``````````````````````````````````

Parameters:

- **id**: Identifier of metadata to select (can be multiple elements)

- **selected**: Selection state. Values: add, add-all, remove, remove-all

Select metadata request example::

Url:
http://localhost:8080/geonetwork/srv/en/metadata.select

Mime-type:
application/xml

Post request:
<?xml version="1.0" encoding="UTF-8"?>
<request>
<selected>add-all</selected>
</request>

Response from metadata.select service
`````````````````````````````````````

The response contains the number of metadata records selected.

Select metadata response example::

<?xml version="1.0" encoding="UTF-8"?>
<request>
<Selected>10</Selected>
</request>
.. include:: metadata_xml_select_include.rst

Request to metadata.batch.newowner
``````````````````````````````````
Expand Down
66 changes: 3 additions & 63 deletions eng/developer/source/xml_services/metadata_xml_privileges.rst
Expand Up @@ -89,6 +89,8 @@ Errors
violates foreign key 'operationallowed_groupid_fkey »**, if a
group identifier provided is not valid

.. _metadata.batch.update.privileges:

Batch update privileges (metadata.batch.update.privileges)
----------------------------------------------------------

Expand All @@ -100,69 +102,7 @@ This service requires a previous call to **metadata.select** service to select t

Requires authentication: Yes

Request to metadata.select service
``````````````````````````````````

Parameters:

- **id**: Identifier of metadata to select

- **selected**: Selection state. Values: add, add-all, remove, remove-all

Select all metadata allowed example::

Url:
http://localhost:8080/geonetwork/srv/en/metadata.select

Mime-type:
application/xml

Post request:
<?xml version="1.0" encoding="UTF-8"?>
<request>
<selected>add-all</selected>
</request>

Select a metadata record example::

Url:
http://localhost:8080/geonetwork/srv/en/metadata.select

Mime-type:
application/xml

Post request:
<?xml version="1.0" encoding="UTF-8"?>
<request>
<id>2</id>
<selected>add</selected>
</request>

Clear metadata selection example::

Url:
http://localhost:8080/geonetwork/srv/en/metadata.select

Mime-type:
application/xml

Post request:
<?xml version="1.0" encoding="UTF-8"?>
<request>
<selected>remove-all</selected>
</request>

Response from metadata.select service
`````````````````````````````````````

The response contains the number of metadata selected.

Response select metadata example::

<?xml version="1.0" encoding="UTF-8"?>
<request>
<Selected>10</Selected>
</request>
.. include:: metadata_xml_select_include.rst

Request to metadata.batch.update.privileges
-------------------------------------------
Expand Down
9 changes: 9 additions & 0 deletions eng/developer/source/xml_services/metadata_xml_select.rst
@@ -0,0 +1,9 @@

.. _metadata_xml_select:

Metadata Select Services
========================

These services are for creating and managing a set of selected metadata records. The selected set is normally used by the metadata.batch services eg. :ref:`metadata.batch.update.privileges`, :ref:`metadata.batch.newowner`.

.. include:: metadata_xml_select_include.rst
64 changes: 64 additions & 0 deletions eng/developer/source/xml_services/metadata_xml_select_include.rst
@@ -0,0 +1,64 @@
Request to metadata.select service
``````````````````````````````````

Parameters:

- **id**: Identifier of metadata to select (can be more than one)

- **selected**: Selection state. Values: add, add-all, remove, remove-all

Select all metadata example::

Url:
http://localhost:8080/geonetwork/srv/en/metadata.select

Mime-type:
application/xml

Post request:
<?xml version="1.0" encoding="UTF-8"?>
<request>
<selected>add-all</selected>
</request>

Select a metadata record example::

Url:
http://localhost:8080/geonetwork/srv/en/metadata.select

Mime-type:
application/xml

Post request:
<?xml version="1.0" encoding="UTF-8"?>
<request>
<id>2</id>
<selected>add</selected>
</request>

Clear metadata selection example::

Url:
http://localhost:8080/geonetwork/srv/en/metadata.select

Mime-type:
application/xml

Post request:
<?xml version="1.0" encoding="UTF-8"?>
<request>
<selected>remove-all</selected>
</request>

Response from metadata.select service
`````````````````````````````````````

The response contains the number of metadata records selected.

Example::

<?xml version="1.0" encoding="UTF-8"?>
<request>
<Selected>10</Selected>
</request>

0 comments on commit 21e9531

Please sign in to comment.