LineCard

  • 19.3.8
This article is up to date with the latest stable release of M4.

Description

The LineCard endpoint provides the API consumer with access to methods pertaining to a LineCard.

Methods

URL base/Assignment/LineCard/Specification
Action GET
Description Returns a data dictionary that details the available web service methods related to the LineCard.
Parameters None
 Returns  A JSON object with method descriptions
Sample Return Object 
[
        {
            "HttpAction": "Get",
            "MethodName": "GetCustomerServicesByLineCard",
            "Description": "Gets the customer service records for a single Line Card given the passed in ID value (see Path).",
            "Path": "/LineCard/GetCustomerServicesByLineCard/25032"
        }
]
URL base/Assignment/LineCard/GetCustomerServicesByLineCard/ID
Action GET
Description Returns a List of Customer Service objects when given the ID of a valid LineCard in the M4 database.
Parameters
Name Required? Code Description
ID Yes Integer An integer value representing the ID of a LineCard in the M4 database.
Returns A list of JSON Customer Service data objects
Sample Return Object 
[
        {
            "ID": 241,
            "CustomerServiceNumber": "AA24237",
            "ServiceCode": "ServiceCode",
            "Description": "Description",
            "CustomerID": 307,
            "StatusID": 1,
            "PhoneNumber": "231-456-9875",
            "SourceTable": "",
            "SourceID": null,
            "ConnectDate": "2017-10-04T22:03:44.293",
            "DisconnectDate": null,
            "IsDeleted": false
        },
        {
            "ID": 345,
            "CustomerServiceNumber": "AA342234",
            "ServiceCode": "ServiceCode",
            "Description": "Description",
            "CustomerID": 307,
            "StatusID": 1,
            "PhoneNumber": "231-456-9879",
            "SourceTable": "",
            "SourceID": null,
            "ConnectDate": "2017-10-04T22:03:44.293",
            "DisconnectDate": null,
            "IsDeleted": false
        }
]
URL base/Assignment/LineCard/GetLinecard/ID
Action GET
Description Returns a LineCard object when given the ID of a valid LineCard in the M4 database.
Parameters
Name Required? Code Description
ID Yes Integer An integer value representing the ID of a LineCard in the M4 database.
Returns A list of JSON Customer Service data objects
Sample Return Object 
{
    "ID": 345,
    "StructureLink": 111,
    "Status": 2,
    "TemplateID": null,
    "TicketID": 111,
    "Preprovisioned": false,
    "GroupID": null,
    "LinecardSeq": 111,
    "LCComments": "Comments",
    "LinecardDescription": "Linecard Description",
    "CreatedInM4": false,
    "IsImported": false
}
URL base/Assignment/LineCard/GetLinecardsByCustomerService/ID
Action GET
Description Returns Linecard objects 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 Structure data object
Sample Return Object 
[
    {
        "ID": 2083,
        "StructureLink": 111740,
        "Status": 1,
        "TemplateID": 1,
        "TicketID": 1234,
        "Preprovisioned": false,
        "GroupID": 0,
        "LinecardSeq": 0,
        "LCComments": "Test Comment",
        "LinecardDescription": "InUse - 2083 @Struct: 307184",
        "CreatedInM4": false,
        "IsImported": false
    }
]
URL base/Assignment/Linecard/DisconnectServiceFromLinecard
Action POST
Description This service method allows for the removing a Customer Service record from a Linecard.
Parameters
Name Required? Type Description
LinecardID Yes Integer The Linecard ID. Must be a valid Linecard.
CustomerServiceID Yes Integer Customer Service ID.  Must be a valid Service.  Service must be connected to the Linecard.
Sample JSON Package
{
    "LineCardID": 10000429,
    "CustomerServiceID": 693139
}






Returns
A JSON message data object




Sample Return Object








{


    "Message": "The CustomerService with ID [693139] was unlinked successfully from Linecard with ID [10000429]."


}










Business Rules






Any violations of these business rules result in an appropriate error message being returned to the API consumer.

The Linecard must exist.

The Customer Service must exist.

The Customer Service must currently be linked to the Linecard.		






						 

							
					 

					 
				 

 
				
			





					


					 

									

					
Was this article helpful?

									

																

					Yes
					No
				

									
					
			
							

							

				
			
			

		


		
		

     
    

        
Related Articles