Skip to content
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 location to the stopping location 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.

Values: html | json | pjson

gdbVersion

(Optional)

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

Syntax:

Use dark colors for code blocksCopy
1
2

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:

Use dark colors for code blocksCopy
1
2

sessionId=<guid>

domainNetworkName

(Required)

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

Syntax:

Use dark colors for code blocksCopy
1
2

domainNetworkName=<string>

Example:

Use dark colors for code blocksCopy
1
2

domainNetworkName=Telco

circuits

(Required)

The names of the circuit or circuits to be verified.

Syntax:

Use dark colors for code blocksCopy
1
2

circuits=[<string>]

Example:

Use dark colors for code blocksCopy
1
2

circuits=["CIRCUITA","CIRCUITB"]

synthesizeGeometries

(Optional)

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

Values: true | false

JSON Response syntax

Use dark colors for code blocksCopy
1
2
3
4
5
6
7
8
9
10
11
12
13
14
{
  "moment": <Epoch time in seconds>,
  "circuits": [
    {
      "name": <string>,
      "success": <boolean>,
      "error": {                   // only if success is false
        "extendedCode": <HRESULT>,
        "message": <string>
      }
    }
  ],
  "success": <boolean>
}

Example usage

Request URL and parameters:

Use dark colors for code blocksCopy
1
2

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
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
{
  "moment": 1751471778576,
  "circuits": [
    {
      "name": "CIRCUITA",
      "success": true,
      "geometry": {
        "hasZ": true,
        "hasM": true,
        "paths": [
          [
            [
              6812037.340698466,
              1843508.4881283045,
              0,
              null
            ],
            [
              6812148.573415637,
              1843506.0960727335,
              0,
              null
            ]
          ],
          [
            [
              6812148.573415637,
              1843506.0960727335,
              0,
              null
            ],
            [
              6812288.511455968,
              1843503.7040171475,
              0,
              null
            ]
          ]
        ]
      }
    },
    {
      "name": "CIRCUITB",
      "success": true,
      "geometry": {
        "hasZ": true,
        "hasM": true,
        "paths": [
          [
            [
              6812288.511455968,
              1843503.7040171475,
              0,
              null
            ],
            [
              6812410.508587301,
              1843502.507825315,
              0,
              null
            ]
          ],
          [
            [
              6812410.508587301,
              1843502.507825315,
              0,
              null
            ],
            [
              6812536.093966052,
              1843501.3119615615,
              0,
              null
            ]
          ]
        ]
      }
    }
  ],
  "exceededTransferLimit": false,
  "serviceEdits": [
    {
      "id": 22,
      "editedFeatures": {
        "updates": [
          [
            {
              "attributes": {
                "objectid": 3,
                "name": "CIRCUITA",
                "sectionorder": null,
                "status": 0,
                "isdeleted": 0,
                "lastverified": 1751471678000,
                "lastexported": null,
                "startlocationsourceid": 20,
                "startlocationid": "{7E467E73-815C-48EE-BE48-531841ACB5BC}",
                "startlocationterminalid": 1,
                "startlocationfirstunit": 1,
                "startlocationlastunit": 1,
                "stoplocationsourceid": 20,
                "stoplocationid": "{2659FAC0-B962-47CA-8157-961DF16678F7}",
                "stoplocationterminalid": 1,
                "stoplocationfirstunit": 1,
                "stoplocationlastunit": 1,
                "issectioned": 0,
                "circuittype": 0,
                "conflictcontainerstate": null,
                "globalid": "{DFFEE38A-28AA-427F-88B7-D286EB6CC2F9}",
                "created_user": null,
                "created_date": null,
                "last_edited_user": "unadmin",
                "last_edited_date": 1751471677000
              }
            },
            {
              "attributes": {
                "objectid": 3,
                "name": "CIRCUITA",
                "sectionorder": null,
                "status": 0,
                "isdeleted": 0,
                "lastverified": 1751471778000,
                "lastexported": null,
                "startlocationsourceid": 20,
                "startlocationid": "{7E467E73-815C-48EE-BE48-531841ACB5BC}",
                "startlocationterminalid": 1,
                "startlocationfirstunit": 1,
                "startlocationlastunit": 1,
                "stoplocationsourceid": 20,
                "stoplocationid": "{2659FAC0-B962-47CA-8157-961DF16678F7}",
                "stoplocationterminalid": 1,
                "stoplocationfirstunit": 1,
                "stoplocationlastunit": 1,
                "issectioned": 0,
                "circuittype": 0,
                "conflictcontainerstate": null,
                "globalid": "{DFFEE38A-28AA-427F-88B7-D286EB6CC2F9}",
                "created_user": null,
                "created_date": null,
                "last_edited_user": "unadmin",
                "last_edited_date": 1751471778000
              }
            }
          ],
          [
            {
              "attributes": {
                "objectid": 4,
                "name": "CIRCUITB",
                "sectionorder": null,
                "status": 0,
                "isdeleted": 0,
                "lastverified": 1751471678000,
                "lastexported": null,
                "startlocationsourceid": 20,
                "startlocationid": "{2659FAC0-B962-47CA-8157-961DF16678F7}",
                "startlocationterminalid": 1,
                "startlocationfirstunit": 1,
                "startlocationlastunit": 1,
                "stoplocationsourceid": 20,
                "stoplocationid": "{FACFCBC3-A72E-44E1-A2A9-251BAB46A204}",
                "stoplocationterminalid": 1,
                "stoplocationfirstunit": 1,
                "stoplocationlastunit": 1,
                "issectioned": 0,
                "circuittype": 0,
                "conflictcontainerstate": null,
                "globalid": "{4163DA48-D9F9-437E-8D2C-6564DB899EC9}",
                "created_user": null,
                "created_date": null,
                "last_edited_user": "unadmin",
                "last_edited_date": 1751471677000
              }
            },
            {
              "attributes": {
                "objectid": 4,
                "name": "CIRCUITB",
                "sectionorder": null,
                "status": 0,
                "isdeleted": 0,
                "lastverified": 1751471778000,
                "lastexported": null,
                "startlocationsourceid": 20,
                "startlocationid": "{2659FAC0-B962-47CA-8157-961DF16678F7}",
                "startlocationterminalid": 1,
                "startlocationfirstunit": 1,
                "startlocationlastunit": 1,
                "stoplocationsourceid": 20,
                "stoplocationid": "{FACFCBC3-A72E-44E1-A2A9-251BAB46A204}",
                "stoplocationterminalid": 1,
                "stoplocationfirstunit": 1,
                "stoplocationlastunit": 1,
                "issectioned": 0,
                "circuittype": 0,
                "conflictcontainerstate": null,
                "globalid": "{4163DA48-D9F9-437E-8D2C-6564DB899EC9}",
                "created_user": null,
                "created_date": null,
                "last_edited_user": "unadmin",
                "last_edited_date": 1751471778000
              }
            }
          ]
        ]
      }
    }
  ],
  "success": true
}

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