Response API

Response API

Response form

  • This method is send only (HTTP/1.1 POST)
  • Submit basic HTML forms to the Yes-co Open API response form handler
  • Standard forms are available through the Yes-co Open App Market
  • Forms arrive at the ‘Contact Center’ and can be viewed, processed and removed by the user
  • When processed, a form creates a new ‘relation’ object
  • Any HTTP post data is accepted, any errors occuring during routing/processing is handled by the Yes-co Open API

URL: http://api.yes-co.com/1.0/response/submit/v1

Authentication

Not required.

Arguments

yesco_key (required)
Yes-co system identifier. Retrieve this key from the Response App ‘Settings’ page in the App Market.
thank_you_page:
Usage of this argument is highly recommended!
The browser is redirected to this page after the form data has been received. By default, the browser is redirected back to the form (HTTP_REFERER)
source
Inbox message sender, defaults to ‘Website’
title
Inbox message title, e.g.: ‘Inschrijving woningzoekende’
actions
Optional argument to distinguish different form types, e.g.: ‘Aanmelding ge├»nteresseerde’, ‘Brochure aanvraag’, …
When a form is processed, a new ‘relation’ object is created in Yes-co Open. The values of these arguments are copied to the properties of the new relation object.
person_tags
When set, the value(-s) are added as ‘tags’ to the new relation.
project_id
When set, the form appears in the dossier of the specified project when processed
project_tags
When set, the value(-s) are added as ‘tags’ to the project. This is only effective in combination with the project_id argument.
project_role
When set, the relation that is created is linked to the project, with the specified role. This is only effective in combination with the project_id argument. Valid roles are:
developer_mode
Set to ’1′ to get the diagnostic result page as a response. The default response is a HTTP redirect (303) to the ‘thank_you_page’.
comments
Optional argument to include extra comments, which is added to the message contents
person[lastname]
person[firstname]
person[email]
person[phone]
person[city]
person[street]
person[housenumber]
person[zipcode]

Example response

During normal operation, a HTTP redirect (303) and a empty response is send back to the browser.

In developer mode, a HTML page with some diagnostic info is returned instead:


Redirect

After submit the page will be redirected to http://www.yes-co.nl
Form data

source:
referer: http://yispro-api.devel.redbus.yes-co.nl/test/embed/response-forms.html
actions: Bezichtiging aanvragen, Brochure aanvragen
comments: 's avonds na 18:00 bereikbaar
Project

project_id: 1
project_tags: test
Person

relation_tags: via website, nieuwsbrief
relation_project_role: geinteresseerde
person[firstname]: Jan
person[lastname]: Janssen
person[email]: jjansen@hotmail.com
person[phone]: 0123456789
person[city]: AMSTERDAM
person[street]: Kalverstraat
person[zipcode]: 1012 NX
person[housenumber]: 1

Error Codes

none

This page is a Wiki! Log in or register an account to edit.

Plaats een bericht