TAG LINE
SMALL TITLE

Account / SharePlan

(API Version v3)


What can you do with AccountSharePlan?


Properties

Property Details
id
"id": 27
Type: Number
This is the unique numeric identifier for the AccountSharePlan
usageBucketSharePlanId
"usageBucketSharePlanId": 26
Type: Number
Unique identifier for the associated UsageBucketSharePlan object.
usageBucketShareLevelId
"usageBucketShareLevelId": 23
Type: Number
Unique identifier for the associated UsageBucketShareLevel object.
accountId
"accountId": 12
Type: Number
Unique identifier for the associated Account object.
accountServiceId
"accountServiceId": "Hello World"
Type: String
Unique identifier for the associated AccountService object.
isAvailable
"isAvailable": true
Type: Boolean
sharePlanAccountPackageId
"sharePlanAccountPackageId": "Hello World"
Type: String
Unique identifier for the associated AccountPackage object.
sellingAccountPackageId
"sellingAccountPackageId": "Hello World"
Type: String
Unique identifier for the associated AccountPackage object.


Update Request Filters

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:

  • usageBucketSharePlanId
  • usageBucketShareLevelId
  • accountId
  • accountServiceId
  • isAvailable
  • sharePlanAccountPackageId
  • sellingAccountPackageId
  • effective
  • effectiveCancel

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/v3/Account/SharePlan/{id:int}
Delete an instance of the AccountSharePlan object.
GETapi/v3/Account/SharePlan
Retrieve all of the AccountSharePlan objects.
GETapi/v3/Account/SharePlan/Paged
Retreive all of the AccountSharePlan objects in a paged fashion.
GETapi/v3/Account/SharePlan/Paged/Detail
Retreive all of the AccountSharePlan objects in a paged fashion with all object details.
GETapi/v3/Account/SharePlan/{id:int}
Retrieve an instance of the AccountSharePlan object by it's ID.
{id:int}Unique identifier for the AccountSharePlan object.
GETapi/v3/Account/SharePlan/{id:int}/Detail
Retreive all of the Detail objects for the specified AccountSharePlan.
{id:int}Unique identifier for the AccountSharePlan object.
PATCHapi/v3/Account/SharePlan/{id:int}
Update the AccountSharePlan object and optionally make changes to any child objects.
POSTapi/v3/Account/SharePlan
Create a new instance of the AccountSharePlan object.
PUTapi/v3/Account/SharePlan/{id:int}
Update an existing instance of the AccountSharePlan object.