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