TAG LINE
SMALL TITLE

Account / SharePlan

(API Version v4)


A Share Plan assigned to an Account. A Share Plan is a way of pooling usage across multiple Services and Packages. This entity is essentially a linking object between a defined Share Plan and an Account.


What can you do with AccountSharePlan?


Properties

Property Details
identity
READ-ONLY
"identity": 11
Type: Number
This is the unique numeric identifier for the AccountSharePlan
usageBucketSharePlanId
"usageBucketSharePlanId": 3
Type: Number
Unique identifier for the associated UsageBucketSharePlan object.
usageBucketSharePlanName
"usageBucketSharePlanName": "Sample Name"
Type: String
The name of the object associated with the usageBucketSharePlanId property.
usageBucketShareLevelId
"usageBucketShareLevelId": 7
Type: Number
Unique identifier for the associated UsageBucketShareLevel object.
usageBucketShareLevelName
"usageBucketShareLevelName": "Sample Name"
Type: String
The name of the object associated with the usageBucketShareLevelId property.
accountId
"accountId": 12
Type: Number
Unique identifier for the associated Account object.
accountName
"accountName": "Sample Name"
Type: String
The name of the object associated with the accountId property.
accountServiceId
"accountServiceId": "Hello World"
Type: String
Unique identifier for the associated AccountService object.
accountServiceName
"accountServiceName": "Sample Name"
Type: String
The name of the object associated with the accountServiceId property.
isAvailable
READ-ONLY
"isAvailable": true
Type: Boolean
If the Share Plan is active.
sharePlanAccountPackageId
"sharePlanAccountPackageId": "Hello World"
Type: String
Unique identifier for the associated AccountPackage object.
sharePlanAccountPackageName
"sharePlanAccountPackageName": "Sample Name"
Type: String
The name of the object associated with the sharePlanAccountPackageId property.
sellingAccountPackageId
"sellingAccountPackageId": "Hello World"
Type: String
Unique identifier for the associated AccountPackage object.
sellingAccountPackageName
"sellingAccountPackageName": "Sample Name"
Type: String
The name of the object associated with the sellingAccountPackageId property.


Patch Types

The PATCH verb allows you to update an object. Just like a put, you only need to supply the fields that will be updated in the payload. However, a patch allows you to update many objects at once.

PATCH operations can be used as a standard API call or nested within the envelope of a DataFlow. Below you will find the child objects that can be updated as part of PATCH operations for the AccountSharePlan object.

Standard PATCH objects:

DataFlow PATCH objects:


End Points

