Rest - Contacts - Participants

From Views API Documentation
Revision as of 11:28, 10 April 2012 by Wikiadmin (talk | contribs) (Created page with "==Purpose== TUsed for creating, editing and deleting Participants from the Views system. ===Base URL=== http://app.views.coop/api/restful/contact/participants ==Creating a ...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

Purpose

TUsed for creating, editing and deleting Participants from the Views system.

Base URL

http://app.views.coop/api/restful/contact/participants

Creating a participant

As with all our services, the data structure can vary from account to account, depending how you have configured your system. To get the expected schema for the data you need to supply, you should download the schema information from: http://app.views.coop/api/restful/contact/participants/schema

Once you have created your data file, you can send it using the following:

curl --url <Base URL> -u<username>:<password> -H Content-Type:text/xml -X POST -d "<xml>"

If there is a problem with creating that record, you will get a response containing all the errors, plus a copy of the translated data you supplied.

If the record was created successfully, the service will return a complete reocrd for the newly created record if the attribute id set as the newly created id.

Fetching a partcipant

curl --url <Base URL>/<id> -u<username>:<password> -H Content-Type:text/xml -X POST -d "<xml>"