Skip to content

API Reason

DeclanBuckley edited this page Dec 27, 2018 · 28 revisions

Read

Entry point to the API method - Reads a Reason. Return the list of entities that have been found.

Authentication: Anonymous

Privilege : PowerUser,Moderator

Method: PxStat.System.Settings.Reason.Reason_API.Read

Parameters:

Name Type Default Description
RsnCode String null optional varchar(32)
RlsCode?

Return: Array [ Object ]

Name Type Description
RsnCode String A code for the reason for a release
RsnValueExternal String An internal description of the reason for a release
RsnValueInternal String An external description of the reason for a release

Create

Entry point to the API method - Creates a Reason

Authentication: Anonymous

Privilege : PowerUser/Moderator

Method: PxStat.System.Settings.Reason.Reason_API..Create

Parameters:

Name Type Default Description
RsnCode String None A code for the reason for a release
RsnValueExternal String None An internal description of the reason for a release
RsnValueInternal String None An internal description of the reason for a release

Return: Array [ Object ]

Name Type Description
RsnCode String A code for the reason for a release
RsnValueInternal String An internal description of the reason for a release
RsnValueExternal String An internal description of the reason for a release

Update

Entry point to the API method - Updates an existing copyright

Authentication: Anonymous

Privilege : PowerUser/Moderator

Method: PxStat.System.Settings.Reason.Reason_API..Update

Parameters:

Name Type Default Description
RsnCode String None A code for the reason for a release
RsnValueExternal String None An internal description of the reason for a release
RsnValueInternal String None An internal description of the reason for a release

Return: Array [ Object ]

Name Type Description
RsnCode String A code for the reason for a release
RsnValueInternal String An internal description of the reason for a release
RsnValueExternal String An internal description of the reason for a release

Delete

Entry point to the API method - Deletes a Reason

Authentication: Anonymous

Privilege : PowerUser/Moderator

Method: PxStat.System.Settings.Reason.Reason_API..Delete

Parameters:

Name Type Default Description
RsnCode String A code for the reason for a release
RsnValueInternal String An internal description of the reason for a release
RsnValueExternal String An internal description of the reason for a release

Return: Message.

Clone this wiki locally