TAG LINE
TAG LINE
SMALL TITLE

Account / SharePlan / Participation

(API Version v4)


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


What can you do with AccountSharePlanParticipation?


Properties

Property Details
identity
READ-ONLY
"identity": 21
Type: Number
This is the unique numeric identifier for the AccountSharePlanParticipation
accountSharePlanId
"accountSharePlanId": 1
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": 6
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": 8
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": 1
Type: Number
dataUsageUnitId
"dataUsageUnitId": 18
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": 6
Type: Number
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": 24
Type: Number
countUsageUnitId
"countUsageUnitId": 6
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": 8
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

GETapi/v4/Account/SharePlan/Participation/
Retrieve all of the AccountSharePlanParticipation objects.
Retrieve all of the AccountSharePlanParticipation objects.
GET api/v4/Account/SharePlan/Participation/
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "totalCount": 1,
    "items": [
        {
            "identity": 1,
            "accountSharePlanId": 22,
            "accountSharePlanName": "Sample Text Data",
            "serviceId": 21,
            "serviceName": "Sample Text Data",
            "packageId": 18,
            "packageName": "Sample Text Data",
            "dataParticipatingLimit": 0,
            "dataUsageUnitId": 6,
            "dataUsageUnitName": "Sample Text Data",
            "timeParticipatingLimit": 8,
            "timeUsageUnitId": 7,
            "timeUsageUnitName": "Sample Text Data",
            "countParticipatingLimit": 11,
            "countUsageUnitId": 1,
            "countUsageUnitName": "Sample Text Data",
            "moneyParticipatingLimit": 25,
            "moneyUsageUnitId": 17,
            "moneyUsageUnitName": "Sample Text Data"
        }
    ]
}
GETapi/v4/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/v4/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": 23,
                "accountSharePlanName": "Sample Text Data",
                "serviceId": 26,
                "serviceName": "Sample Text Data",
                "packageId": 9,
                "packageName": "Sample Text Data",
                "dataParticipatingLimit": 15,
                "dataUsageUnitId": 25,
                "dataUsageUnitName": "Sample Text Data",
                "timeParticipatingLimit": 7,
                "timeUsageUnitId": 13,
                "timeUsageUnitName": "Sample Text Data",
                "countParticipatingLimit": 19,
                "countUsageUnitId": 9,
                "countUsageUnitName": "Sample Text Data",
                "moneyParticipatingLimit": 8,
                "moneyUsageUnitId": 6,
                "moneyUsageUnitName": "Sample Text Data"
            }
        ]
    }
}
GETapi/v4/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/v4/Account/SharePlan/Participation/{id}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "instance": {
        "identity": 1,
        "accountSharePlanId": 8,
        "accountSharePlanName": "Sample Text Data",
        "serviceId": 27,
        "serviceName": "Sample Text Data",
        "packageId": 3,
        "packageName": "Sample Text Data",
        "dataParticipatingLimit": 14,
        "dataUsageUnitId": 22,
        "dataUsageUnitName": "Sample Text Data",
        "timeParticipatingLimit": 15,
        "timeUsageUnitId": 14,
        "timeUsageUnitName": "Sample Text Data",
        "countParticipatingLimit": 17,
        "countUsageUnitId": 16,
        "countUsageUnitName": "Sample Text Data",
        "moneyParticipatingLimit": 23,
        "moneyUsageUnitId": 8,
        "moneyUsageUnitName": "Sample Text Data"
    }
}
POSTapi/v4/Account/SharePlan/Participation/Search
Retreive a list of AccountSharePlanParticipation objects based on search criteria. Search end points allow for retrieving results based on search criteria. Search criteria is sent as the payload of the POST.
Retreive a list of AccountSharePlanParticipation objects based on search criteria.
POST api/v4/Account/SharePlan/Participation/Search

{
    "query": {
        "top": 20,
        "search": [
            {
                "name": "MyFieldName",
                "operator": "startsWith",
                "value": "a"
            }
        ]
    }
}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "itemCount": 1,
    "items": [
        {
            "identity": 1,
            "accountSharePlanId": 6,
            "accountSharePlanName": "Sample Text Data",
            "serviceId": 5,
            "serviceName": "Sample Text Data",
            "packageId": 27,
            "packageName": "Sample Text Data",
            "dataParticipatingLimit": 2,
            "dataUsageUnitId": 16,
            "dataUsageUnitName": "Sample Text Data",
            "timeParticipatingLimit": 12,
            "timeUsageUnitId": 15,
            "timeUsageUnitName": "Sample Text Data",
            "countParticipatingLimit": 26,
            "countUsageUnitId": 4,
            "countUsageUnitName": "Sample Text Data",
            "moneyParticipatingLimit": 27,
            "moneyUsageUnitId": 12,
            "moneyUsageUnitName": "Sample Text Data"
        }
    ]
}