REST

getLocalCompany

Provides detailed information about a local company.

Client ServletServer ServletHTTP Methods SupportedRequires Authentication
None.SRTeamraiserAPIGET, POSTNo.

Server API Syntax

https://secure2.convio.net/organization/site/SRTeamraiserAPI?method=getLocalCompany &company_id=value

Server API Parameters

Common Server Parameters

See topic Common Parameters.

company_id

Required. The id of the company.

Type xsd:nonNegativeInteger.

Response

See topic HTTP Status Codes.

XML response
<?xml version="1.0" encoding="UTF-8"?>
<getLocalCompanyResponse
      xsi:schemaLocation="http://convio.com/crm/v1.0 http://service.convio.net/xmlschema/crm.public.teamraiser.v1.xsd"
      xmlns="http://convio.com/crm/v1.0"
      xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <company>
          <frId>1000</frId>
          <orgId>1000</orgId>
          <publicName>sampleCompany</publicName>
          <notes>Not a blank note</notes>
          <companyFundraisingGoal>4000</companyFundraisingGoal>
          <companyTeamGoal>4000</companyTeamGoal>
          <companyParticipantGoal>4000</companyParticipantGoal>
          <companyPriority>Confirmed</companyPriority>
          <newToEvent>true</newToEvent>
          <internalStaffContact>Bob</internalStaffContact>
          <volunteerManager>Steve</volunteerManager>
          <companyCoordinatorConsId>1000</companyCoordinatorConsId>
          <executiveChampionConsId>1001</executiveChampionConsId>
          <isSponsorOnly>false</isSponsorOnly>
  </company>
</getLocalCompanyResponse>
JSON response
JSON
{"getLocalCompanyResponse":{
        "company":{
          "executiveChampionConsId":"1001",
          "notes":"Not a blank note",
          "internalStaffContact":"Bob",
          "volunteerManager":"Steve",
          "newToEvent":"true",
          "companyParticipantGoal":"4000",
          "orgId":"1000",
          "companyFundraisingGoal":"4000",
          "publicName":"sampleCompany",
          "frId":"1000",
          "companyTeamGoal":"4000",
          "companyPriority":"Confirmed",
          "companyCoordinatorConsId":"1000",
          "isSponsorOnly":"false"
        }
      }}