getLocalCompany

Provides detailed information about a local 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=getLocalCompany [ & company_id =value ]

Usage Notes

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"?>
<getLocalCompanyResponse 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>
    <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>
  </company>
</getLocalCompanyResponse>

JSON response

{"getLocalCompanyResponse":{"company":{"frId":"1000","volunteerManager":"Steve","companyParticipantGoal":"4000","orgId":"1000","companyTeamGoal":"4000","companyFundraisingGoal":"4000","internalStaffContact":"Bob","publicName":"sampleCompany","newToEvent":"true","executiveChampionConsId":"1001","companyCoordinatorConsId":"1000","notes":"Not a blank note","companyPriority":"Confirmed"}}}

Examples

To retrieve local company id 1000:

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

Luminate Online