CircuitStatus

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

Description

The CircuitStatus endpoint provides the API consumer with access to methods pertaining to circuit statuses. The endpoint allows consumers to create and retreive circuit status information.

Methods

URL base/Circuits/CircuitStatus/Specification
Action GET
Description Returns a data dictionary that details the available web service methods related to the CircuitStatus controller.
Parameters None
 Returns  A JSON object with method descriptions
Sample Return Object 
 [
 {
 "HttpAction": "Get",
 "MethodName": "GetAllCircuitStatuses",
 "Description": "Returns the records for all Circuit Statuses.",
 "Path": "/CircuitStatus/GetAllCircuitStatuses"
 },
 {
 "HttpAction": "Get",
 "MethodName": "GetCircuitStatusByID",
 "Description": "Returns the record for a single Circuit Status given the passed in ID value.",
 "Path": "/Circuit/GetCircuitStatusByID/25032"
 },
 {
 "HttpAction": "Post",
 "MethodName": "AddCircuitStatus",
 "Description": "Adds a new circuit status given the passed in CircuitStatus object",
 "Format": {
 "Description": "my status description"
 }
 }
]
URL base/Circuits/CircuitStatus/AddCircuitStatus
Action POST
Description Returns the CircuitStatus object just added to the M4 database.
Parameters
Name Required? Type Description
Description No String The description of the Circuit Status.
Sample JSON Package 
{
 "Description": "new status 1"
}
Returns A JSON CircuitStatus data object
Sample Return Object 
{
 "Description": "new status 1",
 "ID": 92
}
Business Rules
Any violations of these business rules result in an appropriate error message being returned to the API consumer.
  • N/A
URL base/Circuits/CircuitStatus/GetCircuitStatus/ID
Action GET
Description Returns a CircuitStatus object when given an ID of a valid circuit status in the M4 database.
Parameters
Name Required? Type Description
ID Yes Integer An integer value representing the ID of a circuit status in the M4 database.
Returns A JSON CircuitStatus data object
Sample Return Object 
{
 "Description": "Pending Auto Assignment",
 "ID": 1
}
 
URL base/Circuits/CircuitStatus/GetAllCircuitStatuses
Action GET
Description Returns all CircuitStatus objects in the M4 database.
Parameters
Name Required? Type Description
Returns A JSON collection of CircuitStatus data objects
Sample Return Object 
[
 {
 "Description": "Pending Auto Assignment",
 "ID": 1
 },
 {
 "Description": "Complete",
 "ID": 2
 },
 {
 "Description": "Pending Manual Assignment",
 "ID": 3
 }
]
 

Was this article helpful?

Yes No

Related Articles