Difference between revisions of "GOCDB/PI/get ngi"

From EGIWiki
< GOCDB‎ | PI
Jump to: navigation, search
(parameters)
(parameters)
 
(6 intermediate revisions by 3 users not shown)
Line 4: Line 4:
 
[[Category:GOCDB]]
 
[[Category:GOCDB]]
  
== Method: get_ngi - GOCDB4  ==
+
== Method: get_ngi ==
  
 
{|
 
{|
Line 20: Line 20:
  
 
=== parameters  ===
 
=== parameters  ===
{| border="1"
+
{| {{egi-table}}
 
|-
 
|-
 
! parameter  
 
! parameter  
Line 33: Line 33:
 
| all  
 
| all  
 
| &nbsp;?method=get_ngi&roc=NGI_UK
 
| &nbsp;?method=get_ngi&roc=NGI_UK
 +
|-
 +
| 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. '&amp;scope='
 +
| EGI
 +
| &nbsp;?method=get_ngi&amp;scope=Local
 +
|-
 +
| scope_match
 +
| Match 'all' or 'any' of the specified scope-tags
 +
| 'all' or 'any'
 +
| all
 +
| &nbsp;?method=get_ngi&amp;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]
 +
|
 +
|
 +
|-
 
|}
 
|}
  
 
=== Output Example  ===
 
=== Output Example  ===
 
+
<Source Lang="XML">
<span class="pi"><xml version="1.0" encoding="UTF-8"?>
+
<?xml version="1.0" encoding="UTF-8"?>
<results>
+
<results>
  <NGI PRIMARY_KEY="952G0" NAME="AsiaPacific">
+
  <NGI NAME="NGI_UK">
      <PRIMARY_KEY>952G0</PRIMARY_KEY>
+
    <PRIMARY_KEY>35</PRIMARY_KEY>
      <NAME>AsiaPacific</NAME>
+
    <NAME>NGI_UK</NAME>
      <OBJECT_ID>952</OBJECT_ID>
+
    <OBJECT_ID>35</OBJECT_ID>
      <DESCRIPTION>test</DESCRIPTION>
+
    <DESCRIPTION>United Kingdon NGI</DESCRIPTION>
      <EMAIL>roc@lists.grid.sinica.edu.tw</EMAIL>
+
    <EMAIL>UKNGI-OPERATIONS@jiscmail.ac.uk</EMAIL>
      <GGUS_SU/>
+
    <GGUS_SU>NGI_UK</GGUS_SU>
      <ROD_EMAIL/>
+
    <ROD_EMAIL>uki-grid-ops@cern.ch</ROD_EMAIL>
      <HELPDESK_EMAIL>test@hithere.com</HELPDESK_EMAIL>
+
    <HELPDESK_EMAIL/>
      <SECURITY_EMAIL/>
+
    <SECURITY_EMAIL>ukngi-security@cern.ch</SECURITY_EMAIL>
      <SITE_COUNT>65</SITE_COUNT>
+
    <SITE_COUNT>58</SITE_COUNT>
  </NGI></span>
+
    <SCOPES>
 +
      <SCOPE>EGI</SCOPE>
 +
    </SCOPES>
 +
  </NGI>
 +
</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:27, 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_ngi

Description Returns a list of NGIs with contact information
Protection Level Protected (level 2)

Entry point

parameters

parameter effect format/value(s) default example
roc (ngi) Specify NGI name any NGI name all  ?method=get_ngi&roc=NGI_UK
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_ngi&scope=Local
scope_match Match 'all' or 'any' of the specified scope-tags 'all' or 'any' all  ?method=get_ngi&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" encoding="UTF-8"?>
<results>
  <NGI NAME="NGI_UK">
    <PRIMARY_KEY>35</PRIMARY_KEY>
    <NAME>NGI_UK</NAME>
    <OBJECT_ID>35</OBJECT_ID>
    <DESCRIPTION>United Kingdon NGI</DESCRIPTION>
    <EMAIL>UKNGI-OPERATIONS@jiscmail.ac.uk</EMAIL>
    <GGUS_SU>NGI_UK</GGUS_SU>
    <ROD_EMAIL>uki-grid-ops@cern.ch</ROD_EMAIL>
    <HELPDESK_EMAIL/>
    <SECURITY_EMAIL>ukngi-security@cern.ch</SECURITY_EMAIL>
    <SITE_COUNT>58</SITE_COUNT>
    <SCOPES>
      <SCOPE>EGI</SCOPE>
    </SCOPES>
  </NGI>
</results>

Back to GOCDB technical Documentation main page