Package

What can you do with Package?


Properties

Property Details
id
"id": 317
Type: Number
This is the unique numeric identifier for the Package
name
"name": "Hello World"
Type: String
ownerId
"ownerId": 132
Type: Number
Unique identifier for the associated Owner object.
created
"created": "2005-04-11T14:56:24"
Type: Date
description
"description": "Hello World"
Type: String
start
"start": "2005-04-11T14:56:24"
Type: Date
expiry
"expiry": "2005-04-11T14:56:24"
Type: Date
fullPeriod
"fullPeriod": true
Type: Boolean
invoiceDetail
"invoiceDetail": "Hello World"
Type: String
postPaid
"postPaid": true
Type: Boolean
syncToBillDay
"syncToBillDay": true
Type: Boolean
isUsageBucketSharePlanPackage
"isUsageBucketSharePlanPackage": true
Type: Boolean
defaultAccountPackageStatusTypeId
"defaultAccountPackageStatusTypeId": 14
Type: Number
Unique identifier for the associated AccountPackageStatusType 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:

  • name
  • created
  • description
  • start
  • expiry
  • fullPeriod
  • invoiceDetail
  • postPaid
  • syncToBillDay
  • defaultAccountPackageStatusTypeId

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

Standard PATCH objects:

DataFlow PATCH objects:


End Points

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