Account / SharePlan / Participation

(API Version v5)

A listing of Services that are participating in a specified Share Plan for an Account.

What can you do with AccountSharePlanParticipation?

GET api/v5/Account/SharePlan/Participation/
Retrieve all of the AccountSharePlanParticipation objects.
GET api/v5/Account/SharePlan/Participation/Paged
Retrieve all of the AccountSharePlanParticipation objects in a paged fashion.
GET api/v5/Account/SharePlan/Participation/{id}
Retrieve an instance of the AccountSharePlanParticipation object by its ID.

Properties

Property Details

identity READ-ONLY	"identity": 1 Type: Number This is the unique numeric identifier for the AccountSharePlanParticipation
accountSharePlanId	"accountSharePlanId": 24 Type: Number Unique identifier for the associated AccountSharePlan object.
accountSharePlanName	"accountSharePlanName": "Sample Name" Type: String The name of the object associated with the accountSharePlanId property.
serviceId	"serviceId": 0 Type: Number Unique identifier for the associated Service object.
serviceName	"serviceName": "Sample Name" Type: String The name of the object associated with the serviceId property.
packageId	"packageId": 23 Type: Number Unique identifier for the associated Package object.
packageName	"packageName": "Sample Name" Type: String The name of the object associated with the packageId property.
dataParticipatingLimit	"dataParticipatingLimit": 10 Type: Number
dataUsageUnitId	"dataUsageUnitId": 14 Type: Number Unique identifier for the associated UsageUnit object.
dataUsageUnitName	"dataUsageUnitName": "Sample Name" Type: String The name of the object associated with the dataUsageUnitId property.
timeParticipatingLimit	"timeParticipatingLimit": 27 Type: Number
timeUsageUnitId	"timeUsageUnitId": 7 Type: Number Unique identifier for the associated UsageUnit object.
timeUsageUnitName	"timeUsageUnitName": "Sample Name" Type: String The name of the object associated with the timeUsageUnitId property.
countParticipatingLimit	"countParticipatingLimit": 10 Type: Number
countUsageUnitId	"countUsageUnitId": 14 Type: Number Unique identifier for the associated UsageUnit object.
countUsageUnitName	"countUsageUnitName": "Sample Name" Type: String The name of the object associated with the countUsageUnitId property.
moneyParticipatingLimit	"moneyParticipatingLimit": 12 Type: Number
moneyUsageUnitId	"moneyUsageUnitId": 13 Type: Number Unique identifier for the associated UsageUnit object.
moneyUsageUnitName	"moneyUsageUnitName": "Sample Name" Type: String The name of the object associated with the moneyUsageUnitId property.

End Points

Retrieve all of the AccountSharePlanParticipation objects.

GET api/v5/Account/SharePlan/Participation/

View Sample Response

HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "totalCount": 1,
    "items": [
        {
            "identity": 1,
            "accountSharePlanId": 18,
            "accountSharePlanName": "Sample Text Data",
            "serviceId": 10,
            "serviceName": "Sample Text Data",
            "packageId": 13,
            "packageName": "Sample Text Data",
            "dataParticipatingLimit": 9,
            "dataUsageUnitId": 23,
            "dataUsageUnitName": "Sample Text Data",
            "timeParticipatingLimit": 0,
            "timeUsageUnitId": 4,
            "timeUsageUnitName": "Sample Text Data",
            "countParticipatingLimit": 8,
            "countUsageUnitId": 22,
            "countUsageUnitName": "Sample Text Data",
            "moneyParticipatingLimit": 17,
            "moneyUsageUnitId": 17,
            "moneyUsageUnitName": "Sample Text Data"
        }
    ]
}

Retrieve all of the AccountSharePlanParticipation 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 AccountSharePlanParticipation objects in a paged fashion.

GET api/v5/Account/SharePlan/Participation/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,
                "accountSharePlanId": 16,
                "accountSharePlanName": "Sample Text Data",
                "serviceId": 4,
                "serviceName": "Sample Text Data",
                "packageId": 1,
                "packageName": "Sample Text Data",
                "dataParticipatingLimit": 1,
                "dataUsageUnitId": 4,
                "dataUsageUnitName": "Sample Text Data",
                "timeParticipatingLimit": 13,
                "timeUsageUnitId": 20,
                "timeUsageUnitName": "Sample Text Data",
                "countParticipatingLimit": 6,
                "countUsageUnitId": 22,
                "countUsageUnitName": "Sample Text Data",
                "moneyParticipatingLimit": 10,
                "moneyUsageUnitId": 18,
                "moneyUsageUnitName": "Sample Text Data"
            }
        ]
    }
}

GET	api/v5/Account/SharePlan/Participation/{id}
Retrieve an instance of the AccountSharePlanParticipation object by its ID.
{id}	Unique identifier for the AccountSharePlanParticipation object.
Retrieve an instance of the AccountSharePlanParticipation object by its ID. GET api/v5/Account/SharePlan/Participation/{id} View Sample Response HTTP/1.1 200 OK { "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b", "instance": { "identity": 1, "accountSharePlanId": 25, "accountSharePlanName": "Sample Text Data", "serviceId": 10, "serviceName": "Sample Text Data", "packageId": 12, "packageName": "Sample Text Data", "dataParticipatingLimit": 22, "dataUsageUnitId": 4, "dataUsageUnitName": "Sample Text Data", "timeParticipatingLimit": 9, "timeUsageUnitId": 18, "timeUsageUnitName": "Sample Text Data", "countParticipatingLimit": 9, "countUsageUnitId": 23, "countUsageUnitName": "Sample Text Data", "moneyParticipatingLimit": 11, "moneyUsageUnitId": 15, "moneyUsageUnitName": "Sample Text Data" } }