Table of Contents

RESTful API

Label Detail

Overview

Retrieves the detailed information of a label.

URL

Parameters on the following URL are inside braces { } 

{base_url}/rest/api/getLabelDetail/{instanceId}/{mimId}/{labelId}/{userName}/{publicKey}/{signature}
Parameter Name Description
instanceId An instance id is the workspace identification number, if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
mimId The campaign id, you could retrieve this information from the campaign manager UI or using the List Campaigns
labelId The label ID to search
userName The user name who owns the campaign
publicKey The public key to access this API. if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
signature The unique SHA256 signature for this call, it's involve all input parameters. To learn about generating the correct signature please visit our Java Example

Response

The Response XML is divided in a static part and a dynamic one, we call it dynamic because it will vary depending on the method you invoke. Please read our Response XML Basics section if you want to learn more about the response parts. 

<input>getLabelDetail</input>
<status>OK</status>
<description>Completed</description>
<result>
	<label>
		<index>0</index>
		<name>label1</name>
		<keyword>word1</keyword>
		<response>response1</response>
	</label>
</result>
Result parameters
Parameter Name Description Possible Values
label.index Label ID Number
label.name Label name Text
label.keyword Keyword associated to the label Text
label.response Response associated to the label Text