Developers

Msgme APIs

Subscriptions API

get_custom_fields

URL:

http://api.msgme.com/v1/subscriptions/get_custom_fields

METHOD:

Get

DESCRIPTION:

If a keyword has custom fields defined then this method will retrieve them.

PARAMETERS:

Parameter	Description
token	The security token that was returned using authentication_api method.
keywordId	The keyword that this custom field belongs to.

API REQUEST:

http://api.msgme.com/v1/subscriptions/get_custom_fields?token=[Authenticated token]&keywordId=[Msgme keyword ID]

API RESPONSE:

		<?xml version="1.0" encoding="UTF-8"?>
		<apiResponse status="[status text]" statusCode="[status code]">
			<fields>
				<field
					name="[field name]"
					description="[field description]"
					fieldId="[field ID]"
					keywordId="[keyword ID]"
					type="[text|int|bool]" 
					length="[field length]" 
					created="[YYYYMMDD]" 
					updated="[YYYYMMDD]"
					defaultValue="[default value]">
					<validInputs>[valid values]</validInputs>
					...
				</field>
					...
			</fields>
		</apiResponse>

EXAMPLE USAGE:

REQUEST:

GET http://api.msgme.com/v1/subscriptions/get_custom_fields?token= 0e9ace1582fbb754dfe7f4e11f572bf5273f3c69&keywordId=19879

RESPONSE:

		<?xml version="1.0" encoding="UTF-8"?>
			<apiResponse status="[status text]" statusCode="[status code]">
			<fields>
				<field
					name="mascot"
					description="Team mascot"
					fieldId="1765"
					keywordId="19879" 
					type="text" 
					length="32" 
					created="2008-10-12"
					updated="2008-10-12"
					defaultValue="">
				</field>
				<validInputs>bears</validInputs>
				<validInputs>aggies</validInputs>
			</fields>
		</apiResponse>