[Index]

API Reference for data/SubscriberQuickAddGroup

Quick Add Group to be used for the Subscriber

Model ref.: data/SubscriberQuickAddGroup

The full URL would include the host-proxy name: https://[host-proxy].

Variables are enclosed in square brackets.

For a list of available UUIDs and their dot notations:
GET /api/v0/data/HierarchyNode/?format=json

Get the Add form

Task Call URL Parameters Response
Get the GUI Add form. GET /api/data/SubscriberQuickAddGroup/add/
  • hierarchy=[hierarchy]
  • format=json
The GUI Add form of data/SubscriberQuickAddGroup as JSON

The API call to the /add/ URL can only be made from a hierarchy that allows the model type to be added. The actions in the response shows the url for the POST API call to create an instance.

Create

Task Call URL Parameters Payload
Create POST /api/data/SubscriberQuickAddGroup hierarchy=[hierarchy]
(For payload specification)

  • Response is a transaction pkid for the create action.
  • Use the GET call to
    tool/Transaction/[trans pkid]
    to inspect the created resource and its instance pkid.
  • Bulk Delete

    Task Call URL Parameters Payload
    Bulk delete [pkid1],[pkid2]... DELETE /api/data/SubscriberQuickAddGroup/ hierarchy=[hierarchy] {"hrefs":["/api/data/SubscriberQuickAddGroup/[pkid1]", "/api/data/SubscriberQuickAddGroup/[pkid2]", ...]}
    • For the instance pkids [pkid1],[pkid2], ... that can be added to the DELETE call (the instance pkids to delete), refer to the List GET call for: data/SubscriberQuickAddGroup
      GET http://[host-proxy]/api/data/SubscriberQuickAddGroup/?hierarchy=[hierarchy]&format=json

    List

    Task Call URL Parameters Response
    List GET /api/data/SubscriberQuickAddGroup/
    • hierarchy=[hierarchy]
    • format=json
    • schema=true
    The data/SubscriberQuickAddGroup schema and all instances as JSON.

    (The list will return 0 to 3 data/SubscriberQuickAddGroup instances)

    Help

    Task Call URL Parameters Response
    Get the on-line Help for data/SubscriberQuickAddGroup. GET /api/data/SubscriberQuickAddGroup/help hierarchy=[hierarchy] On-line help of Model ref.: data/SubscriberQuickAddGroup as HTML

    Instance API Reference

    Modify

    Task Call URL Parameters Payload
    Modify PUT /api/data/SubscriberQuickAddGroup/[pkid] hierarchy=[hierarchy] (For payload specification)

    For Bulk modification, refer to the Bulk Modify section.

    Delete

    Task Call URL Parameters Response
    Delete DELETE /api/data/SubscriberQuickAddGroup/[pkid] hierarchy=[hierarchy]

    Get

    Task Call URL Parameters Response
    Get GET /api/data/SubscriberQuickAddGroup/[pkid] hierarchy=[hierarchy] The data/SubscriberQuickAddGroup instance with [pkid].

    Help

    Task Call URL Parameters Response
    Help GET /api/data/SubscriberQuickAddGroup/[pkid]/help hierarchy=[hierarchy] The on-line Help for data/SubscriberQuickAddGroup.