Child pages
  • WHM API 1 Functions - ticket_update_service_agreement_approval

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

 

Description

Excerpt

This function records a user's acceptance of the Technical Support Agreement (TSA).

 The cPanel Customer Portal stores each record with the user's login, the date and time, and the TSA's version.

 

Panel
bgColor#F2F2F2
borderStylenone

Examples


Panel
bgColor#FFFFFF
borderStylenone
Expand
titleJSON API
Code Block
languagexml
https://hostname.example.com:2087/cpsess##########/json-api/ticket_update_service_agreement_approval?api.version=1&version=2010-04.v01.TSUPPORT
Expand
titleXML API
Code Block
languagexml
https://hostname.example.com:2087/cpsess##########/xml-api/ticket_update_service_agreement_approval?api.version=1&version=2010-04.v01.TSUPPORT
Expand
titleCommand Line
Code Block
whmapi1 ticket_update_service_agreement_approval version=2010-04.v01.TSUPPORT

 

Include Page
LIB:_WHMAPI1CLINote
LIB:_WHMAPI1CLINote

Expand
titleOutput (JSON)
Code Block
languagetext
linenumberstrue
 {
	"metadata": {
		"version": 1,
		"reason": "OK",
		"result": 1,
		"command": "ticket_update_service_agreement_approval"
	}
}
Expand
titleOutput (XML)
Code Block
languagetext
linenumberstrue
<results>
	<metadata>
		<version>1</version>
		<reason>OK</reason>
		<result>1</result>
		<command>ticket_update_service_agreement_approval</command>
	</metadata>
</results>	

Include Page
LIB:_WHMAPIShellNote
LIB:_WHMAPIShellNote

   

Parameters

ParameterTypeDescriptionPossible valuesExample
versionstring

Required

The version of the TSA that the user approved.

Any non-empty string up to 32 characters.

2010-04.v01.TSUPPORT


Returns

This function only returns metadata.