plan_service.validate
Description
Validate a plan service Please see Updating Objects for an overview of how the update method works.
NOTE:This method is available when API Packager is turned on for a customer. Please contact Support or your Account Manager if you have any questions about API Packager.
Parameters
plan_service
A partial plan_service object, as described by the object.describe call. If a field in the plan_service object is ommitted, no validation will be peformed for that field. If extra fields are passed, they will be ignored.
Response
TRUE is returned if all fields are valid, otherwise, an invalid object error object is returned.
Examples
A Sample JSON-RPC plan_service.validate Request
{
"method": "plan_service.validate",
"params": [1234],
"id": 1
}
The JSON-RPC Response
{
"result": true,
"error": null,
"id": 1
}
Permissions Required
The user who owns the key used to authenticate the plan_service.validate call must be a member of one of the following roles
- Administrator
- API Manager
See authentication.
Errors
In addition to the standard json-rpc errors and authentication errors, application.fetch may also return these errors:
| HTTP Status Code | JSON-RPC Code | Error Message | Description |
|---|---|---|---|
| 400 | 1000 | Invalid Object | The object could not be created because the object would be invalid. See Validating Fields for details on the format of this error. |