TAG LINE
TAG LINE
SMALL TITLE
A listing of Services that are participating in a specified Share Plan for an Account.
identity READ-ONLY | "identity": 19 Type: Number This is the unique numeric identifier for the AccountSharePlanParticipation |
accountSharePlanId | "accountSharePlanId": 9 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": 16 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": 19 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": 12 Type: Number The data limit which this service can withdraw from the Share Plan. |
dataUsageUnitId | "dataUsageUnitId": 16 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": 21 Type: Number The time limit which this service can withdraw from the Share Plan. |
timeUsageUnitId | "timeUsageUnitId": 21 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": 8 Type: Number The count limit which this service can withdraw from the Share Plan. |
countUsageUnitId | "countUsageUnitId": 20 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": 19 Type: Number The money limit which this service can withdraw from the Share Plan. |
moneyUsageUnitId | "moneyUsageUnitId": 23 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. |
GET | Account/SharePlan/Participation/ |
Retrieve all of the AccountSharePlanParticipation objects. | |
Retrieve all of the AccountSharePlanParticipation objects. GET Account/SharePlan/Participation/ HTTP/1.1 200 OK { "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b", "totalCount": 1, "items": [ { "identity": 1, "accountSharePlanId": 8, "accountSharePlanName": "Sample Text Data", "serviceId": 1, "serviceName": "Sample Text Data", "packageId": 23, "packageName": "Sample Text Data", "dataParticipatingLimit": 19, "dataUsageUnitId": 11, "dataUsageUnitName": "Sample Text Data", "timeParticipatingLimit": 9, "timeUsageUnitId": 13, "timeUsageUnitName": "Sample Text Data", "countParticipatingLimit": 20, "countUsageUnitId": 23, "countUsageUnitName": "Sample Text Data", "moneyParticipatingLimit": 10, "moneyUsageUnitId": 25, "moneyUsageUnitName": "Sample Text Data" } ] } |
GET | Account/SharePlan/Participation/Paged |
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 Account/SharePlan/Participation/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, "accountSharePlanId": 18, "accountSharePlanName": "Sample Text Data", "serviceId": 20, "serviceName": "Sample Text Data", "packageId": 4, "packageName": "Sample Text Data", "dataParticipatingLimit": 8, "dataUsageUnitId": 10, "dataUsageUnitName": "Sample Text Data", "timeParticipatingLimit": 15, "timeUsageUnitId": 1, "timeUsageUnitName": "Sample Text Data", "countParticipatingLimit": 9, "countUsageUnitId": 21, "countUsageUnitName": "Sample Text Data", "moneyParticipatingLimit": 18, "moneyUsageUnitId": 4, "moneyUsageUnitName": "Sample Text Data" } ] } } |
GET | 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 Account/SharePlan/Participation/{id} HTTP/1.1 200 OK { "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b", "instance": { "identity": 1, "accountSharePlanId": 3, "accountSharePlanName": "Sample Text Data", "serviceId": 9, "serviceName": "Sample Text Data", "packageId": 26, "packageName": "Sample Text Data", "dataParticipatingLimit": 20, "dataUsageUnitId": 10, "dataUsageUnitName": "Sample Text Data", "timeParticipatingLimit": 21, "timeUsageUnitId": 1, "timeUsageUnitName": "Sample Text Data", "countParticipatingLimit": 17, "countUsageUnitId": 15, "countUsageUnitName": "Sample Text Data", "moneyParticipatingLimit": 1, "moneyUsageUnitId": 17, "moneyUsageUnitName": "Sample Text Data" } } |