Client API Parameters

Common Client Parameters

See topic Common Parameters.

fr_id

Required. The TeamRaiser event ID.

Type xsd:nonNegativeInteger.

include_all_companies

Optional. Specifies whether local companies that are not available for team selection should be included in the response.

Type xsd:boolean.

Response

See topic HTTP Status Codes.

<?xml version="1.0" encoding="UTF-8"?>
<getCompanyListResponse xsi:schemaLocation="http://convio.com/crm/v1.0 http://service.convio.net/xmlschema/crm.public.v1.xsd" xmlns="http://convio.com/crm/v1.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <companyItem>
    <companyName>childless root</companyName>
    <companyId>1004</companyId>
    <organizationId>1</organizationId>
    <parentOrgEventId>0</parentOrgEventId>
    <amountRaised>10000000</amountRaised>
  </companyItem>
  <companyItem>
    <companyName>root with children</companyName>
    <companyId>1003</companyId>
    <organizationId>2</organizationId>
    <parentOrgEventId>0</parentOrgEventId>
    <amountRaised>20000000</amountRaised>
  </companyItem>
  <companyItem>
    <companyName>included link</companyName>
    <companyId>1002</companyId>
    <organizationId>3</organizationId>
    <parentOrgEventId>1003</parentOrgEventId>
    <amountRaised>1000000</amountRaised>
  </companyItem>
  <companyItem>
    <companyName>child org 2</companyName>
    <companyId>1001</companyId>
    <organizationId>6</organizationId>
    <parentOrgEventId>1002</parentOrgEventId>
    <amountRaised>200000</amountRaised>
  </companyItem>
  <companyItem>
    <companyName>child org 1</companyName>
    <companyId>1000</companyId>
    <organizationId>5</organizationId>
    <parentOrgEventId>1003</parentOrgEventId>
    <amountRaised>100000</amountRaised>
  </companyItem>
</getCompanyListResponse>



        

{"getCompanyListResponse":{"companyItem":[{"companyId":"0","companyName":"example_company0"},{"companyId":"1","companyName":"example_company1"}]}}