Verify (Circuits)

URL:
https://<root>/<serviceName>/UtilityNetworkServer/circuits/verify
Methods:
GETPOST
Version Introduced:
11.5

The verify operation on the circuits resource is used to check the validity of circuits in a telecom domain network after features associated with the circuit are modified. The operation confirms that a circuit can be traced from the starting point to the stopping point and ensures that circuit sections and subcircuits are properly configured.

Request parameters

ParameterDetails

f

Specifies the output format of the response. The default response format is html.

Use dark colors for code blocksCopy
1
f=html | json | pjson

gdbVersion

(Optional)

Specifies the name of the geodatabase version. The default is 'sde.DEFAULT'.

Syntax: gdbVersion=<version>

sessionId

(Optional)

Specifies the token (guid) used to lock the version. If a client has previously started an edit session and holds an exclusive lock on the version specified, the request will fail if the sessionId is not provided. If the specified version is currently locked by any other session, the request will fail if the sessionId is not provided or does not match the sessionId that holds the exclusive lock.

Syntax: sessionId=<guid>

domainNetworkName

(Required)

Specifies the name of the telecom domain network containing the circuits to be verified.

Syntax: domainNetworkName=<string>

Example: domainNetworkName=Telco

circuits

(Required)

The names of the circuit or circuits to be verified.

Syntax: circuits=[<string>]

Example: circuits=["CircuitA","CircuitB"]

synthesizeGeometries

(Optional)

Specifies whether geometries will be inferred and created (synthesized) for the circuits. The default is false.

Use dark colors for code blocksCopy
1
synthesizeGeometries=true | false

JSON Response syntax

Use dark colors for code blocksCopy
1
2
3
4
5
6
“success” : <boolean>,
  “error” : {                   // only if success is false
    “extendedCode” : <HRESULT>,
    “message” : <string>,
    “details” : [ <string> ]
}

Example usage

Request URL and parameters:

https://myserver.esri.com/server/rest/services/Telco/UtilityNetworkServer/circuits/verify

Use dark colors for code blocksCopy
1
2
3
4
5
6

f=json
gdbVersion=sde.Default
domainNetworkName=Telco
circuits=["CIRCUITA”,”CIRCUITB"]
synthesizeGeometries=true

JSON response:

Use dark colors for code blocksCopy
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
{
	"circuits": [
		{
			"name": "CIRCUITA",
			"error": 0,
			"message": "",
			"geometry": {
				"hasZ": true,
				"hasM": true,
				"paths": [
					[
						[
							6843298.24445761,
							1844035.1893552254,
							0,
							null
						],
						[
							6858781.552868923,
							1844079.1184506415,
							0,
							null
						]
					]
				]
			}
		},
		{
			"name": "CIRCUITB",
			"error": 0,
			"message": "",
			"geometry": {
				"hasZ": true,
				"hasM": true,
				"paths": [
					[
						[
							6843110.262457582,
							1845088.1873022253,
							0,
							null
						],
						[
							6813487.645868719,
							1844079.6694006473,
							0,
							null
						]
					]
				]
			}
		}
	],
	"moment": 1741102995903,
	"success": true
}

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.