Ctrlk
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Package Item

Viewing all package items for a package

get

To view all package items for a specific package:

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
packageIdstringRequired
Responses
200

Successful response

application/json
pageTokenstringOptional
requestedPageSizeintegerOptional
itemCountintegerOptional
get/api/v2/package/{packageId}/packageItem
GET /api/v2/package/{packageId}/packageItem HTTP/1.1
Host: package.api.anynetiot.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

Successful response

{
  "pageToken": "0",
  "requestedPageSize": 50,
  "itemCount": 2,
  "items": [
    {
      "packageItemId": 206647,
      "name": "Zone 1 Data",
      "title": "Zone1Data",
      "description": "Zone 1 Data",
      "packageId": 23434,
      "inBundleRounding": 1024,
      "outOfBundleRounding": 1024,
      "transmissionType": "Data",
      "transmissionTypeGroup": "Data services",
      "testBundleAmount": 0,
      "bundleAmount": 1048576,
      "outOfBundlePrice": 1,
      "price": 0.1,
      "packageItemCategoryId": 105,
      "packageCategoryId": 5,
      "status": "active",
      "attributes": [
        {
          "packageItemAttributeId": 17512,
          "packageItemId": 206647,
          "attribute": "doNotPool",
          "value": "yes",
          "status": "active"
        },
        {
          "packageItemAttributeId": 27583,
          "packageItemId": 206647,
          "attribute": "friendlyName",
          "value": "test",
          "status": "active"
        }
      ],
      "mcc": [
        {
          "mcc": "202",
          "mnc": null,
          "mnoId": null,
          "profileId": null,
          "apnId": null,
          "ratTypeId": null,
          "status": "active"
        },
        {
          "mcc": "204",
          "mnc": null,
          "mnoId": null,
          "profileId": null,
          "apnId": null,
          "ratTypeId": null,
          "status": "active"
        },
        {
          "mcc": "206",
          "mnc": null,
          "mnoId": null,
          "profileId": null,
          "apnId": null,
          "ratTypeId": null,
          "status": "active"
        }
      ]
    },
    {
      "packageItemId": 206854,
      "name": "Zone 1 SMS MO",
      "title": "Zone1SMSMO",
      "description": "Zone 1 API SMS MO",
      "packageId": 23434,
      "inBundleRounding": 1,
      "outOfBundleRounding": 1,
      "transmissionType": "APISMSMO",
      "transmissionTypeGroup": "API",
      "testBundleAmount": 0,
      "bundleAmount": 3,
      "outOfBundlePrice": 2,
      "price": 0.01,
      "packageItemCategoryId": 117,
      "packageCategoryId": 13,
      "status": "active"
    }
  ]
}

Creating a new package item

post

To create a new package item:

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
packageIdstringRequired
Body
namestringRequired
titlestringRequired
packageItemCategoryIdstringRequired
packageCategoryIdstringRequired
descriptionstringOptional
transmissionTypeIdstringOptional
transmissionTypeGroupIdstringOptional
inBundleRoundingstringOptional
outOfBundleRoundingstringOptional
testBundleAmountstringOptional
bundleAmountstringOptional
outOfBundlePricestringOptional
pricestringOptional
Responses
200

Successful response

application/json
packageItemIdintegerOptional
namestringOptional
titlestringOptional
descriptionstringOptional
packageIdintegerOptional
inBundleRoundingintegerOptional
outOfBundleRoundingintegerOptional
transmissionTypeanyOptional
transmissionTypeGroupanyOptional
testBundleAmountintegerOptional
bundleAmountintegerOptional
outOfBundlePriceintegerOptional
pricenumberOptional
packageItemCategoryIdintegerOptional
packageCategoryIdintegerOptional
statusstringOptional
post/api/v2/package/{packageId}/packageItem
POST /api/v2/package/{packageId}/packageItem HTTP/1.1
Host: package.api.anynetiot.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 314

{
  "name": "text",
  "title": "text",
  "packageItemCategoryId": "text",
  "packageCategoryId": "text",
  "description": "text",
  "transmissionTypeId": "text",
  "transmissionTypeGroupId": "text",
  "inBundleRounding": "text",
  "outOfBundleRounding": "text",
  "testBundleAmount": "text",
  "bundleAmount": "text",
  "outOfBundlePrice": "text",
  "price": "text"
}
200

Successful response

{
  "packageItemId": 216913,
  "name": "Zone 1 SMS MO",
  "title": "Zone1SMSMO",
  "description": "Zone 1 SMS MO",
  "packageId": 12345,
  "inBundleRounding": 1,
  "outOfBundleRounding": 1,
  "transmissionType": null,
  "transmissionTypeGroup": null,
  "testBundleAmount": 0,
  "bundleAmount": 3,
  "outOfBundlePrice": 1,
  "price": 0.1,
  "packageItemCategoryId": 117,
  "packageCategoryId": 13,
  "status": "setup"
}

Viewing a specific package item

get

To view details for a specific package item:

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
packageIdstringRequired
packageItemIdstringRequired
Responses
200

Successful response

