TAG LINE
TAG LINE
SMALL TITLE
The types of Share Plans avaialable in the system.
identity READ-ONLY | "identity": 25 Type: Number This is the unique numeric identifier for the SharePlanType |
name | "name": "Usage" Type: String The name of the Share Plan Type. |
| GET | SharePlanType/ |
| Retrieve all of the SharePlanType objects. | |
Retrieve all of the SharePlanType objects. GET SharePlanType/ HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"totalCount": 1,
"items": [
{
"identity": 1,
"name": "Usage"
}
]
} | |
| GET | SharePlanType/Paged |
| Retrieve all of the SharePlanType objects in a paged fashion. This endpoint implements pagination for its results. Individual pages can be requested to return a particular paged set in the list of results. To learn more, see details on working with paginated endpoints. | |
Retrieve all of the SharePlanType objects in a paged fashion. GET SharePlanType/Paged HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"pagination": {
"pageNumber": 1,
"pageSize": 20,
"excludeTotalCount": false
},
"pagedResults": {
"totalCount": 1,
"items": [
{
"identity": 1,
"name": "Usage"
}
]
}
} | |
| GET | SharePlanType/{id} |
| Retrieve an instance of the SharePlanType object by its ID. | |
| {id} | Unique identifier for the SharePlanType object. |
Retrieve an instance of the SharePlanType object by its ID. GET SharePlanType/{id}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"instance": {
"identity": 1,
"name": "Usage"
}
} | |