Rest - Work - Venues - Revision history

Wikiadmin: /* Purpose */

2016-02-26T13:03:59Z

Purpose

← Older revision		Revision as of 13:03, 26 February 2016
Line 4:		Line 4:

	===Base URL===		===Base URL===
	~~http~~://app.~~views~~.~~coop~~/api/restful/work/venues		https://app.viewsapp.net/api/restful/work/venues

	===Schema===		===Schema===
	<nowiki>~~http~~://app.~~views~~.~~coop~~/api/restful/work/venues/schema(.xml\|.json\|.xsd)</nowiki>		<nowiki>https://app.viewsapp.net/api/restful/work/venues/schema(.xml\|.json\|.xsd)</nowiki>

	==Creating a venues==		==Creating a venues==

Wikiadmin: /* Archiving a venues */

2014-01-30T16:36:13Z

Archiving a venues

← Older revision		Revision as of 16:36, 30 January 2014
Line 41:		Line 41:

	==Archiving a venues==		==Archiving a venues==
	curl --url <Base URL>/<id> -u<username>:<password> -H Content-Type:text/xml -X PUT -d '<status>1</status>'		curl --url <Base URL>/<id>/archive -u<username>:<password> -H Content-Type:text/xml -X PUT -d '<status>1</status>'
	* id - The ID of the venues		* id - The ID of the venues

	This will set the archive flag on a venues. If you set the status to 0, then it will remove the archive flag.		This will set the archive flag on a venues. If you set the status to 0, then it will remove the archive flag.


	==Deleting a venues==		==Deleting a venues==

Wikiadmin: /* Schema */

2012-07-18T08:25:40Z

Schema

← Older revision		Revision as of 08:25, 18 July 2012
Line 7:		Line 7:

	===Schema===		===Schema===
	<nowiki>http://app.views.coop/api/restful/~~contacts~~/venues/schema(.xml\|.json\|.xsd)</nowiki>		<nowiki>http://app.views.coop/api/restful/work/venues/schema(.xml\|.json\|.xsd)</nowiki>

	==Creating a venues==		==Creating a venues==

Wikiadmin at 14:27, 9 July 2012

2012-07-09T14:27:59Z

← Older revision		Revision as of 14:27, 9 July 2012
Line 5:		Line 5:
	===Base URL===		===Base URL===
	http://app.views.coop/api/restful/work/venues		http://app.views.coop/api/restful/work/venues

			===Schema===
			<nowiki>http://app.views.coop/api/restful/contacts/venues/schema(.xml\|.json\|.xsd)</nowiki>

	==Creating a venues==		==Creating a venues==

	~~''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/contacts/venues/schema''(.xml\|.json\|.xsd)''~~

	Once you have created your data file, you can send it using the following:		Once you have created your data file, you can send it using the following:
Line 26:		Line 25:
	curl --url <Base URL>/search?q=<query> -u<username>:<password> -H Content-Type:text/xml		curl --url <Base URL>/search?q=<query> -u<username>:<password> -H Content-Type:text/xml
	* query - This is a text string to use to search for in the venues records		* query - This is a text string to use to search for in the venues records

			You can search for any field for a specific value by setting the field as a parameter. Please refer to the schema for field names.

			There are also a series of fields that you use -from and -to modifiers to express a range:
			* Created - yyyy-mm-dd
			* Updated - yyyy-mm-dd
			* Archived - yyyy-mm-dd


	==Updating a venues==		==Updating a venues==

Wikiadmin: /* Deleting a venues */

2012-04-26T15:53:58Z

Deleting a venues

← Older revision		Revision as of 15:53, 26 April 2012
Line 44:		Line 44:
	* id - The ID of the venues		* id - The ID of the venues

	This should be used with great care as it will permenently ~~delet~~ a venues record.		This should be used with great care as it will permenently delete a venues record.

Wikiadmin at 15:52, 26 April 2012

2012-04-26T15:52:09Z

← Older revision		Revision as of 15:52, 26 April 2012
Line 10:		Line 10:
	''As with all our services, the data structure can vary from account to account, depending how you have configured your system.		''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:		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/contacts/venues/schema''''(.xml\|.json\|.xsd)''		http://app.views.coop/api/restful/contacts/venues/schema''(.xml\|.json\|.xsd)''

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

Wikiadmin: Created page with "==Purpose== Used for creating, editing and deleting Venues from the Views system. ===Base URL=== http://app.views.coop/api/restful/work/venues ==Creating a venues== ''As w..."

2012-04-26T15:48:12Z

Created page with "==Purpose== Used for creating, editing and deleting Venues from the Views system. ===Base URL=== http://app.views.coop/api/restful/work/venues ==Creating a venues== ''As w..."

New page

==Purpose==

Used for creating, editing and deleting Venues from the Views system.

===Base URL===
http://app.views.coop/api/restful/work/venues

==Creating a venues==

''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/contacts/venues/schema''''(.xml|.json|.xsd)''

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 venue==
curl --url <Base URL>/<id> -u<username>:<password> -H Content-Type:text/xml

==Searching for a venues==
curl --url <Base URL>/search?q=<query> -u<username>:<password> -H Content-Type:text/xml
* query - This is a text string to use to search for in the venues records

==Updating a venues==
curl --url <Base URL>/<id> -u<username>:<password> -H Content-Type:text/xml -X PUT -d "<xml>"
* id - The ID of the venues

The XML should be in the same format as the create XML.

==Archiving a venues==
curl --url <Base URL>/<id> -u<username>:<password> -H Content-Type:text/xml -X PUT -d '<status>1</status>'
* id - The ID of the venues

This will set the archive flag on a venues. If you set the status to 0, then it will remove the archive flag.

==Deleting a venues==
curl --url <Base URL>/<id> -u<username>:<password> -H Content-Type:text/xml -X DELETE
* id - The ID of the venues

This should be used with great care as it will permenently delet a venues record.