Package / Service

(API Version v3)

What can you do with PackageService?

GET api/v3/Package/Service
GET api/v3/Package/Service/Paged
GET api/v3/Package/Service/Paged/Detail
GET api/v3/Package/Service/{id:int}
GET api/v3/Package/Service/{id:int}/Detail

Properties

Property Details

id	"id": 2 Type: Number This is the unique numeric identifier for the PackageService
packageId	"packageId": 7 Type: Number Unique identifier for the associated Package object.
serviceId	"serviceId": 16 Type: Number Unique identifier for the associated Service object.
defaultInstances	"defaultInstances": 21 Type: Number
minimumInstances	"minimumInstances": 8 Type: Number
maximumInstances	"maximumInstances": 11 Type: Number
termId	"termId": 27 Type: Number Unique identifier for the associated Term object.
isUsageBucketSharePlanPackageService	"isUsageBucketSharePlanPackageService": true Type: Boolean
usageClassDynamicId	"usageClassDynamicId": 6 Type: Number Unique identifier for the associated UsageClassDynamic 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:

packageId
serviceId
defaultInstances
minimumInstances
maximumInstances
termId
usageClassDynamicId

DataFlow PATCH objects:

packageService - create, update, delete
usageRatePlan - update, delete

End Points

GET	api/v3/Package/Service
Retrieve all of the PackageService objects.

GET	api/v3/Package/Service/Paged
Retreive all of the PackageService objects in a paged fashion.

GET	api/v3/Package/Service/Paged/Detail
Retreive all of the PackageService objects in a paged fashion with all object details.

GET	api/v3/Package/Service/{id:int}
Retrieve an instance of the PackageService object by it's ID.
{id:int}	Unique identifier for the PackageService object.

GET	api/v3/Package/Service/{id:int}/Detail
Retreive all of the Detail objects for the specified PackageService.
{id:int}	Unique identifier for the PackageService object.