Rest - Admin - ProgrammeFields - Revision history

Wikiadmin: /* Base URL */

2016-02-26T13:10:44Z

Base URL

← Older revision		Revision as of 13:10, 26 February 2016
Line 5:		Line 5:

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

	==Identify a programme field==		==Identify a programme field==

Wikiadmin at 12:07, 15 February 2013

2013-02-15T12:07:21Z

← Older revision		Revision as of 12:07, 15 February 2013
Line 79:		Line 79:
	</programmefield>		</programmefield>
	</programmefields>		</programmefields>

			== Supported Structures ==
			* Group
			* Staff
			* Volunteer
			* Person
			* SessionGroup
			* Session
			* Venue
			* Field
			* Media
			* PersonContact
			* CaseStudy

Wikiadmin at 10:24, 15 February 2013

2013-02-15T10:24:41Z

← Older revision		Revision as of 10:24, 15 February 2013
Line 1:		Line 1:
	==Purpose==		==Purpose==

	When interacting with Views accounts, it is sometimes necessary to identify ~~specific fields~~ that ~~belong to~~ a ~~common Programme~~. For example a Disability field. This can be achieved via this API		When interacting with Views accounts, it is sometimes necessary to identify a field that is derieved from a program, and implemented in all agencies within that program. For example a Disability field. This can be achieved via this API

Wikiadmin: moved Rest - Admin - ProgrameFields to Rest - Admin - ProgrammeFields

2013-02-15T10:21:26Z

moved Rest - Admin - ProgrameFields to Rest - Admin - ProgrammeFields

← Older revision	Revision as of 10:21, 15 February 2013
(No difference)

Wikiadmin at 10:19, 15 February 2013

2013-02-15T10:19:35Z

← Older revision		Revision as of 10:19, 15 February 2013
Line 6:		Line 6:
	===Base URL===		===Base URL===
	http://app.views.coop/api/restful/admin/programmefields		http://app.views.coop/api/restful/admin/programmefields

			==Identify a programme field==

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

			This will return a list of programme fields for the given field, for the programmes that the agency is associated with in the following format:
			<?xml version="1.0" encoding="utf-8"?>
			<programmefields>
			<programmefield progid="18" sourceid="21">
			<id>51</id>
			<SourceID>21</SourceID>
			<fieldName>Disability_P_51</fieldName>
			<fieldLoc>f</fieldLoc>
			<fieldType>text</fieldType>
			<inputType>select
			</inputType>
			<validation>
			</validation>
			<valueListID>140</valueListID>
			<tagline></tagline>
			<category>Demographic</category>
			<displayName>Disability</displayName>
			<flags>255</flags>
			<enabled>1</enabled>
			<value></value>
			</programmefield>
			<programmefield progid="19" sourceid="40">
			<id>80</id>
			<SourceID>40</SourceID>
			<fieldName>Disability_P_80</fieldName>
			<fieldLoc>f</fieldLoc>
			<fieldType>text</fieldType>
			<inputType>select</inputType>
			<validation></validation>
			<valueListID>154</valueListID>
			<tagline></tagline>
			<category>Demographic</category>
			<displayName>Disability</displayName>
			<flags>993</flags>
			<enabled>1</enabled>
			<value></value>
			</programmefield>
			</programmefields>

			This shows there are 2 Disability fields, one for each Programme.

			==Identify a programme field for a specific programme==

			If you are only interested in knowing what a field is for a given programme, then you should use the following:
			curl --url <Base URL>/<structure>/<fieldname>/<ProgID> -u<username>:<password> -H Content-Type:text/xml -X POST -d "<xml>"

			Which will return:
			<?xml version="1.0" encoding="utf-8"?>
			<programmefields>
			<programmefield progid="18" sourceid="21">
			<id>51</id>
			<SourceID>21</SourceID>
			<fieldName>Disability_P_51</fieldName>
			<fieldLoc>f</fieldLoc>
			<fieldType>text</fieldType>
			<inputType>select
			</inputType>
			<validation>
			</validation>
			<valueListID>140</valueListID>
			<tagline></tagline>
			<category>Demographic</category>
			<displayName>Disability</displayName>
			<flags>255</flags>
			<enabled>1</enabled>
			<value></value>
			</programmefield>
			</programmefields>

Wikiadmin: Created page with "==Purpose== When interacting with Views accounts, it is sometimes necessary to identify specific fields that belong to a common Programme. For example a Disability field. Thi..."

2013-02-15T09:59:59Z

Created page with "==Purpose== When interacting with Views accounts, it is sometimes necessary to identify specific fields that belong to a common Programme. For example a Disability field. Thi..."

New page

==Purpose==

When interacting with Views accounts, it is sometimes necessary to identify specific fields that belong to a common Programme. For example a Disability field. This can be achieved via this API

===Base URL===
http://app.views.coop/api/restful/admin/programmefields