DELETEapi/v4/Account/SharePlan/{id}
Delete an instance of the AccountSharePlan object. Upon successful delete, this API will return a record of all of the reelated objects deleted with this operation. The specifics on which objects have been deleted will depend on which related objects have been populated in the system.
{id}Unique identifier for the AccountSharePlan object.
Delete an instance of the AccountSharePlan object.
DELETE api/v4/Account/SharePlan/{id}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "type": "delete",
    "results": {
        "totalCount": 4,
        "items": [
            {
                "identity": 1,
                "action": "deleted",
                "dtoTypeKey": "accountSharePlan"
            },
            {
                "lhsId": 2,
                "rhsId": 2,
                "action": "detached",
                "dtoTypeKey": "sampleObjectConnector"
            },
            {
                "foreignKeyIdentity": 2,
                "action": "deleted",
                "dtoTypeKey": "sampleObject"
            }
        ]
    }
}
GETapi/v4/Account/SharePlan/
Retrieve all of the AccountSharePlan objects.
Retrieve all of the AccountSharePlan objects.
GET api/v4/Account/SharePlan/
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "totalCount": 1,
    "items": [
        {
            "identity": 1,
            "usageBucketSharePlanId": 4,
            "usageBucketSharePlanName": "Sample Text Data",
            "usageBucketShareLevelId": 8,
            "usageBucketShareLevelName": "Sample Text Data",
            "accountId": 22,
            "accountName": "Sample Text Data",
            "accountServiceId": "Sample Text Data",
            "accountServiceName": "Sample Text Data",
            "isAvailable": true,
            "sharePlanAccountPackageId": "Sample Text Data",
            "sharePlanAccountPackageName": "Sample Text Data",
            "sellingAccountPackageId": "Sample Text Data",
            "sellingAccountPackageName": "Sample Text Data"
        }
    ]
}
GETapi/v4/Account/SharePlan/Paged
Retrieve all of the AccountSharePlan 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 AccountSharePlan objects in a paged fashion.
GET api/v4/Account/SharePlan/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,
                "usageBucketSharePlanId": 5,
                "usageBucketSharePlanName": "Sample Text Data",
                "usageBucketShareLevelId": 14,
                "usageBucketShareLevelName": "Sample Text Data",
                "accountId": 5,
                "accountName": "Sample Text Data",
                "accountServiceId": "Sample Text Data",
                "accountServiceName": "Sample Text Data",
                "isAvailable": true,
                "sharePlanAccountPackageId": "Sample Text Data",
                "sharePlanAccountPackageName": "Sample Text Data",
                "sellingAccountPackageId": "Sample Text Data",
                "sellingAccountPackageName": "Sample Text Data"
            }
        ]
    }
}
GETapi/v4/Account/SharePlan/Paged/Detail
Retrieve all of the AccountSharePlan objects in a paged fashion with all object details. This endpoint returns additional detailed data related to this object. The specifics on which data is returned will depend on which related objects have been populated in the system.
Retrieve all of the AccountSharePlan objects in a paged fashion with all object details.
GET api/v4/Account/SharePlan/Paged/Detail
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,
                "usageBucketSharePlanId": 27,
                "usageBucketSharePlanName": "Sample Text Data",
                "usageBucketShareLevelId": 8,
                "usageBucketShareLevelName": "Sample Text Data",
                "accountId": 18,
                "accountName": "Sample Text Data",
                "accountServiceId": "Sample Text Data",
                "accountServiceName": "Sample Text Data",
                "isAvailable": true,
                "sharePlanAccountPackageId": "Sample Text Data",
                "sharePlanAccountPackageName": "Sample Text Data",
                "sellingAccountPackageId": "Sample Text Data",
                "sellingAccountPackageName": "Sample Text Data",
                "details": {
                    "sampleSingleObject": {
                        "identity": 2,
                        "property1": "Sample Text",
                        "property2": "2021-04-26T15:25:29.117Z",
                        "property3": 2
                    },
                    "sampleMultipleObjects": {
                        "totalCount": 1,
                        "items": [
                            {
                                "identity": 2,
                                "property1": "Sample Text",
                                "property2": "2021-04-26T15:25:29.117Z",
                                "property3": 2
                            }
                        ]
                    }
                }
            }
        ]
    }
}
GETapi/v4/Account/SharePlan/{id}
Retrieve an instance of the AccountSharePlan object by its ID.
{id}Unique identifier for the AccountSharePlan object.
Retrieve an instance of the AccountSharePlan object by its ID.
GET api/v4/Account/SharePlan/{id}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "instance": {
        "identity": 1,
        "usageBucketSharePlanId": 12,
        "usageBucketSharePlanName": "Sample Text Data",
        "usageBucketShareLevelId": 17,
        "usageBucketShareLevelName": "Sample Text Data",
        "accountId": 22,
        "accountName": "Sample Text Data",
        "accountServiceId": "Sample Text Data",
        "accountServiceName": "Sample Text Data",
        "isAvailable": true,
        "sharePlanAccountPackageId": "Sample Text Data",
        "sharePlanAccountPackageName": "Sample Text Data",
        "sellingAccountPackageId": "Sample Text Data",
        "sellingAccountPackageName": "Sample Text Data"
    }
}
GETapi/v4/Account/SharePlan/{id}/Detail
Retrieve deep detail of the AccountSharePlan object by its ID. This endpoint returns additional detailed data related to this object. The specifics on which data is returned will depend on which related objects have been populated in the system.
{id}Unique identifier for the AccountSharePlan object.
Retrieve deep detail of the AccountSharePlan object by its ID.
GET api/v4/Account/SharePlan/{id}/Detail
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "instance": {
        "identity": 1,
        "usageBucketSharePlanId": 5,
        "usageBucketSharePlanName": "Sample Text Data",
        "usageBucketShareLevelId": 13,
        "usageBucketShareLevelName": "Sample Text Data",
        "accountId": 17,
        "accountName": "Sample Text Data",
        "accountServiceId": "Sample Text Data",
        "accountServiceName": "Sample Text Data",
        "isAvailable": true,
        "sharePlanAccountPackageId": "Sample Text Data",
        "sharePlanAccountPackageName": "Sample Text Data",
        "sellingAccountPackageId": "Sample Text Data",
        "sellingAccountPackageName": "Sample Text Data",
        "details": {
            "sampleSingleObject": {
                "identity": 2,
                "property1": "Sample Text",
                "property2": "2021-04-26T15:25:29.117Z",
                "property3": 2
            },
            "sampleMultipleObjects": {
                "totalCount": 1,
                "items": [
                    {
                        "identity": 2,
                        "property1": "Sample Text",
                        "property2": "2021-04-26T15:25:29.117Z",
                        "property3": 2
                    }
                ]
            }
        }
    }
}
PATCHapi/v4/Account/SharePlan/{id}
Update or Add the AccountSharePlan object and optionally make changes to any child objects. Patch end points allow for adding/updating multiple related entities and the results of those changes will be reported in the response JSON payload in the items array.
{id}Unique identifier for the AccountSharePlan object.
Update or Add the AccountSharePlan object and optionally make changes to any child objects.
PATCH api/v4/Account/SharePlan/{id}

