Is Registered User

From Creately Developer

Jump to: navigation, search

Contents

Description

This method allows a consumer to check if a given user is a registered and valid user of Creately.

Request

Request Details

URL https://creately.com/api/user
HTTP Method POST
Supported Authentication SA
API Permissions This API call will required special permissions for the API Key to access.
User Permissions Not applicable

Request Parameters

Parameter Description Required Default Value
action Must contain the value "exists". Will indicate that this is a User Exists check action. Mandatory N/A
usr The email address of the user account that needs to be checked for existence Mandatory N/A
returnxml A boolean value indicating "true" or "false". Specifies if response should be a XML. Response will be sent in a XML if the value is true. Response will be sent in a serial string if the value is false. Optional true

NOTE: Parameters required by the authentication method must be provided. See what parameters are required in Authentication

Response

Response Details

Type XML
Content The account status of the given email address will be returned on successful response.

Response Parameters

Tag Description
success Indicates if the request was successfully processed. May have true or false
is-creately-user Will contain the value "true" to indicate the email address has a valid Creately account. If not will have "false" as the value
team-plan-status If the "is-creately-user" parameter has a "true" value, this parameter would contain the Team plan status of the user. The following integer values are expected.
0 - The user account does not belong to a Team Plan
1 - The user account belongs to a Team Plan.
2 - The user account has been added to a Team Plan, but the user has not confirmed to join the Team Plan
errorcode Will be available if the success parameter was false. Will contain a valid API Error code. Valid error codes are listed in API Error Codes
message Will be available if the success parameter was false. Will contain a string message for the error

Errors

Refer to Errors related to Auth API calls in the Error Codes
Possible errors for Is Registered User method are:

Examples

Example 1

Request

https://creately.com/api/user?apikey=2njk4234j23hkj23h4j2k3423jk4h&sig=jkn435654jk2j1kjh3mjk9&usr=johndoe@achme.com&action=exists

Response

	<creately-api-response>
 		<success>true</success>
 		<is-creately-user>true</is-creately-user>
 		<team-plan-status>1</team-plan-status>
 	</creately-api-response>
Personal tools