Child pages
  • WHM API 1 Functions - ticket_get_support_agreement

Versions Compared

Key

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

 

Description

Excerpt

This function retrieves the Technical Support Agreement text and metadata about the user's agreement status from the cPanel Customer Portal.


Note
titleNote:

To use this function, you must set up an OAuth2 a cPanelID token in your current session. For more information, read our cPanel::OAuth2 cPanelID documentation.


Panel
bgColor#F2F2F2
borderStylenone

Examples


Panel
bgColor#FFFFFF
borderStylenone


Expand
titleJSON API


Code Block
languagexml
https://hostname.example.com:2087/cpsess##########/json-api/ticket_get_support_agreement?api.version=1



Expand
titleXML API


Code Block
languagexml
https://hostname.example.com:2087/cpsess##########/xml-api/ticket_get_support_agreement



Expand
titleCommand Line


Note
titleNote:

Not accessible via the command line.

 

Include Page
LIB:_WHMAPI1CLINote
LIB:_WHMAPI1CLINote


Expand
titleOutput (JSON)


Code Block
languagetext
linenumberstrue
{
	"metadata": {
		"reason": "OK",
		"result": 1,
		"version": 1,
		"command": "ticket_get_support_agreement"
	},
	"data": {
		"accepted_date_human": "8/17/16",
		"accepted_date": "1471443742",
		"version": "2010-04.v01.TSUPPORT",
		"title": "Technical Support Agreement",
		"accepted": 0,
		"view_url": "http://cpanel.com/technical-support-agreements.html",
		"create_date": 1470251129,
		"download_url": "https://www.cpanel.net/legal/techagreement_download.cgi",
		"create_date_human": "8/3/16",
		"body": "<p>IMPORTANT: THIS TECHNICAL SUPPORT AGREEMENT ... at the end of AGREEMENT"
	}
}



Expand
titleOutput (XML)


Code Block
languagetext
linenumberstrue
<result>
	<metadata>
		<reason>OK</reason>
		<result>1</result>
		<version>1</version>
		<command>ticket_get_support_agreement</command>
	</metadata>
	<data>
		<accepted_date_human>8/17/16</accepted_date_human>
		<accepted_date>1471443742</accepted_date>
		<version>2010-04.v01.TSUPPORT</version>
		<title>Technical Support Agreement</title>
		<accepted>0</accepted>
		<view_url>http://cpanel.com/technical-support-agreements.html</view_url>
		<create_date>1470251129</create_date>
		<download_url>https://www.cpanel.net/legal/techagreement_download.cgi</download_url>
		<create_date_human>8/3/16</create_date_human>
		<body>&lt;p&gt;IMPORTANT: THIS TECHNICAL SUPPORT AGREEMENT ... at the end of AGREEMENT</body>
	</data>
</result>


Include Page
LIB:_WHMAPIShellNote
LIB:_WHMAPIShellNote


   

Parameters

This function does not accept parameters. 

Returns

ReturnTypeDescriptionPossible valuesExample

accepted_date_human

string

The human-readable date at which the user associated with the OAuth token accepted the Technical Support Agreement.

  • A human-readable date.
  • null — Never accepted.

8/17/16

accepted_date

integer

The Unix timestamp at which the user associated with the OAuth token accepted the Technical Support Agreement.

  • A valid Unix timestamp.
  • null — Never accepted.

1471443742

version

string

The Technical Support Agreement's version.

2010-04.v01.TSUPPORT

 

Note
titleNote:

This return's possible values will change when cPanel, IncL.L.C. updates the Technical Support Agreement.


2010-04.v01.TSUPPORT

title

string

The Technical Support Agreement's title.

Technical Support Agreement

Note
titleNote:

This return's possible values will change when cPanel, IncL.L.C. updates the Technical Support Agreement.


Technical Support Agreement

accepted

Boolean

Whether the user associated with the OAuth token has already accepted this version of the agreement.

  • 1 — Accepted.
  • 0 — Not accepted.
0

view_url

string

A URL at which the end-user may view the Technical Support Agreement agreement as a standalone HTML document.

A valid URL.


Expand
titleClick to view...

http://cpanel.com/technical-support-agreements.html


create_date

integer

The creation or publication Unix timestamp of the Technical Support Agreement's current version.

A valid Unix timestamp.1470251129

download_url

string

A URL at which the end-user may download the support agreement.

A valid URL.


Expand
titleClick to view...

https://www.cpanel.net/legal/techagreement_download.cgi


create_date_human

string

The human-readable date at which the current version of the Technical Support Agreement was created or published.

A valid human-readable date.

8/3/16

body

string

The full Technical Support Agreement.

The Technical Support Agreement text.

Note
titleNote:

This returned value may contain HTML.



Expand
titleClick here view...
<p>IMPORTANT: THIS TECHNICAL SUPPORT AGREEMENT … at the end of AGREEMENT