application/json
packageItemIdintegerOptional
namestringOptional
titlestringOptional
descriptionstringOptional
packageIdintegerOptional
inBundleRoundingintegerOptional
outOfBundleRoundingintegerOptional
transmissionTypestringOptional
transmissionTypeGroupstringOptional
testBundleAmountintegerOptional
bundleAmountintegerOptional
outOfBundlePriceintegerOptional
pricenumberOptional
packageItemCategoryIdintegerOptional
packageCategoryIdintegerOptional
statusstringOptional
get/api/v2/package/{packageId}/packageItem/{packageItemId}
GET /api/v2/package/{packageId}/packageItem/{packageItemId} HTTP/1.1
Host: package.api.anynetiot.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

Successful response

{
  "packageItemId": 206647,
  "name": "Zone 1 Data",
  "title": "Zone1Data",
  "description": "Zone 1 Data",
  "packageId": 23434,
  "inBundleRounding": 1024,
  "outOfBundleRounding": 1024,
  "transmissionType": "Data",
  "transmissionTypeGroup": "Data services",
  "testBundleAmount": 0,
  "bundleAmount": 1048576,
  "outOfBundlePrice": 1,
  "price": 0.1,
  "packageItemCategoryId": 105,
  "packageCategoryId": 5,
  "status": "active",
  "attributes": [
    {
      "packageItemAttributeId": 17512,
      "packageItemId": 206647,
      "attribute": "doNotPool",
      "value": "yes",
      "status": "active"
    },
    {
      "packageItemAttributeId": 27583,
      "packageItemId": 206647,
      "attribute": "friendlyName",
      "value": "test",
      "status": "active"
    }
  ],
  "mcc": [
    {
      "mcc": "202",
      "mnc": null,
      "mnoId": null,
      "profileId": null,
      "apnId": null,
      "ratTypeId": null,
      "status": "active"
    },
    {
      "mcc": "204",
      "mnc": null,
      "mnoId": null,
      "profileId": null,
      "apnId": null,
      "ratTypeId": null,
      "status": "active"
    },
    {
      "mcc": "206",
      "mnc": null,
      "mnoId": null,
      "profileId": null,
      "apnId": null,
      "ratTypeId": null,
      "status": "active"
    }
  ]
}

Deleting a specific package item

delete

To delete a specific package item:

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
packageIdstringRequired
packageItemIdstringRequired
Responses
200

Successful response

application/json
PACKAGE_ITEMintegerOptional
delete/api/v2/package/{packageId}/packageItem/{packageItemId}
DELETE /api/v2/package/{packageId}/packageItem/{packageItemId} HTTP/1.1
Host: package.api.anynetiot.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

Successful response

{
  "PACKAGE_ITEM": 1
}

Updating a specific package item

patch

To update a specific package item:

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
packageIdstringRequired
packageItemIdstringRequired
Body
namestringOptional
titlestringOptional
descriptionstringOptional
inBundleRoundingstringOptional
outOfBundleRoundingstringOptional
transmissionTypeIdstringOptional
transmissionTypeGroupIdstringOptional
testBundleAmountstringOptional
bundleAmountstringOptional
outOfBundlePricestringOptional
pricestringOptional
packageItemCategoryIdstringOptional
packageCategoryIdstringOptional
statusstringOptional
Responses
200

Successful response

application/json
packageItemIdintegerOptional
namestringOptional
titlestringOptional
descriptionstringOptional
packageIdintegerOptional
inBundleRoundingintegerOptional
outOfBundleRoundingintegerOptional
transmissionTypeanyOptional
transmissionTypeGroupanyOptional
testBundleAmountintegerOptional
bundleAmountintegerOptional
outOfBundlePriceintegerOptional
pricenumberOptional
packageItemCategoryIdintegerOptional
packageCategoryIdintegerOptional
statusstringOptional
patch/api/v2/package/{packageId}/packageItem/{packageItemId}
PATCH /api/v2/package/{packageId}/packageItem/{packageItemId} HTTP/1.1
Host: package.api.anynetiot.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 330

{
  "name": "text",
  "title": "text",
  "description": "text",
  "inBundleRounding": "text",
  "outOfBundleRounding": "text",
  "transmissionTypeId": "text",
  "transmissionTypeGroupId": "text",
  "testBundleAmount": "text",
  "bundleAmount": "text",
  "outOfBundlePrice": "text",
  "price": "text",
  "packageItemCategoryId": "text",
  "packageCategoryId": "text",
  "status": "text"
}
200

Successful response

{
  "packageItemId": 216913,
  "name": "Zone 1 SMS MO",
  "title": "Zone1SMSMO",
  "description": "Zone 1 SMS MO",
  "packageId": 12345,
  "inBundleRounding": 1,
  "outOfBundleRounding": 1,
  "transmissionType": null,
  "transmissionTypeGroup": null,
  "testBundleAmount": 0,
  "bundleAmount": 3,
  "outOfBundlePrice": 1,
  "price": 0.1,
  "packageItemCategoryId": 117,
  "packageCategoryId": 13,
  "status": "active"
}
PreviousPackage Item Attributes
NextPackage

Last updated

Was this helpful?