getRegionalCompany

Provides detailed information about a regional company.

Client Servlet	Server Servlet	HTTP Methods Supported	Requires Authentication
None.	SRTeamraiserAPI	GET, POST	No.

Server API Syntax

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

Usage Notes

Updating large amounts of data can impact performance. Schedule large data updates during non-peak hours. Additionally, run the APIs one at a time.

This method requires that you provide the following parameter:

company_id

Server API Parameters

Common Server Parameters

See topic Common Parameters.

company_id

Optional. The id of the company.

Type xsd:nonNegativeInteger.

Response

See topic HTTP Status Codes.

XML response





<?xml version="1.0" encoding="UTF-8"?>
<getNationalCompanyResponse 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">
  <company>
    <orgId>1000</orgId>
    <publicName>sampleCompany</publicName>
    <companyFundraisingGoal>4000</companyFundraisingGoal>
    <classificationId>1</classificationId>
    <classification>Type 1</classification>
    <securityCategoryId>12</securityCategoryId>
    <companyCoordinatorGiftRecording>true</companyCoordinatorGiftRecording>
    <companyCoordinatorConsId>1000</companyCoordinatorConsId>
  </company>
</getNationalCompanyResponse>

JSON response

{"getRegionalCompanyResponse":{"company":{"companyCoordinatorGiftRecording":"true","fiscalYear":"1900","classificationId":"1","orgId":"1000","frIds":{"frId":["1000","2000"]},"companyFundraisingGoal":"4000","publicName":"sampleCompany","classification":"Type 1","companyCoordinatorConsId":"1000","securityCategoryId":"12"}}}

Examples

To retrieve regional company id 1000:

https://demo-secure.convio.net/demo829/site/SRTeamraiserAPI?api_key=api_key&v=1.0&method=getRegionalCompany&company_id=1000

Luminate Online