TAG LINE
TAG LINE
SMALL TITLE

Share Plan Type

(API Version v10)


The types of Share Plans avaialable in the system.


What can you do with SharePlanType?


Properties

Property Details
identity
READ-ONLY
"identity": 0
Type: Number
This is the unique numeric identifier for the SharePlanType
name
"name": "Usage"
Type: String
The name of the Share Plan Type.


End Points

GETSharePlanType/
Retrieve all of the SharePlanType objects.
Retrieve all of the SharePlanType objects.
GET SharePlanType/
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "totalCount": 1,
    "items": [
        {
            "identity": 1,
            "name": "Usage"
        }
    ]
}
GETSharePlanType/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
View Sample Response
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"
            }
        ]
    }
}
GETSharePlanType/{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}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "instance": {
        "identity": 1,
        "name": "Usage"
    }
}