LineCardElement

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

Description

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

Methods

URL base/Assignment/LineCardElement/Specification
Action GET
Description Returns a data dictionary that details the available web service methods related to Assignment LineCardElements.
Parameters None
 Returns  A JSON object with method descriptions
Sample Return Object 
[
    {
        "HttpAction": "Get",
        "MethodName": "GetLineCardElementsByStructure",
        "Description": "Gets the line card elements for a single structure given the passed in ID value (see Path).",
        "Path": "/LineCardElement/GetLineCardElementsByStructure/25032"
    }
]
URL base/Assignment/LineCardElement/GetLineCardElementsByStructure/ID
Action GET
Description Returns a LineCard Element object when given an ID of a valid Structure in the M4 database.
Parameters
Name Required? Type Description
ID Yes Integer An integer value representing the ID of a Structure in the M4 database.
Returns A JSON Linecard Element data object
Sample Return Object 
[
    {
        "GroupID": null,
        "SequenceNumber": null,
        "StructureLink": 420493,
        "ElementDescription": "TestElement",
        "COID": 0,
        "ElementStatus": "Vacant",
        "ElementCentralOffice": "",
        "ID": 7,
        "ElementID": 329611,
        "LinecardID": 2,
        "ListOrder": 2,
        "ParentFlag": null,
        "ChildFlag": null
    }
]
URL base/Assignment/LineCardElement/GetLineCardElement/ID
Action GET
Description Returns a LineCard Element object when given a valid ID in the M4 database.
Parameters
Name Required? Type Description
ID Yes Integer An integer value representing the ID of a LineCard Element in the M4 database.
Returns A JSON Linecard Element data object
Sample Return Object 
[
    {
        "GroupID": null,
        "SequenceNumber": null,
        "StructureLink": 420493,
        "ElementDescription": "TestElement",
        "COID": 0,
        "ElementStatus": "Vacant",
        "ElementCentralOffice": "",
        "ID": 7,
        "ElementID": 329611,
        "LinecardID": 2,
        "ListOrder": 2,
        "ParentFlag": null,
        "ChildFlag": null
    }
]
URL base/Assignment/LineCardElement/GetLineCardElementsByCustomer/ID
Action GET
Description Returns a LineCard Element object when given an ID of a valid Customer in the M4 database.
Parameters
Name Required? Type Description
ID Yes Integer An integer value representing the ID of a Customer in the M4 database.
Returns A JSON Linecard Element data object
Sample Return Object 
[
    {
        "GroupID": null,
        "SequenceNumber": null,
        "StructureLink": 420493,
        "ElementDescription": "TestElement",
        "COID": 0,
        "ElementStatus": "Vacant",
        "ElementCentralOffice": "",
        "ID": 7,
        "ElementID": 329611,
        "LinecardID": 2,
        "ListOrder": 2,
        "ParentFlag": null,
        "ChildFlag": null
    }
]
URL base/Assignment/LineCardElement/GetLineCardElementsByCustomerService/ID
Action GET
Description Returns a LineCard Element object when given an ID of a valid Customer Service in the M4 database.
Parameters
Name Required? Type Description
ID Yes Integer An integer value representing the ID of a Customer Service in the M4 database.
Returns A JSON Linecard Element data object
Sample Return Object 
[
    {
        "GroupID": null,
        "SequenceNumber": null,
        "StructureLink": 420493,
        "ElementDescription": "TestElement",
        "COID": 0,
        "ElementStatus": "Vacant",
        "ElementCentralOffice": "",
        "ID": 7,
        "ElementID": 329611,
        "LinecardID": 2,
        "ListOrder": 2,
        "ParentFlag": null,
        "ChildFlag": null
    }
]
URL base/Assignment/LineCardElement/GetLineCardElementsByTicket/ID
Action GET
Description Returns a LineCard Element object when given an ID of a valid Ticket in the M4 database.
Parameters
Name Required? Type Description
ID Yes Integer An integer value representing the ID of a Ticket in the M4 database.
Returns A JSON Linecard Element data object
Sample Return Object 
[
    {
        "GroupID": null,
        "SequenceNumber": null,
        "StructureLink": 420493,
        "ElementDescription": "TestElement",
        "COID": 0,
        "ElementStatus": "Vacant",
        "ElementCentralOffice": "",
        "ID": 7,
        "ElementID": 329611,
        "LinecardID": 2,
        "ListOrder": 2,
        "ParentFlag": null,
        "ChildFlag": null
    }
]

Was this article helpful?

Yes No

Related Articles