Package / Frequency

What can you do with PackageFrequency?


Properties

Property Details
id
"id": 34
Type: Number
This is the unique numeric identifier for the PackageFrequency
frequency
"frequency": 621
Type: Number
isActive
"isActive": true
Type: Boolean
packageId
"packageId": 935
Type: Number
Unique identifier for the associated Package object.
frequencyTypeId
"frequencyTypeId": 765
Type: Number
Unique identifier for the associated FrequencyType object.
termsId
"termsId": 367
Type: Number
Unique identifier for the associated Terms object.
sku
"sku": "Hello World"
Type: String
name
"name": "Hello World"
Type: String
isUsageBucketSharePlanPackageFrequency
"isUsageBucketSharePlanPackageFrequency": true
Type: Boolean


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:

  • name
  • sku
  • frequency
  • isActive
  • packageId
  • frequencyTypeId
  • termsId

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 PackageFrequency object.

Standard PATCH objects:

DataFlow PATCH objects:


End Points

DELETEapi/v1/Package/Frequency/{id:int}
Delete an instance of the PackageFrequency object.
GETapi/v1/Package/Frequency
Retrieve all of the PackageFrequency objects.
GETapi/v1/Package/Frequency/Metadata
Retrieve all of the meta data details of the PackageFrequency object.
GETapi/v1/Package/Frequency/Metadata/{option}
Retrieve all the meta data details of the PackageFrequency object based on provided options.
{option}Metadata options for the PackageFrequency object.
GETapi/v1/Package/Frequency/Paged
Retreive all of the PackageFrequency objects in a paged fashion.
GETapi/v1/Package/Frequency/Paged/Detail
Retreive all of the PackageFrequency objects in a paged fashion with all object details.
GETapi/v1/Package/Frequency/{id:int}
Retrieve an instance of the PackageFrequency object by it's ID.
{id:int}Unique identifier for the PackageFrequency object.
GETapi/v1/Package/Frequency/{id:int}/Detail
Retreive all of the Detail objects for the specified PackageFrequency.
{id:int}Unique identifier for the PackageFrequency object.
PATCHapi/v1/Package/Frequency/{id:int}
Update the PackageFrequency object and optionally make changes to any child objects.
POSTapi/v1/Package/Frequency
Create a new instance of the PackageFrequency object.
PUTapi/v1/Package/Frequency/{id:int}
Update an existing instance of the PackageFrequency object.