Damage Assessment Web Service
Oracle Utilities Network Management System Damage Assessment web service
Port DamageServiceSOAP
Location: https://<nms host>:<nms port>/nms/damage
Protocol: SOAP
Default style: document
Transport protocol: SOAP over HTTP
Target Namespace: http://oms.splwg.com/ws/damage/
Operations
CompleteDamageReport
Completes an existing damage report.
Operation Type: Request-response. The endpoint receives a message, and sends a correlated message.
SOAP Action: http://oms.splwg.com/ws/damage/CompleteDamageReport
Input: CompleteDamageReportRequest (soap:body, use = literal)
parameters type CompleteDamageReport
reportId type long
Damage report id
Output: CompleteDamageReportResponse (soap:body, use = literal)
parameters type CompleteDamageReportResponse
report type damageReport
Damage assessment report
• id - optional; type long
Damage report unique identifier assigned by the server
• groupable - optional; type boolean
Allow this damage report to be grouped upstream
• externalId - optional; type string
External id of the damage assessment incident in NMS
• eventIdx - optional; type int
Index of the event associated with this damage report
• eventExternalId - optional; type string
External id of the event associated with this damage report
• patrolEventIdx - optional; type int
Index of the patrol event associated with this damage report
• device - optional; type handle
[a] cls - required; type short
[a] index - required; type int
[a] app - optional; type short
Handle of the affected device
• deviceAlias - optional; type string
Alias of the affected device
• feeder - optional; type string
Feeder name
• gpsLocation - optional; type gpsLocation
GPS location
• latitude type double
Latitude
• longitude type double
Longitude
GPS location of the damage
• zone - optional; type string
• grid - optional; type string
• location - optional; type string
• section - optional; type string
• city - optional; type string
• address - optional; type string
Street address of the damage
• phases - optional; type phaseCode - type string with restriction - enum { 'NONE', 'A', 'B', 'AB', 'C', 'AC', 'BC', 'ABC', 'N', 'AN', 'BN', 'ABN', 'CN', 'ACN', 'BCN', 'ABCN', 'Unknown' }
Affected phases
• loadAffected - optional; type boolean
Is damage causing an outage
• roadBlocked - optional; type boolean
Is road blocked
• streetLightDamage - optional; type boolean
Is street light damage reported
• hazardous - optional; type boolean
Is damage hazardous
• crew - optional; type crew
[a] id - required; type string
NMS crew identifier (crew name)
[a] mobileNumber - optional; type string
Crew's mobile (radio) number
Crew, who submitted this damage report
• stateName - optional; type string
Damage report state (New, Assessed, etc.)
• stateBitmask - optional; type int
Damage report state bitmask (New=0x1, Assessed=0x2, Complete=0x4, Obsolete=0x8)
• active - optional; type boolean
• reportTime - optional; type dateTime
• lastModified - optional; type dateTime
• version - optional; type long
Damage report version used for optimistic concurrency control
• damageType - optional, unbounded; type reportDamageType
• typeId type int
• typeName - optional; type normalizedString
• accessible - optional; type int
• inaccessible - optional; type int
List of specific damage instances
• damageComment - optional; type string
• requiredPart - optional, unbounded; type reportDamagePart
• quantity - optional; type int
• partId type string
List of required parts/materials needed to address reported damage
• requirePartsComment type string
• crewType - optional, unbounded; type crewType
• id type int
Crew type id
• name type string
Crew type name
List of crew types needed to address reported damage
• miscField1 - optional; type string
Mapped to database column DAMAGE_REPORT.MISC_TEXT1
• miscField2 - optional; type string
Mapped to database column DAMAGE_REPORT.MISC_TEXT2
• miscField3 - optional; type string
Mapped to database column DAMAGE_REPORT.MISC_TEXT3
• miscField4 - optional; type string
Mapped to database column DAMAGE_REPORT.MISC_TEXT4
• miscField5 - optional; type string
Mapped to database column DAMAGE_REPORT.MISC_TEXT5
• miscField6 - optional; type string
Mapped to database column DAMAGE_REPORT.MISC_OPTION1
• miscField7 - optional; type string
Mapped to database column DAMAGE_REPORT.MISC_OPTION2
• miscField8 - optional; type string
Mapped to database column DAMAGE_REPORT.MISC_OPTION3
• miscField9 - optional; type string
Mapped to database column DAMAGE_REPORT.MISC_OPTION4
• miscField10 - optional; type string
Mapped to database column DAMAGE_REPORT.MISC_OPTION5
• udf1 - optional; type string
User-defined field 1
• udf2 - optional; type string
User-defined field 2
• udf3 - optional; type string
User-defined field 3
• udf4 - optional; type string
User-defined field 4
• udf5 - optional; type string
User-defined field 5
• udf6 - optional; type string
User-defined field 6
• udf7 - optional; type string
User-defined field 7
• udf8 - optional; type string
User-defined field 8
• udf9 - optional; type string
User-defined field 9
• udf10 - optional; type string
User-defined field 10
• udf11 - optional; type string
User-defined field 11
• udf12 - optional; type string
User-defined field 12
• udf13 - optional; type string
User-defined field 13
• udf14 - optional; type string
User-defined field 14
• udf15 - optional; type string
User-defined field 15
• udf16 - optional; type string
User-defined field 16
• udf17 - optional; type string
User-defined field 17
• udf18 - optional; type string
User-defined field 18
• udf19 - optional; type string
User-defined field 19
• udf20 - optional; type string
User-defined field 20
• attachment - optional, unbounded; type attachment
List of damage report attachments. Actual attachment data is not included.
• data - optional; type base64Binary
Attachment data
• description - optional; type string
Description of the attachment
[a] id - required; type string
Attachment id (file name)
[a] reportId - required; type long
Damage report id
[a] uri - optional; type anyURI
Link to the attachment. Can be used instead of passing attachment data in the message
[a] contentType - optional; type string
MIME content type
[a] lastModified - optional; type dateTime
Last modification timestamp
Fault: DamageServiceException (soap:fault, use = literal)
parameters type DamageServiceFault
errors - unbounded; type Error
Damage Service error
• error type errorCode - type string with restriction - enum { 'CreateFailed', 'CompletedEvent', 'UnknownEvent', 'BadEventType', 'LoadAffectedSetForNonOutage', 'DatabaseError', 'UnknownReportId', 'AlreadyCompleted', 'StaleData', 'IncidentCreateFailed', 'InvalidCrewType', 'InvalidDamageType', 'InvalidRequiredPart', 'NeedEventOrDevice', 'NeedAddress', 'NeedCrewId', 'MoveFailed', 'AttachmentTooBig', 'AttachmentSaveError', 'AttachmentNotFound', 'Other' }
String representation of the error code
[a] code type int
Error code
[a] reportId type long
Damage report id associated with the error
DeleteAttachments
Deletes one or more damage report attachments.
Operation Type: Request-response. The endpoint receives a message, and sends a correlated message.
SOAP Action: http://oms.splwg.com/ws/damage/DeleteAttachments
Input: DeleteAttachmentsRequest (soap:body, use = literal)
parameters type DeleteAttachments
attachmentId - unbounded; type attachmentId
Identifier for damage report attachment
• id type string
Attachment id (file name). If empty then all attachments for this damage report are included.
• reportId type long
Damage report id
Output: DeleteAttachmentsResponse (soap:body, use = literal)
Fault: DamageServiceException (soap:fault, use = literal)
parameters type DamageServiceFault
errors - unbounded; type Error
Damage Service error
• error type errorCode - type string with restriction - enum { 'CreateFailed', 'CompletedEvent', 'UnknownEvent', 'BadEventType', 'LoadAffectedSetForNonOutage', 'DatabaseError', 'UnknownReportId', 'AlreadyCompleted', 'StaleData', 'IncidentCreateFailed', 'InvalidCrewType', 'InvalidDamageType', 'InvalidRequiredPart', 'NeedEventOrDevice', 'NeedAddress', 'NeedCrewId', 'MoveFailed', 'AttachmentTooBig', 'AttachmentSaveError', 'AttachmentNotFound', 'Other' }
String representation of the error code
[a] code type int
Error code
[a] reportId type long
Damage report id associated with the error
GetAttachments
Retrieves damage report attachments.
Operation Type: Request-response. The endpoint receives a message, and sends a correlated message.
SOAP Action: http://oms.splwg.com/ws/damage/GetAttachments
Input: GetAttachmentsRequest (soap:body, use = literal)
parameters type GetAttachments
attachmentId - unbounded; type attachmentId
Identifier for damage report attachment
• id type string
Attachment id (file name). If empty then all attachments for this damage report are included.
• reportId type long
Damage report id
Output: GetAttachmentsResponse (soap:body, use = literal)
parameters type GetAttachmentsResponse
result - optional, unbounded; type attachment
[a] data - optional; type base64Binary
Attachment data
[a] description - optional; type string
Description of the attachment
• id - required; type string
Attachment id (file name)
• reportId - required; type long
Damage report id
• uri - optional; type anyURI
Link to the attachment. Can be used instead of passing attachment data in the message
• contentType - optional; type string
MIME content type
• lastModified - optional; type dateTime
Last modification timestamp
Fault: DamageServiceException (soap:fault, use = literal)
parameters type DamageServiceFault
errors - unbounded; type Error
Damage Service error
• error type errorCode - type string with restriction - enum { 'CreateFailed', 'CompletedEvent', 'UnknownEvent', 'BadEventType', 'LoadAffectedSetForNonOutage', 'DatabaseError', 'UnknownReportId', 'AlreadyCompleted', 'StaleData', 'IncidentCreateFailed', 'InvalidCrewType', 'InvalidDamageType', 'InvalidRequiredPart', 'NeedEventOrDevice', 'NeedAddress', 'NeedCrewId', 'MoveFailed', 'AttachmentTooBig', 'AttachmentSaveError', 'AttachmentNotFound', 'Other' }
String representation of the error code
• code type int
Error code
• reportId type long
Damage report id associated with the error
GetCrewTypes
Returns all crew types configured in NMS.
Operation Type: Request-response. The endpoint receives a message, and sends a correlated message.
SOAP Action: http://oms.splwg.com/ws/damage/GetCrewTypes
Input: GetCrewTypesRequest (soap:body, use = literal)
parameters type GetCrewTypes
Output: GetCrewTypesResponse (soap:body, use = literal)
parameters type GetCrewTypesResponse
result - optional, unbounded; type crewType
• id type int
Crew type id
• name type string
Crew type name
Fault: DamageServiceException (soap:fault, use = literal)
parameters type DamageServiceFault
errors - unbounded; type Error
Damage Service error
[a] error type errorCode - type string with restriction - enum { 'CreateFailed', 'CompletedEvent', 'UnknownEvent', 'BadEventType', 'LoadAffectedSetForNonOutage', 'DatabaseError', 'UnknownReportId', 'AlreadyCompleted', 'StaleData', 'IncidentCreateFailed', 'InvalidCrewType', 'InvalidDamageType', 'InvalidRequiredPart', 'NeedEventOrDevice', 'NeedAddress', 'NeedCrewId', 'MoveFailed', 'AttachmentTooBig', 'AttachmentSaveError', 'AttachmentNotFound', 'Other' }
String representation of the error code
• code type int
Error code
• reportId type long
Damage report id associated with the error
GetDamageReportById
Returns damage report for given report id.
Operation Type: Request-response. The endpoint receives a message, and sends a correlated message.
SOAP Action: http://oms.splwg.com/ws/damage/GetDamageReportById
Input: GetDamageReportByIdRequest (soap:body, use = literal)
parameters type GetDamageReportById
reportId type long
Damage report id
Output: GetDamageReportByIdResponse (soap:body, use = literal)
parameters type GetDamageReportByIdResponse
report type damageReport
Damage assessment report (see CompleteDamageReport)
Fault: DamageServiceException (soap:fault, use = literal)
parameters type DamageServiceFault
errors - unbounded; type Error
Damage Service error
[a] error type errorCode - type string with restriction - enum { 'CreateFailed', 'CompletedEvent', 'UnknownEvent', 'BadEventType', 'LoadAffectedSetForNonOutage', 'DatabaseError', 'UnknownReportId', 'AlreadyCompleted', 'StaleData', 'IncidentCreateFailed', 'InvalidCrewType', 'InvalidDamageType', 'InvalidRequiredPart', 'NeedEventOrDevice', 'NeedAddress', 'NeedCrewId', 'MoveFailed', 'AttachmentTooBig', 'AttachmentSaveError', 'AttachmentNotFound', 'Other' }
String representation of the error code
• code type int
Error code
• reportId type long
Damage report id associated with the error
GetDamageReportsByHandle
Returns all damage reports for given event or device handle.
Operation Type: Request-response. The endpoint receives a message, and sends a correlated message.
SOAP Action: http://oms.splwg.com/ws/damage/GetDamageReportsByHandle
Input: GetDamageReportsByHandleRequest (soap:body, use = literal)
parameters type GetDamageReportsByHandle
handle type handle
• cls - required; type short
• index - required; type int
• app - optional; type short
Event or device handle
Output: GetDamageReportsByHandleResponse (soap:body, use = literal)
parameters type GetDamageReportsByHandleResponse
report - optional, unbounded; type damageReport
Damage assessment report (see CompleteDamageReport)
Fault: DamageServiceException (soap:fault, use = literal)
parameters type DamageServiceFault
errors - unbounded; type Error
Damage Service error
[a] error type errorCode - type string with restriction - enum { 'CreateFailed', 'CompletedEvent', 'UnknownEvent', 'BadEventType', 'LoadAffectedSetForNonOutage', 'DatabaseError', 'UnknownReportId', 'AlreadyCompleted', 'StaleData', 'IncidentCreateFailed', 'InvalidCrewType', 'InvalidDamageType', 'InvalidRequiredPart', 'NeedEventOrDevice', 'NeedAddress', 'NeedCrewId', 'MoveFailed', 'AttachmentTooBig', 'AttachmentSaveError', 'AttachmentNotFound', 'Other' }
String representation of the error code
• code type int
Error code
• reportId type long
Damage report id associated with the error
GetDamageReportsByPatrol
Returns all damage reports for given patrol event index.
Operation Type: Request-response. The endpoint receives a message, and sends a correlated message.
SOAP Action: http://oms.splwg.com/ws/damage/GetDamageReportsByPatrol
Input: GetDamageReportsByPatrolRequest (soap:body, use = literal)
parameters type GetDamageReportsByPatrol
patrolEventIdx type int
Patrol event index
Output: GetDamageReportsByPatrolResponse (soap:body, use = literal)
parameters type GetDamageReportsByPatrolResponse
report - optional, unbounded; type damageReport
Damage assessment report (see CompleteDamageReport)
Fault: DamageServiceException (soap:fault, use = literal)
parameters type DamageServiceFault
errors - unbounded; type Error
Damage Service error
[a] error type errorCode - type string with restriction - enum { 'CreateFailed', 'CompletedEvent', 'UnknownEvent', 'BadEventType', 'LoadAffectedSetForNonOutage', 'DatabaseError', 'UnknownReportId', 'AlreadyCompleted', 'StaleData', 'IncidentCreateFailed', 'InvalidCrewType', 'InvalidDamageType', 'InvalidRequiredPart', 'NeedEventOrDevice', 'NeedAddress', 'NeedCrewId', 'MoveFailed', 'AttachmentTooBig', 'AttachmentSaveError', 'AttachmentNotFound', 'Other' }
String representation of the error code
• code type int
Error code
• • reportId type long
Damage report id associated with the error
GetRequiredParts
Returns all required parts/materials configured in NMS.
Operation Type: Request-response. The endpoint receives a message, and sends a correlated message.
SOAP Action: http://oms.splwg.com/ws/damage/GetRequiredParts
Input: GetRequiredPartsRequest (soap:body, use = literal)
parameters type GetRequiredParts
Output: GetRequiredPartsResponse (soap:body, use = literal)
parameters type GetRequiredPartsResponse
result - optional, unbounded; type requiredPart
• id type string
• name type string
• source - optional; type string
Fault: DamageServiceException (soap:fault, use = literal)
parameters type DamageServiceFault
errors - unbounded; type Error
Damage Service error
[a] error type errorCode - type string with restriction - enum { 'CreateFailed', 'CompletedEvent', 'UnknownEvent', 'BadEventType', 'LoadAffectedSetForNonOutage', 'DatabaseError', 'UnknownReportId', 'AlreadyCompleted', 'StaleData', 'IncidentCreateFailed', 'InvalidCrewType', 'InvalidDamageType', 'InvalidRequiredPart', 'NeedEventOrDevice', 'NeedAddress', 'NeedCrewId', 'MoveFailed', 'AttachmentTooBig', 'AttachmentSaveError', 'AttachmentNotFound', 'Other' }
String representation of the error code
• code type int
Error code
• reportId type long
Damage report id associated with the error
NewDamageReport
Returns populated damage report for given event or device. This operation does not create new damage report in NMS.
Operation Type: Request-response. The endpoint receives a message, and sends a correlated message.
SOAP Action: http://oms.splwg.com/ws/damage/NewDamageReport
Input: NewDamageReportRequest (soap:body, use = literal)
parameters type NewDamageReport
handle - optional; type handle
• cls - required; type short
• index - required; type int
• app - optional; type short
Event or device handle
• deviceAlias - optional; type string
Device alias (only used if handle is not provided)
• externalId - optional; type string
Event's external id (only used if handle is not provided)
Output: NewDamageReportResponse (soap:body, use = literal)
parameters type NewDamageReportResponse
report type damageReport
Damage assessment report (see CompleteDamageReport)
Fault: DamageServiceException (soap:fault, use = literal)
parameters type DamageServiceFault
errors - unbounded; type Error
Damage Service error
[a] error type errorCode - type string with restriction - enum { 'CreateFailed', 'CompletedEvent', 'UnknownEvent', 'BadEventType', 'LoadAffectedSetForNonOutage', 'DatabaseError', 'UnknownReportId', 'AlreadyCompleted', 'StaleData', 'IncidentCreateFailed', 'InvalidCrewType', 'InvalidDamageType', 'InvalidRequiredPart', 'NeedEventOrDevice', 'NeedAddress', 'NeedCrewId', 'MoveFailed', 'AttachmentTooBig', 'AttachmentSaveError', 'AttachmentNotFound', 'Other' }
String representation of the error code
• code type int
Error code
• reportId type long
Damage report id associated with the error
SaveAttachments
Creates new or updates existing damage report attachments.
Operation Type: Request-response. The endpoint receives a message, and sends a correlated message.
SOAP Action: http://oms.splwg.com/ws/damage/SaveAttachments
Input: SaveAttachmentsRequest (soap:body, use = literal)
parameters type SaveAttachments
attachment - unbounded; type attachment
• data - optional; type base64Binary
Attachment data
• description - optional; type string
Description of the attachment
id - required; type string
Attachment id (file name)
reportId - required; type long
Damage report id
uri - optional; type anyURI
Link to the attachment. Can be used instead of passing attachment data in the message
contentType - optional; type string
MIME content type
lastModified - optional; type dateTime
Last modification timestamp
Output: SaveAttachmentsResponse (soap:body, use = literal)
Fault: DamageServiceException (soap:fault, use = literal)
parameters type DamageServiceFault
errors - unbounded; type Error
Damage Service error
[a] error type errorCode - type string with restriction - enum { 'CreateFailed', 'CompletedEvent', 'UnknownEvent', 'BadEventType', 'LoadAffectedSetForNonOutage', 'DatabaseError', 'UnknownReportId', 'AlreadyCompleted', 'StaleData', 'IncidentCreateFailed', 'InvalidCrewType', 'InvalidDamageType', 'InvalidRequiredPart', 'NeedEventOrDevice', 'NeedAddress', 'NeedCrewId', 'MoveFailed', 'AttachmentTooBig', 'AttachmentSaveError', 'AttachmentNotFound', 'Other' }
String representation of the error code
• code type int
Error code
• reportId type long
Damage report id associated with the error
SaveDamageReport
Creates new or updates existing damage report. This operation cannot be used to complete an existing damage report.
Operation Type: Request-response. The endpoint receives a message, and sends a correlated message.
SOAP Action: http://oms.splwg.com/ws/damage/SaveDamageReport
Input: SaveDamageReportRequest (soap:body, use = literal)
parameters type SaveDamageReport
report type damageReport
Damage assessment report (see CompleteDamageReport)
action - optional; type string
Action to trigger state transition
Output: SaveDamageReportResponse (soap:body, use = literal)
parameters type SaveDamageReportResponse
report type damageReport
Damage assessment report (see CompleteDamageReport)
Fault: DamageServiceException (soap:fault, use = literal)
parameters type DamageServiceFault
errors - unbounded; type Error
Damage Service error
[a] error type errorCode - type string with restriction - enum { 'CreateFailed', 'CompletedEvent', 'UnknownEvent', 'BadEventType', 'LoadAffectedSetForNonOutage', 'DatabaseError', 'UnknownReportId', 'AlreadyCompleted', 'StaleData', 'IncidentCreateFailed', 'InvalidCrewType', 'InvalidDamageType', 'InvalidRequiredPart', 'NeedEventOrDevice', 'NeedAddress', 'NeedCrewId', 'MoveFailed', 'AttachmentTooBig', 'AttachmentSaveError', 'AttachmentNotFound', 'Other' }
String representation of the error code
• code type int
Error code
• reportId type long
Damage report id associated with the error
GetRepairTimeConfig
Returns damage assessment repair time configuration.
Operation Type: Request-response. The endpoint receives a message, and sends a correlated message.
SOAP Action: http://oms.splwg.com/ws/damage/GetRepairTimeConfig
Input: GetRepairTimeConfigRequest (soap:body, use = literal)
parameters type GetRepairTimeConfig
Output: GetRepairTimeConfigResponse (soap:body, use = literal)
parameters type GetRepairTimeConfigResponse
result - optional, unbounded; type damageRepairTime
• assetType type string
• accessibleRepairTime type int
• inaccessibleRepairTime type int
• deviceClass type int
Fault: DamageServiceException (soap:fault, use = literal)
parameters type DamageServiceFault
errors - unbounded; type Error
Damage Service error
[a] error type errorCode - type string with restriction - enum { 'CreateFailed',
'CompletedEvent', 'UnknownEvent', 'BadEventType', 'LoadAffectedSetForNonOutage',
'DatabaseError', 'UnknownReportId', 'AlreadyCompleted', 'StaleData',
'IncidentCreateFailed', 'InvalidCrewType', 'InvalidDamageType', 'InvalidRequiredPart',
'NeedEventOrDevice', 'NeedAddress', 'NeedCrewId', 'MoveFailed',
'AttachmentTooBig', 'AttachmentSaveError', 'AttachmentNotFound', 'Other' }
String representation of the error code
• code type int
Error code
• reportId type long
Damage report id associated with the error