Number Inventory Management REST Service (1.01)

Download OpenAPI specification:Download

The Number Inventory Management API is a RESTful endpoint that allows management of inventoried service numbers.

System Integrity

Resources related to System Integrity.

Use to check whether or not the Number Inventory Management service is up and running.

Resources related to inventoried service numbers.

Update an inventoried service number by ID.

This operation uses the JSON Patch document structure for specifying updates to Inventoried Service Numbers, which you can read more about here: JSON Patch (RFC 6902).

Allowed patch operations for each patchable property of an inventoried service number.

addInventoryGroupIDs/#array : add
availableDate : add, remove, replace
inventoryStatusID : add, replace
isPortedInNumber : add, remove, replace
notes : add, remove, replace
nRUFSubCategoryID : add, remove, replace

Note
- If NRUF Sub-Category is not modified, it will be updated to 'Ported-Out Numbers' if the Inventory Status is 'Ported-Out'.
- If NRUF Sub-Category is not modified and its current value is 'Ported-Out Numbers', it will be updated to null if the Inventory Status is not 'Ported-Out'.
portedFromOwnerID : add, remove, replace
portedToOwnerID : add, remove, replace
removeInventoryGroupIDs/#array : add

SWT

inventoryItemID

required

integer

Example: 1

Unique identifier of the inventoried service number to update.

Array

op required	string (op) Enum: "add" "replace" "remove" The type of JSON Patch operation being requested.
path required	string Path within the JSON document that should be modified.
value	string If supplied, the new value to be used at the given path by the given operation.

Content type

application/json-patch+json

[{"op": "replace",
"path": "/inventoryStatusID",
"value": 6
}
]

Content type

application/json

{"errors": {"field": "inventoryItemID",
"loggingNumber": 500032,
"message": "You do not have access to InventoryItem ID 0 or it does not exist."
}
}

Note: Internal changes were applied to this release. There were no external API changes.