Difference between revisions of "GOCDB/PI/get site contacts method"
Jump to navigation
Jump to search
(12 intermediate revisions by 3 users not shown) | |||
Line 7: | Line 7: | ||
{| {{egi-table}} | {| {{egi-table}} | ||
|- | |- | ||
| '''Description''' || Returns a list of | | '''Description''' || Returns a list of sites nesting contacts having a site leve role (if any), grouped per site | ||
|- | |- | ||
| '''Protection Level''' || Protected (level 2) | | '''Protection Level''' || Protected (level 2) | ||
Line 28: | Line 28: | ||
| country || Limit results to sites belonging to given country || any country || all || ?method=get_site_contacts&country=Poland | | country || Limit results to sites belonging to given country || any country || all || ?method=get_site_contacts&country=Poland | ||
|- | |- | ||
| roletype || | | roletype || Only include CONTACTS with the given role || any valid role type || all || ?method=get_site_contacts&roletype=Site Security Officer | ||
|- | |||
| scope || Show only sites with the requested scope-tags - a list of currently supported scope tags can be found [https://goc.egi.eu/portal/index.php?Page_Type=Scope_Help here] || A comma separated list of scope-tag values or an empty value to return all scopes, i.e. '&scope=' || EGI|| ?method=get_site_contacts&scope=Local | |||
|- | |||
| scope_match | |||
| Match 'all' or 'any' of the specified scope-tags | |||
| 'all' or 'any' | |||
| all | |||
| ?method=get_site_contacts&scope=Local,EGI&scope_match=any | |||
|- | |||
| Docs for cursor params coming soon. | |||
| Limit results and use cursor paging to iterate over all results | |||
| [https://wiki.egi.eu/wiki/GOCDB/notifications#Optional_Cursor_Paging_on_Read_API See here for info] | |||
| | |||
| | |||
|- | |- | ||
|} | |} | ||
<!--- Removed from V5 | |||
=== XML schema === | === XML schema === | ||
https://goc.egi.eu/gocdbpi_v4/private/?method=get_site_contacts&output=xmlschema | https://goc.egi.eu/gocdbpi_v4/private/?method=get_site_contacts&output=xmlschema | ||
--> | |||
=== Output Example === | === Output Example === | ||
<Source Lang="XML"> | |||
<?xml version="1.0"?> | <?xml version="1.0"?> | ||
<results> | <results> | ||
Line 58: | Line 73: | ||
</SITE> | </SITE> | ||
</results> | </results> | ||
</Source> | |||
[[GOCDB/PI/Technical_Documentation|Back to GOCDB technical Documentation main page]] | [[GOCDB/PI/Technical_Documentation|Back to GOCDB technical Documentation main page]] |
Latest revision as of 15:17, 16 December 2016
Main | EGI.eu operations services | Support | Documentation | Tools | Activities | Performance | Technology | Catch-all Services | Resource Allocation | Security |
GOC DB menu: | Home • | Documentation Index • |
Method: get_site_contacts
Description | Returns a list of sites nesting contacts having a site leve role (if any), grouped per site |
Protection Level | Protected (level 2) |
Entry point
- https://goc.egi.eu/gocdbpi/private/?method=get_site_contacts
- https://goc.egi.eu/gocdbpi_v4/private/?method=get_site_contacts (alias)
parameters
parameter | effect | format/value(s) | default | example |
---|---|---|---|---|
sitename | Only return infos for site with specified site name | any sitename | all | ?method=get_site_contacts&sitename=RAL-LCG2 |
roc (ngi) | Limit results to sites belonging to given NGI | any NGI name | all | ?method=get_site_contacts&roc=NGI_DE |
country | Limit results to sites belonging to given country | any country | all | ?method=get_site_contacts&country=Poland |
roletype | Only include CONTACTS with the given role | any valid role type | all | ?method=get_site_contacts&roletype=Site Security Officer |
scope | Show only sites with the requested scope-tags - a list of currently supported scope tags can be found here | A comma separated list of scope-tag values or an empty value to return all scopes, i.e. '&scope=' | EGI | ?method=get_site_contacts&scope=Local |
scope_match | Match 'all' or 'any' of the specified scope-tags | 'all' or 'any' | all | ?method=get_site_contacts&scope=Local,EGI&scope_match=any |
Docs for cursor params coming soon. | Limit results and use cursor paging to iterate over all results | See here for info |
Output Example
<?xml version="1.0"?>
<results>
<SITE ID="405005" PRIMARY_KEY="123G0" NAME="GRIDOPS-GOCDB">
<PRIMARY_KEY>123G0</PRIMARY_KEY>
<SHORT_NAME>GRIDOPS-GOCDB</SHORT_NAME>
<CONTACT USER_ID="185" PRIMARY_KEY="6215G0">
<FORENAME>Gilles</FORENAME>
<SURNAME>Mathieu</SURNAME>
<TITLE>Mr</TITLE>
<DESCRIPTION>GOCDB administrator</DESCRIPTION>
<EMAIL>snip</EMAIL>
<TEL>+44 (0) 1235446340</TEL>
<WORKING_HOURS_START>08:00</WORKING_HOURS_START>
<WORKING_HOURS_END>17:00</WORKING_HOURS_END>
<CERTDN>snip</CERTDN>
<ROLE_NAME>Site Administrator</ROLE_NAME>
</CONTACT>
</SITE>
</results>