Changeset 7276 for RevitalizationWS


Ignore:
Timestamp:
04/08/10 17:11:36 (9 years ago)
Author:
mnagni
Message:

many changes....

File:
1 edited

Legend:

Unmodified
Added
Removed
  • RevitalizationWS/schemas/dataProvider/trunk/src/main/resources/DPWS.xsd

    r7266 r7276  
    5656                </xs:complexType> 
    5757        </xs:element> 
     58        <xs:element name="DoHarvestResponse"> 
     59                <xs:annotation> 
     60                        <xs:documentation>Return confirmation on status of metadata harvest and relevant report</xs:documentation> 
     61                </xs:annotation> 
     62                <xs:complexType> 
     63                        <xs:sequence> 
     64                                <xs:element name="Confirmation" type="ConfirmationType"/> 
     65                                <xs:element name="processID" type="ProcessIDType"/> 
     66                        </xs:sequence> 
     67                </xs:complexType> 
     68        </xs:element> 
     69        <xs:element name="DoNewProviderRequest"> 
     70                <xs:complexType> 
     71                        <xs:sequence> 
     72                                <xs:element name="DoNewProvider" type="NewProviderDetails"/> 
     73                        </xs:sequence> 
     74                </xs:complexType> 
     75        </xs:element> 
     76        <xs:complexType name="NewProviderDetails"> 
     77                <xs:annotation> 
     78                        <xs:documentation>Provide details for a NEW metadata provider</xs:documentation> 
     79                </xs:annotation> 
     80                <xs:sequence> 
     81                        <xs:element name="HarvestDetails"> 
     82                                <xs:complexType> 
     83                                        <xs:choice> 
     84                                                <xs:element name="OAIProvider" type="OAIProviderDetailsType"/> 
     85                                                <xs:element name="CSWProvider" type="CSWProviderDetailsType"/> 
     86                                        </xs:choice> 
     87                                </xs:complexType> 
     88                        </xs:element> 
     89                        <xs:element name="ProviderCommon" type="ProviderCommonType"/> 
     90                </xs:sequence> 
     91        </xs:complexType> 
     92        <xs:element name="DoNewProviderResponse"> 
     93                <xs:annotation> 
     94                        <xs:documentation>Confirmation of addition of NEW metadata provider details (super admin only)</xs:documentation> 
     95                </xs:annotation> 
     96                <xs:complexType> 
     97                        <xs:sequence> 
     98                                <xs:element name="Confirmation" type="ConfirmationType"/> 
     99                                <xs:element ref="Provider"/> 
     100                        </xs:sequence> 
     101                </xs:complexType> 
     102        </xs:element> 
     103        <xs:element name="GetHarvestHistoryRequest"> 
     104                <xs:annotation> 
     105                        <xs:documentation>Get information on OAI or CSW metadata harvesting histories for a date range</xs:documentation> 
     106                </xs:annotation> 
     107                <xs:complexType> 
     108                        <xs:sequence> 
     109                                <xs:element name="DateRange" type="DataRangeType" minOccurs="0"> 
     110                                        <xs:annotation> 
     111                                                <xs:documentation>If DateRange not present will default to the last 10 days</xs:documentation> 
     112                                        </xs:annotation> 
     113                                </xs:element> 
     114                                <xs:element ref="Provider"/> 
     115                        </xs:sequence> 
     116                </xs:complexType> 
     117        </xs:element> 
     118        <xs:complexType name="GetIngestHistoryRequest"> 
     119                <xs:annotation> 
     120                        <xs:documentation>Get information on metadata ingest into the discovery database history for a date range</xs:documentation> 
     121                </xs:annotation> 
     122                <xs:sequence> 
     123                        <xs:element name="DateRange" type="DataRangeType" minOccurs="0"> 
     124                                <xs:annotation> 
     125                                        <xs:documentation>If DateRange not present will default to the last 10 days</xs:documentation> 
     126                                </xs:annotation> 
     127                        </xs:element> 
     128                        <xs:element ref="Provider"/> 
     129                </xs:sequence> 
     130        </xs:complexType> 
     131        <xs:element name="GetProviderStatsRequest"> 
     132                <xs:annotation> 
     133                        <xs:documentation>Get basic statistics on records in the discovery database for provider N</xs:documentation> 
     134                </xs:annotation> 
     135                <xs:complexType> 
     136                        <xs:sequence> 
     137                                <xs:element name="DateRange" type="DataRangeType" minOccurs="0"/> 
     138                                <xs:element ref="Provider"/> 
     139                        </xs:sequence> 
     140                </xs:complexType> 
     141        </xs:element> 
     142        <xs:element name="GetUsageStatsRequest"> 
     143                <xs:annotation> 
     144                        <xs:documentation>Get basic statistic on usage of the Data Web Service (DWS)</xs:documentation> 
     145                </xs:annotation> 
     146                <xs:complexType> 
     147                        <xs:sequence> 
     148                                <xs:element name="DataRange" type="DataRangeType"/> 
     149                        </xs:sequence> 
     150                </xs:complexType> 
     151        </xs:element> 
     152        <xs:complexType name="GetProviderDetailsRequest"> 
     153                <xs:annotation> 
     154                        <xs:documentation>Request details for provider N</xs:documentation> 
     155                </xs:annotation> 
     156                <xs:sequence> 
     157                        <xs:element ref="Provider"/> 
     158                </xs:sequence> 
     159        </xs:complexType> 
     160        <xs:element name="DoConfigureProviderDetails"> 
     161                <xs:annotation> 
     162                        <xs:documentation>Change details for metadata provider N - includes OAI/CSW harvesting endpoints as well as provider N details</xs:documentation> 
     163                </xs:annotation> 
     164                <xs:complexType> 
     165                        <xs:sequence> 
     166                                <xs:element name="ContactDetails" type="ProviderContactType" minOccurs="0"/> 
     167                        </xs:sequence> 
     168                </xs:complexType> 
     169        </xs:element> 
     170        <xs:element name="DoConfigureProviderDetailsReturn"> 
     171                <xs:annotation> 
     172                        <xs:documentation>Confirmation of update to Provider N's details</xs:documentation> 
     173                </xs:annotation> 
     174                <xs:complexType> 
     175                        <xs:sequence> 
     176                                <xs:element name="Confirmation" type="ConfirmationType"/> 
     177                        </xs:sequence> 
     178                </xs:complexType> 
     179        </xs:element> 
    58180        <xs:element name="DoIngestRequest"> 
    59181                <xs:annotation> 
     
    81203                </xs:complexType> 
    82204        </xs:element> 
    83         <xs:element name="GetHarvestHistoryRequest"> 
    84                 <xs:annotation> 
    85                         <xs:documentation>Get information on OAI or CSW metadata harvesting histories for a date range</xs:documentation> 
    86                 </xs:annotation> 
    87                 <xs:complexType> 
    88                         <xs:sequence> 
    89                                 <xs:element name="DateRange" type="DataRangeType" minOccurs="0"> 
    90                                         <xs:annotation> 
    91                                                 <xs:documentation>If DateRange not present will default to the last 10 days</xs:documentation> 
    92                                         </xs:annotation> 
    93                                 </xs:element> 
    94                                 <xs:element ref="Provider"/> 
    95                         </xs:sequence> 
    96                 </xs:complexType> 
    97         </xs:element> 
    98         <xs:complexType name="GetIngestHistoryRequest"> 
    99                 <xs:annotation> 
    100                         <xs:documentation>Get information on metadata ingest into the discovery database history for a date range</xs:documentation> 
    101                 </xs:annotation> 
    102                 <xs:sequence> 
    103                         <xs:element name="DateRange" type="DataRangeType" minOccurs="0"> 
    104                                 <xs:annotation> 
    105                                         <xs:documentation>If DateRange not present will default to the last 10 days</xs:documentation> 
    106                                 </xs:annotation> 
    107                         </xs:element> 
    108                         <xs:element ref="Provider"/> 
    109                 </xs:sequence> 
    110         </xs:complexType> 
    111         <xs:element name="GetProviderStatsRequest"> 
    112                 <xs:annotation> 
    113                         <xs:documentation>Get basic statistics on records in the discovery database for provider N</xs:documentation> 
    114                 </xs:annotation> 
    115                 <xs:complexType> 
    116                         <xs:sequence> 
    117                                 <xs:element name="DateRange" type="DataRangeType" minOccurs="0"/> 
    118                                 <xs:element ref="Provider"/> 
    119                         </xs:sequence> 
    120                 </xs:complexType> 
    121         </xs:element> 
    122         <xs:element name="GetUsageStatsRequest"> 
    123                 <xs:annotation> 
    124                         <xs:documentation>Get basic statistic on usage of the Data Web Service (DWS)</xs:documentation> 
    125                 </xs:annotation> 
    126                 <xs:complexType> 
    127                         <xs:sequence> 
    128                                 <xs:element name="DataRange" type="DataRangeType"/> 
    129                         </xs:sequence> 
    130                 </xs:complexType> 
    131         </xs:element> 
    132         <xs:complexType name="DoNewProviderDetails"> 
    133                 <xs:annotation> 
    134                         <xs:documentation>Provide details for a NEW metadata provider</xs:documentation> 
    135                 </xs:annotation> 
    136                 <xs:sequence> 
    137                         <xs:element name="NewProviderInformation" type="ProviderContactType"/> 
    138                 </xs:sequence> 
    139         </xs:complexType> 
    140         <xs:complexType name="GetProviderDetailsRequest"> 
    141                 <xs:annotation> 
    142                         <xs:documentation>Request details for provider N</xs:documentation> 
    143                 </xs:annotation> 
    144                 <xs:sequence> 
    145                         <xs:element ref="Provider"/> 
    146                 </xs:sequence> 
    147         </xs:complexType> 
    148         <xs:element name="DoConfigureProviderDetails"> 
    149                 <xs:annotation> 
    150                         <xs:documentation>Change details for metadata provider N - includes OAI/CSW harvesting endpoints as well as provider N details</xs:documentation> 
    151                 </xs:annotation> 
    152                 <xs:complexType> 
    153                         <xs:sequence> 
    154                                 <xs:element name="ContactDetails" type="ProviderContactType" minOccurs="0"/> 
     205        <xs:element name="DoIngestReturn"> 
     206                <xs:annotation> 
     207                        <xs:documentation>Return confirmation on status of metadata ingest and relevant report</xs:documentation> 
     208                </xs:annotation> 
     209                <xs:complexType> 
     210                        <xs:sequence> 
     211                                <xs:element name="Confirmation" type="ConfirmationType"> 
     212                                        <xs:annotation> 
     213                                                <xs:documentation>Confirm that ingestion has been initiated.  Ingestion may take many tens of minutes so confirmation message will inform that selected email address in request will be emailed when ingest complete</xs:documentation> 
     214                                        </xs:annotation> 
     215                                </xs:element> 
     216                                <xs:element name="processID" type="ProcessIDType"/> 
    155217                        </xs:sequence> 
    156218                </xs:complexType> 
     
    159221                <xs:complexType> 
    160222                        <xs:sequence maxOccurs="unbounded"> 
    161                                 <xs:element name="ProcessID" type="ProcessIDType"/> 
     223                                <xs:element name="ProcessID" type="xs:int"/> 
     224                        </xs:sequence> 
     225                </xs:complexType> 
     226        </xs:element> 
     227        <xs:element name="GetProcessStatusResponse"> 
     228                <xs:complexType> 
     229                        <xs:sequence> 
     230                                <xs:element name="ProcessID" type="ProcessIDType" maxOccurs="unbounded"/> 
     231                                <xs:element name="Confirmation" type="ConfirmationType"/> 
    162232                        </xs:sequence> 
    163233                </xs:complexType> 
     
    166236                <xs:documentation>Basic service operation returns</xs:documentation> 
    167237        </xs:annotation> 
    168         <xs:element name="DoHarvestResponse"> 
    169                 <xs:annotation> 
    170                         <xs:documentation>Return confirmation on status of metadata harvest and relevant report</xs:documentation> 
    171                 </xs:annotation> 
    172                 <xs:complexType> 
    173                         <xs:sequence> 
    174                                 <xs:element name="Confirmation" type="ConfirmationType"/> 
    175                                 <xs:element name="processID" type="ProcessIDType"/> 
    176                         </xs:sequence> 
    177                 </xs:complexType> 
    178         </xs:element> 
    179         <xs:element name="DoIngestReturn"> 
    180                 <xs:annotation> 
    181                         <xs:documentation>Return confirmation on status of metadata ingest and relevant report</xs:documentation> 
    182                 </xs:annotation> 
    183                 <xs:complexType> 
    184                         <xs:sequence> 
    185                                 <xs:element name="Confirmation" type="ConfirmationType"> 
    186                                         <xs:annotation> 
    187                                                 <xs:documentation>Confirm that ingestion has been initiated.  Ingestion may take many tens of minutes so confirmation message will inform that selected email address in request will be emailed when ingest complete</xs:documentation> 
    188                                         </xs:annotation> 
    189                                 </xs:element> 
    190                                 <xs:element name="processID" type="ProcessIDType"/> 
    191                         </xs:sequence> 
    192                 </xs:complexType> 
    193         </xs:element> 
    194238        <xs:element name="GetHarvestHistoryReturn"> 
    195239                <xs:annotation> 
     
    244288                </xs:complexType> 
    245289        </xs:element> 
    246         <xs:complexType name="DoNewProviderDetailsReturn"> 
    247                 <xs:annotation> 
    248                         <xs:documentation>Confirmation of addition of NEW metadata provider details (super admin only)</xs:documentation> 
    249                 </xs:annotation> 
    250                 <xs:sequence> 
    251                         <xs:element name="Confirmation" type="ConfirmationType"/> 
    252                 </xs:sequence> 
    253         </xs:complexType> 
    254290        <xs:complexType name="GetProviderDetailsReturn"> 
    255291                <xs:annotation> 
     
    261297                </xs:sequence> 
    262298        </xs:complexType> 
    263         <xs:element name="DoConfigureProviderDetailsReturn"> 
    264                 <xs:annotation> 
    265                         <xs:documentation>Confirmation of update to Provider N's details</xs:documentation> 
    266                 </xs:annotation> 
    267                 <xs:complexType> 
    268                         <xs:sequence> 
    269                                 <xs:element name="Confirmation" type="ConfirmationType"/> 
    270                         </xs:sequence> 
    271                 </xs:complexType> 
    272         </xs:element> 
    273         <xs:element name="GetProcessStatusReturn"> 
    274                 <xs:complexType> 
    275                         <xs:sequence maxOccurs="unbounded"> 
    276                                 <xs:element name="ProcessID" type="ProcessIDType"/> 
    277                                 <xs:element name="processStatus" type="ProcessStatusIDType"/> 
    278                         </xs:sequence> 
    279                 </xs:complexType> 
    280         </xs:element> 
    281299        <xs:complexType name="GetListType"> 
    282300                <xs:sequence> 
     
    294312        <xs:complexType name="OAIProviderDetailsType"> 
    295313                <xs:sequence> 
    296                         <xs:element name="ProviderURL" type="xs:string"> 
    297                                 <xs:annotation> 
    298                                         <xs:documentation>URL of the Providers Metadata publisher i.e. OAI or CSW</xs:documentation> 
    299                                 </xs:annotation> 
    300                         </xs:element> 
    301                         <xs:element name="Format" type="xs:string"> 
    302                                 <xs:annotation> 
    303                                         <xs:documentation>Format name (getList)</xs:documentation> 
    304                                 </xs:annotation> 
    305                         </xs:element> 
    306314                        <xs:element name="SetSpec" type="xs:string" minOccurs="0"/> 
    307315                        <xs:element name="splitBySet" type="xs:boolean"/> 
     
    310318        <xs:complexType name="CSWProviderDetailsType"> 
    311319                <xs:sequence> 
    312                         <xs:element name="ProviderURL" type="xs:string"> 
    313                                 <xs:annotation> 
    314                                         <xs:documentation>URL of the Providers Metadata publisher i.e. OAI or CSW</xs:documentation> 
    315                                 </xs:annotation> 
    316                         </xs:element> 
    317320                        <xs:element name="Format" type="xs:string"> 
    318321                                <xs:annotation> 
     
    516519                        <xs:documentation>Unique ID to assign a process</xs:documentation> 
    517520                </xs:annotation> 
    518                 <xs:attribute name="id" type="xs:string" use="required"/> 
    519         </xs:complexType> 
    520         <xs:complexType name="ProcessStatusIDType"> 
    521                 <xs:attribute name="id" type="xs:string" use="required"/> 
     521                <xs:attribute name="id" type="xs:int" use="required"/> 
     522                <xs:attribute name="status" type="xs:string"/> 
    522523        </xs:complexType> 
    523524        <xs:element name="HarvestOperationType" type="HarvestType"> 
     
    545546                </xs:sequence> 
    546547        </xs:complexType> 
    547  
     548        <xs:complexType name="ProviderCommonType"> 
     549                <xs:sequence> 
     550                        <xs:element name="ProviderURL" type="xs:string"> 
     551                                <xs:annotation> 
     552                                        <xs:documentation>URL of the Providers Metadata publisher i.e. OAI or CSW</xs:documentation> 
     553                                </xs:annotation> 
     554                        </xs:element> 
     555                        <xs:element name="ProviderName" type="xs:string" minOccurs="0"> 
     556                                <xs:annotation> 
     557                                        <xs:documentation>Full provider name i.e. British Atmospheric Data Centre</xs:documentation> 
     558                                </xs:annotation> 
     559                        </xs:element> 
     560                        <xs:element name="ProviderContacts" type="EmailContactType" minOccurs="0" 
     561                                maxOccurs="unbounded"> 
     562                                <xs:annotation> 
     563                                        <xs:documentation>Email addresses of contacts at Data Provider</xs:documentation> 
     564                                </xs:annotation> 
     565                        </xs:element> 
     566                        <xs:element name="ProviderAdminEmail"> 
     567                                <xs:annotation> 
     568                                        <xs:documentation>Mandatory provider admin email</xs:documentation> 
     569                                </xs:annotation> 
     570                                <xs:complexType> 
     571                                        <xs:sequence> 
     572                                                <xs:element name="EmailContact" type="EmailContactType"/> 
     573                                                <xs:element name="Monitor" type="xs:boolean" minOccurs="0"> 
     574                                                        <xs:annotation> 
     575                                                                <xs:documentation>Set to true if all processes are to be reported via email to this main contact</xs:documentation> 
     576                                                        </xs:annotation> 
     577                                                </xs:element> 
     578                                        </xs:sequence> 
     579                                </xs:complexType> 
     580                        </xs:element> 
     581                </xs:sequence> 
     582        </xs:complexType> 
    548583</xs:schema> 
Note: See TracChangeset for help on using the changeset viewer.