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": 14 Type: Number This is the unique numeric identifier for the AccountSharePlanParticipation |
accountSharePlanId | "accountSharePlanId": 6 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": 2 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": 22 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": 2 Type: Number The data limit which this service can withdraw from the Share Plan. |
dataUsageUnitId | "dataUsageUnitId": 25 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": 15 Type: Number The time limit which this service can withdraw from the Share Plan. |
timeUsageUnitId | "timeUsageUnitId": 24 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": 17 Type: Number The count limit which this service can withdraw from the Share Plan. |
countUsageUnitId | "countUsageUnitId": 3 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 The money limit which this service can withdraw from the Share Plan. |
moneyUsageUnitId | "moneyUsageUnitId": 2 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": 15,
"accountSharePlanName": "Sample Text Data",
"serviceId": 8,
"serviceName": "Sample Text Data",
"packageId": 6,
"packageName": "Sample Text Data",
"dataParticipatingLimit": 20,
"dataUsageUnitId": 25,
"dataUsageUnitName": "Sample Text Data",
"timeParticipatingLimit": 13,
"timeUsageUnitId": 17,
"timeUsageUnitName": "Sample Text Data",
"countParticipatingLimit": 21,
"countUsageUnitId": 16,
"countUsageUnitName": "Sample Text Data",
"moneyParticipatingLimit": 9,
"moneyUsageUnitId": 1,
"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": 9,
"accountSharePlanName": "Sample Text Data",
"serviceId": 10,
"serviceName": "Sample Text Data",
"packageId": 6,
"packageName": "Sample Text Data",
"dataParticipatingLimit": 22,
"dataUsageUnitId": 25,
"dataUsageUnitName": "Sample Text Data",
"timeParticipatingLimit": 6,
"timeUsageUnitId": 9,
"timeUsageUnitName": "Sample Text Data",
"countParticipatingLimit": 13,
"countUsageUnitId": 12,
"countUsageUnitName": "Sample Text Data",
"moneyParticipatingLimit": 0,
"moneyUsageUnitId": 19,
"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": 26,
"accountSharePlanName": "Sample Text Data",
"serviceId": 16,
"serviceName": "Sample Text Data",
"packageId": 18,
"packageName": "Sample Text Data",
"dataParticipatingLimit": 3,
"dataUsageUnitId": 22,
"dataUsageUnitName": "Sample Text Data",
"timeParticipatingLimit": 26,
"timeUsageUnitId": 19,
"timeUsageUnitName": "Sample Text Data",
"countParticipatingLimit": 23,
"countUsageUnitId": 16,
"countUsageUnitName": "Sample Text Data",
"moneyParticipatingLimit": 25,
"moneyUsageUnitId": 24,
"moneyUsageUnitName": "Sample Text Data"
}
} | |