addLocalCompany

Creates a new local company tied to an organization and an event.

Client ServletServer ServletHTTP Methods SupportedRequires Authentication
None. SRTeamraiserAPI POST No.

Server API Syntax

https://secure2.convio.net/organization/site/SRTeamraiserAPI?method=addLocalCompany & 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 ] & fr_id =value & org_id =value & company_name =value [ & company_fundraising_goal =value ] [ & company_coordinator_cons_id =value ] & fr_id =value [ & notes =value ] [ & is_sponsor_only =true |false]  [ & company_team_goal =value ] [ & company_participant_goal =value ] [ & company_priority =value ] [ & new_to_event =true |false ] [ & custom_company_detail_1 =value ] [ & custom_company_detail_2 =value ] [ & internal_staff_contact =value ] [ & volunteer_manager =value ] [ & participation_status =PROSPECT |CONFIRMED ] [ & executive_champion_cons_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.

Server API Parameters

Common Server Parameters

See topic Common Parameters.

fr_id

Required. The TeamRaiser event ID.

Type xsd:nonNegativeInteger.

org_id

Required. Org ID

Type xsd:int.

company_name

Required. The public name of the company.

Type xsd:string.

company_fundraising_goal

Optional. The company's fundraising goal

Type xsd:nonNegativeInteger.

company_coordinator_cons_id

Optional. The constituent ID of the company coordinator

Type xsd:nonNegativeInteger.

is_sponsor_only

Optional. The company is a sponsorship company only and will not be associated directly with teams. Default is false.

Type xsd:boolean.

notes

Optional. Notes about the company

Type xsd:string.

company_team_goal

Optional. The company's goal for number of teams

Type xsd:nonNegativeInteger.

company_participant_goal

Optional. The company's goal for number of participants

Type xsd:nonNegativeInteger.

company_priority

Optional. The company's priority used for sorting in reporting

Type xsd:string.

new_to_event

Optional. Whether the company is new to this type of event

Type xsd:boolean.

Options are:
  • true
  • false
custom_company_detail_1

Optional. A custom field for the company

Type xsd:string.

custom_company_detail_2

Optional. A custom field for the company

Type xsd:string.

internal_staff_contact

Optional. The name of the internal staff contact for the company

Type xsd:string.

volunteer_manager

Optional. The name of the company's volunteer manager

Type xsd:string.

participation_status

Optional. The participation status of the compnay (PROSPECT or CONFIRMED)

Type xsd:string.

Options are:
  • PROSPECT
  • CONFIRMED
executive_champion_cons_id

Optional. The constituent ID of the executive champion

Type xsd:nonNegativeInteger.

Response

See topic HTTP Status Codes.

XML response 


  1000
JSON response 
{"addLocalCompanyResponse":{"companyId":"1000"}}

Examples

Note: Escape or enclose code in a CDATA block -->
Parent topic: TeamRaiser API
Previous topic: addGift
Next topic: addNationalCompany

Leave a Comment

Nickname
Comment
Enter this word:
Change