Element

  • 15.5
This article is may not be up to date with the latest stable release of M4.

Description

The Element endpoint provides the API consumer with access to methods pertaining to elements. The methods allow consumers to pull element data.

Methods

URL base/Assignment/Element/Specification
Action GET
Description Returns a data dictionary that details the available web service methods related to Assignment Elements.
Parameters None
 Returns  A JSON object with method descriptions
Sample Return Object 
[
    {
        "HttpAction": "Get",
        "MethodName": "GetElement",
        "Description": "Gets the record for a single Element given the passed in ID value (see Path).",
        "Path": "/Element/GetElement/25032"
    },
    {
        "HttpAction": "Get",
        "MethodName": "GetElementDetails",
        "Description": "Gets the underlying element details for a single Element given the passed in ID value (see Path).",
        "Path": "/Element/GetElementDetails/25032"
    }
]
URL base/Assignment/Element/GetElement/ID
Action GET
Description Returns an Element object when given an ID of a valid Element in the M4 database.
Parameters
Name Required? Type Description
ID Yes Integer An integer value representing the ID of an Element in the M4 database.
Returns A JSON Element data object
Sample Return Object 
{
    "ID": 329611,
    "SchemaName": "dbo",
    "LinkTable": "TestElement",
    "LinkDBKey": 1,
    "Description": "TestElement",
    "Status": 3,
    "ElementType": 999999,
    "COID": 0,
    "Shared": false,
    "LastUpdated": "2017-08-18T11:44:44.4"
}
URL base/Assignment/Element/GetElementDetails/ID
Action GET
Description Returns extended details for an Element object when given an ID of a valid Element in the M4 database.
Parameters
Name Required? Type Description
ID Yes Integer An integer value representing the ID of an Element in the M4 database.
Returns A JSON Element data object
Sample Return Object 
[
    {
        "ID": 465757,
        "Exchange": null,
        "Strand": 1,
        "FiberLink": 22623,
        "PathLink": 35250,
        "SegNo": 0,
        "SegLength": 0,
        "SegSpliceID": 0,
        "InUse": "NO",
        "Bad": "NO",
        "leftin": "NO",
        "FiberID": null,
        "Priority": null,
        "Assignment": null,
        "Size": null,
        "Fill": null,
        "dbLoss": null,
        "sweepLoss": null,
        "GLCode": null
    }
]

Was this article helpful?

Yes No

Related Articles