Getting Info About Development Plan Types
The method returns information about development plan types, including their statuses, categories, and possible results.
Method: listDevelopmentPlanTypes
Permissions to Run the Request
Account Owner and Account Administrators
Request Parameters
| Parameter | Type | Description |
|---|---|---|
| token (required) | string | Access token. You can obtain a token by making a request. |
| ids (optional) | string | Development plan type IDs. To pass multiple IDs, add a separate |
| statuses (optional) | string | Development plan type statuses:
To pass multiple statuses, add a separate |
Return Values
After the request has been successfully processed, the system returns an object with the following properties:
Parameter | Type | Description |
|---|---|---|
| items [] | array | List of development plan types |
Elements of items Array
Parameter | Type | Description |
|---|---|---|
| id | string | Development plan type ID |
| title | string | Development plan type name |
| description | string | Development plan type description |
| status | string | Development plan type status:
|
| inUse | boolean | Indicates whether the development plan type is in use:
|
| type | string | Development plan type category:
|
| results [] | array | List of possible results for development plans of this type |
Elements of results Array
Parameter | Type | Description |
|---|---|---|
| title | string | Result name |
| value | string | Result value:
|
Possible Errors
| Type | Description |
|---|---|
| Permission denied | The user doesn't have sufficient permissions to run the request |
| Wrong parameters | The request couldn't be processed because required parameters are missing or specified incorrectly |
Sample Request
<?xml version="1.0" encoding="UTF-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<ListDevelopmentPlanTypesRequest xmlns="http://ispringlearn.com/go/services/api/soap">
<credentials>
<token>sample_string</token>
</credentials>
<ids>sample_string</ids>
<statuses>sample_value</statuses>
</ListDevelopmentPlanTypesRequest>
</soap:Body>
</soap:Envelope>
CODE
Sample Response
<?xml version="1.0" encoding="UTF-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<ListDevelopmentPlanTypesResponse xmlns="http://ispringlearn.com/go/services/api/soap">
<items>
<description>sample_string</description>
<id>sample_string</id>
<inUse>true</inUse>
<results>
<title>sample_string</title>
<value>sample_value</value>
</results>
<status>sample_value</status>
<title>sample_string</title>
<type>sample_value</type>
</items>
</ListDevelopmentPlanTypesResponse>
</soap:Body>
</soap:Envelope>
CODE