getTeamraiserResultsData

Returns the results from a teamraiser create or update API call.

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

Client API Syntax

https://secure2.convio.net/organization/site/CRTeamraiserAPI?method=getTeamraiserResultsData &api_key=value &v=value [ &center_id=value ] [ &error_redirect=value ] [ &redirect=value ] [ &response_format=xml | json ] [ &sign_redirects=value ] [ &source=value ] [ &sub_source=value ] [ &success_redirect=value ] [ &suppress_response_codes=value ] &job_id=value

Server API Syntax

https://secure2.convio.net/organization/site/SRTeamraiserAPI?method=getTeamraiserResultsData & 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 ] & job_id =value

Usage Notes

Given the Job ID returned by either of the TeamRaiser Data methods: addTeamraiserData or updateTeamraiserData , this method returns the status of the batch operation if it is still processing, or the results if it is complete.

Client API Parameters

Common Client Parameters

See topic Common Parameters.

job_id

Required. A job ID returned by the addTeamraiserData or updateTeamraiserData method

Type xsd:integer.

Server API Parameters

Common Server Parameters

See topic Common Parameters.

job_id

Required. A job ID returned by the addTeamraiserData or updateTeamraiserData method

Type xsd:integer.

Response

See topic HTTP Status Codes.

XML response
<?xml version="1.0" encoding="UTF-8"?>
<getTeamraiserCreateUpdateResponse jobId="123245456" 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">
  <jobResult Id="0">
    <success>false</success>
    <eventTitle>Test Event</eventTitle>
    <errors>
      <createUpdateError>
        <error>Warning: tried to update locked field (LocalOfficeAttn)</error>
        <errorLevel>Warning</errorLevel>
      </createUpdateError>
      <createUpdateError>
        <error>Interest Category not found</error>
        <errorLevel>Error</errorLevel>
      </createUpdateError>
    </errors>
  </jobResult>
  <jobResult Id="1">
    <success>true</success>
    <eventTitle>Test Event 2</eventTitle>
    <frId>1000</frId>
  </jobResult>
</getTeamraiserCreateUpdateResponse>

        
JSON response
{"getTeamraiserCreateUpdateResponse":{"jobId":"123245456","jobResult":[{"errors":{"createUpdateError":[{"error":"Warning: tried to update locked field (LocalOfficeAttn)","errorLevel":"Warning"},{"error":"Interest Category not found","errorLevel":"Error"}]},"eventTitle":"Test Event","Id":"0","success":"false"},{"frId":"1000","eventTitle":"Test Event 2","Id":"1","success":"true"}]}}

        

Leave a Comment

Nickname
Comment
Enter this word: