TAG LINE
SMALL TITLE

Account / SharePlan / Participation

(API Version v2)


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": 2
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": 17
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.


Update Request Filters

Update Request Filters are no longer required starting with v4 of the LogiSense Billing API.

When updating an object you use the update request header with the list of properties to update. Then you need only supply the new values in the body of your request. Please note, this header can only be used with PUT or PATCH requests.

Field List:

  • accountSharePlanId
  • serviceId
  • packageId

End Points

GETapi/v2/Account/SharePlan/Participation/
Retrieve all of the AccountSharePlanParticipation objects.
Retrieve all of the AccountSharePlanParticipation objects.
GET api/v2/Account/SharePlan/Participation/
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "totalCount": 1,
    "items": [
        {
            "identity": 1,
            "accountSharePlanId": 0,
            "accountSharePlanName": "Sample Text Data",
            "serviceId": 19,
            "serviceName": "Sample Text Data",
            "packageId": 19,
            "packageName": "Sample Text Data"
        }
    ]
}
GETapi/v2/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/v2/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": 8,
                "accountSharePlanName": "Sample Text Data",
                "serviceId": 9,
                "serviceName": "Sample Text Data",
                "packageId": 20,
                "packageName": "Sample Text Data"
            }
        ]
    }
}
GETapi/v2/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/v2/Account/SharePlan/Participation/{id}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "instance": {
        "identity": 1,
        "accountSharePlanId": 23,
        "accountSharePlanName": "Sample Text Data",
        "serviceId": 18,
        "serviceName": "Sample Text Data",
        "packageId": 2,
        "packageName": "Sample Text Data"
    }
}