{
    "details": {},
    "accountSharePlans": {
        "items": [
            {
                "patchType": "create",
                "patchClientId": 1,
                "usageBucketSharePlanId": 20,
                "usageBucketShareLevelId": 13,
                "accountId": 8,
                "accountServiceId": "Sample Text Data",
                "sharePlanAccountPackageId": "Sample Text Data",
                "sellingAccountPackageId": "Sample Text Data"
            }
        ]
    }
}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "type": "patch",
    "results": {
        "totalCount": 1,
        "items": [
            {
                "identity": 1,
                "action": "created",
                "dtoTypeKey": "accountSharePlan",
                "instance": {
                    "identity": 1,
                    "usageBucketSharePlanId": 3,
                    "usageBucketSharePlanName": "Sample Text Data",
                    "usageBucketShareLevelId": 8,
                    "usageBucketShareLevelName": "Sample Text Data",
                    "accountId": 26,
                    "accountName": "Sample Text Data",
                    "accountServiceId": "Sample Text Data",
                    "accountServiceName": "Sample Text Data",
                    "isAvailable": true,
                    "sharePlanAccountPackageId": "Sample Text Data",
                    "sharePlanAccountPackageName": "Sample Text Data",
                    "sellingAccountPackageId": "Sample Text Data",
                    "sellingAccountPackageName": "Sample Text Data"
                }
            }
        ]
    }
}
POSTapi/v4/Account/SharePlan/
Create a new instance of the AccountSharePlan object.
Create a new instance of the AccountSharePlan object.
POST api/v4/Account/SharePlan/

{
    "usageBucketSharePlanId": 20,
    "usageBucketShareLevelId": 3,
    "accountId": 23,
    "accountServiceId": "Sample Text Data",
    "sharePlanAccountPackageId": "Sample Text Data",
    "sellingAccountPackageId": "Sample Text Data"
}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "type": "create",
    "results": {
        "totalCount": 1,
        "items": [
            {
                "identity": 1,
                "usageBucketSharePlanId": 16,
                "usageBucketSharePlanName": "Sample Text Data",
                "usageBucketShareLevelId": 7,
                "usageBucketShareLevelName": "Sample Text Data",
                "accountId": 17,
                "accountName": "Sample Text Data",
                "accountServiceId": "Sample Text Data",
                "accountServiceName": "Sample Text Data",
                "isAvailable": true,
                "sharePlanAccountPackageId": "Sample Text Data",
                "sharePlanAccountPackageName": "Sample Text Data",
                "sellingAccountPackageId": "Sample Text Data",
                "sellingAccountPackageName": "Sample Text Data"
            }
        ]
    }
}
POSTapi/v4/Account/SharePlan/Search
Retreive a list of AccountSharePlan 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 AccountSharePlan objects based on search criteria.
POST api/v4/Account/SharePlan/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,
            "usageBucketSharePlanId": 11,
            "usageBucketSharePlanName": "Sample Text Data",
            "usageBucketShareLevelId": 4,
            "usageBucketShareLevelName": "Sample Text Data",
            "accountId": 24,
            "accountName": "Sample Text Data",
            "accountServiceId": "Sample Text Data",
            "accountServiceName": "Sample Text Data",
            "isAvailable": true,
            "sharePlanAccountPackageId": "Sample Text Data",
            "sharePlanAccountPackageName": "Sample Text Data",
            "sellingAccountPackageId": "Sample Text Data",
            "sellingAccountPackageName": "Sample Text Data"
        }
    ]
}
PUTapi/v4/Account/SharePlan/{id}
Update an existing instance of the AccountSharePlan object.
Update an existing instance of the AccountSharePlan object.
PUT api/v4/Account/SharePlan/{id}

{
    "identity": 1,
    "usageBucketSharePlanId": 11,
    "usageBucketShareLevelId": 26,
    "accountId": 27,
    "accountServiceId": "Sample Text Data",
    "sharePlanAccountPackageId": "Sample Text Data",
    "sellingAccountPackageId": "Sample Text Data"
}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "type": "update",
    "results": {
        "totalCount": 1,
        "items": [
            {
                "identity": 1,
                "usageBucketSharePlanId": 26,
                "usageBucketSharePlanName": "Sample Text Data",
                "usageBucketShareLevelId": 17,
                "usageBucketShareLevelName": "Sample Text Data",
                "accountId": 12,
                "accountName": "Sample Text Data",
                "accountServiceId": "Sample Text Data",
                "accountServiceName": "Sample Text Data",
                "isAvailable": true,
                "sharePlanAccountPackageId": "Sample Text Data",
                "sharePlanAccountPackageName": "Sample Text Data",
                "sellingAccountPackageId": "Sample Text Data",
                "sellingAccountPackageName": "Sample Text Data"
            }
        ]
    }
}