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": 13 Type: Number This is the unique numeric identifier for the AccountSharePlanParticipation |
accountSharePlanId | "accountSharePlanId": 15 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": 5 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": 16 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": 5 Type: Number |
dataUsageUnitId | "dataUsageUnitId": 17 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": 17 Type: Number |
timeUsageUnitId | "timeUsageUnitId": 12 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": 3 Type: Number |
countUsageUnitId | "countUsageUnitId": 23 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": 5 Type: Number |
moneyUsageUnitId | "moneyUsageUnitId": 12 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 | api/v6/Account/SharePlan/Participation/ |
Retrieve all of the AccountSharePlanParticipation objects. | |
Retrieve all of the AccountSharePlanParticipation objects. GET api/v6/Account/SharePlan/Participation/ HTTP/1.1 200 OK { "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b", "totalCount": 1, "items": [ { "identity": 1, "accountSharePlanId": 18, "accountSharePlanName": "Sample Text Data", "serviceId": 12, "serviceName": "Sample Text Data", "packageId": 18, "packageName": "Sample Text Data", "dataParticipatingLimit": 0, "dataUsageUnitId": 0, "dataUsageUnitName": "Sample Text Data", "timeParticipatingLimit": 18, "timeUsageUnitId": 6, "timeUsageUnitName": "Sample Text Data", "countParticipatingLimit": 12, "countUsageUnitId": 18, "countUsageUnitName": "Sample Text Data", "moneyParticipatingLimit": 17, "moneyUsageUnitId": 25, "moneyUsageUnitName": "Sample Text Data" } ] } |
GET | api/v6/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 api/v6/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": 1, "accountSharePlanName": "Sample Text Data", "serviceId": 20, "serviceName": "Sample Text Data", "packageId": 14, "packageName": "Sample Text Data", "dataParticipatingLimit": 14, "dataUsageUnitId": 9, "dataUsageUnitName": "Sample Text Data", "timeParticipatingLimit": 13, "timeUsageUnitId": 7, "timeUsageUnitName": "Sample Text Data", "countParticipatingLimit": 14, "countUsageUnitId": 22, "countUsageUnitName": "Sample Text Data", "moneyParticipatingLimit": 10, "moneyUsageUnitId": 20, "moneyUsageUnitName": "Sample Text Data" } ] } } |
GET | api/v6/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/v6/Account/SharePlan/Participation/{id} HTTP/1.1 200 OK { "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b", "instance": { "identity": 1, "accountSharePlanId": 18, "accountSharePlanName": "Sample Text Data", "serviceId": 3, "serviceName": "Sample Text Data", "packageId": 20, "packageName": "Sample Text Data", "dataParticipatingLimit": 22, "dataUsageUnitId": 20, "dataUsageUnitName": "Sample Text Data", "timeParticipatingLimit": 3, "timeUsageUnitId": 26, "timeUsageUnitName": "Sample Text Data", "countParticipatingLimit": 14, "countUsageUnitId": 7, "countUsageUnitName": "Sample Text Data", "moneyParticipatingLimit": 21, "moneyUsageUnitId": 10, "moneyUsageUnitName": "Sample Text Data" } } |