API Copyright - CSOIreland/PxStat GitHub Wiki
Read.
Reads Copyright.
Authentication: Anonymous
Privilege : n/a
Method: PxStat.System.Settings.Copyright_API.Read
Parameters:
| Name | Type | Default | Description |
|---|---|---|---|
CprCode |
String | 0 or empty | A code to describe the copyright owner of the statistical data |
Return: Array [ Object ]
| Name | Type | Description |
|---|---|---|
CprCode |
String | A code to describe the Copyright owner of the statistical data |
CprValue |
String | The name of the Copyright entity |
CprUrl |
String | The Url address of the Copyright entity |
MtrCount |
Int | The number of Tables using this Copyright |
Create.
Creates a new Copyright.
Authentication: Windows
Privilege : Administrator , Power User
Method: PxStat.System.Settings.Copyright_API.Create
Parameters:
| Name | Type | Default | Description |
|---|---|---|---|
CprCode |
String | A code to describe the Copyright owner of the statistical data | |
CprValue |
String | The name of the Copyright entity | |
CprUrl |
String | The Url address of the Copyright entity |
Return: String with value of success.
Update.
Updates an existing copyright
Authentication: Windows
Privilege : Administrator , Power User
Method: PxStat.System.Settings.Copyright_API.Update
Parameters:
| Name | Type | Default | Description |
|---|---|---|---|
CprCodeOld |
String | The original code to describe the Copyright owner of the statistical data | |
CprCodeNew |
String | The updated code to describe the Copyright owner of the statistical data | |
CprValue |
String | The name of the Copyright entity | |
CprUrl |
String | The Url address of the Copyright entity |
Return: String with value of success.
Delete.
Deletes a Copyright.
Authentication: Windows
Privilege : Administrator , Power User
Method: PxStat.System.Settings.Copyright_API.Delete
Parameters:
| Name | Type | Default | Description |
|---|---|---|---|
CprCode |
String | A code to describe the Copyright owner of the statistical data |
Return: String with value of success.