API Library

getOrganizationHierarchy

Returns an organization's hierarchy by ID

Client ServletServer ServletHTTP Methods SupportedRequires Authentication
None.SROrganizationAPIPOSTYes.

Server API Syntax

https://secure2.convio.net/organization/site/SROrganizationAPI?method=getOrganizationHierarchy & api_key =value & login_name =value & login_password =value & v =value [ & center_id =value ] [ & response_format =xml |json ] [ & source =value ] [ & sub_source =value ] [ & suppress_response_codes =value ] & org_id =value

Server API Parameters

Common Server Parameters

See topic Common Parameters.

org_id

Required. Org ID

Type xsd:int.

Response

See topic HTTP Status Codes.

XML response
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<getOrganizationHierarchyResponse xmlns="http://convio.com/crm/v1.0">
  <hierarchy>
    <org_id>300</org_id>
    <name>First organization</name>
    <parent_org_id>250</parent_org_id>
    <descendant>
      <org_id>302</org_id>
      <name>Second organization</name>
      <parent_org_id>300</parent_org_id>
    </descendant>
  </hierarchy>
</getOrganizationHierarchyResponse>
JSON response
JSON
{"getOrganizationHierarchyResponse":{"hierarchy":{"org_id":"300","name":"First organization","descendant":{"org_id":"302","name":"Second organization","parent_org_id":"300"},"parent_org_id":"250"}}}