Customer Experience for Utilities REST APIs

All REST Endpoints

Reference Types/Country

Operations for Country Configuration

Create, Update, or Delete Country: Method: post
Path: /api/CXIPlatformService/{version}/CXIReferenceEntity/country
Get All Countries: Method: get
Path: /api/utilitiesAdmin/{version}/country
Get Country: Method: get
Path: /api/utilitiesAdmin/{version}/country/{id}

Reference Types/Identifier Type

Operations for the identifier type resource

Create, Update, or Delete Identifier Type: Method: post
Path: /api/CXIPlatformService/{version}/CXIReferenceEntity/identifierType
Get all Identifier Types: Method: get
Path: /api/utilitiesAdmin/{version}/identifierType
Get Identifier Type: Method: get
Path: /api/utilitiesAdmin/{version}/identifierType/{id}

Reference Types/Insight Group

Operations for the insight group resource

Create, Update, or Delete Insight Group: Method: post
Path: /api/CXIPlatformService/{version}/CXIReferenceEntity/insightGroup
Get all Insight Groups: Method: get
Path: /api/utilitiesAdmin/{version}/insightGroup
Get Insight Group: Method: get
Path: /api/utilitiesAdmin/{version}/insightGroup/{id}

Reference Types/Insight Group Insight Types

Operations for the insight group insight types resource

Create, Update, or Delete Insight Group Insight Types: Method: post
Path: /api/CXIPlatformService/{version}/CXIReferenceEntity/insightGroupInsightTypes
Get all Insight Group Insight Types: Method: get
Path: /api/utilitiesAdmin/{version}/insightGroupInsightTypes
Get Insight Group Insight Types: Method: get
Path: /api/utilitiesAdmin/{version}/insightGroupInsightTypes/{id}

Reference Types/Insight Severity

Operations for Insight Severity Configuration

Create, Update, or Delete Insight Severities: Method: post
Path: /api/CXIPlatformService/{version}/CXIReferenceEntity/insightSeverity
Get All Insight Severity: Method: get
Path: /api/utilitiesAdmin/{version}/insightSeverity
Get Insight Severity: Method: get
Path: /api/utilitiesAdmin/{version}/insightSeverity/{id}

Reference Types/Insight Type

Operations for the insight type resource.

Create, Update, or Delete Insight Type: Method: post
Path: /api/CXIPlatformService/{version}/CXIReferenceEntity/insightType
Get all Insight Types: Method: get
Path: /api/utilitiesAdmin/{version}/insightType
Get Insight Type: Method: get
Path: /api/utilitiesAdmin/{version}/insightType/{id}

Reference Types/Insight Type User Action

Operations for the insight type user action resource

Create, Update, or Delete Insight Type User Action: Method: post
Path: /api/CXIPlatformService/{version}/CXIReferenceEntity/insightTypeUserAction
Get all Insight Type User Actions: Method: get
Path: /api/utilitiesAdmin/{version}/insightTypeUserAction
Get Insight Type User Action: Method: get
Path: /api/utilitiesAdmin/{version}/insightTypeUserAction/{id}

Reference Types/Premise Tree

Operations for the Premise Tree Configuration

Create, Update, or Delete Premise Tree: Method: post
Path: /api/CXIPlatformService/{version}/CXIReferenceEntity/premiseTree
Get All Premise Trees: Method: get
Path: /api/utilitiesAdmin/{version}/premiseTree
Get Premise Tree: Method: get
Path: /api/utilitiesAdmin/{version}/premiseTree/{id}

Reference Types/Service Types

Operations for Service Types administration

Create, Update, or Delete Service Types: Method: post
Path: /api/CXIPlatformService/{version}/CXIReferenceEntity/serviceType
Get All Service Types: Method: get
Path: /api/utilitiesAdmin/{version}/serviceType
Get Service Type: Method: get
Path: /api/utilitiesAdmin/{version}/serviceType/{id}

Reference Types/Standard Usage Identifier

Operations for Standard Usage Identifiers

Create, Update, or Delete Standard Usage Identifiers: Method: post
Path: /api/CXIPlatformService/{version}/CXIReferenceEntity/standardUsageIdentifier
Get All Standard Usage Identifiers: Method: get
Path: /api/utilitiesAdmin/{version}/standardUsageIdentifier
Get Standard Usage Identifier: Method: get
Path: /api/utilitiesAdmin/{version}/standardUsageIdentifier/{id}

Reference Types/State

Operations for State Configuration

Create, Update, or Delete States of a Country: Method: post
Path: /api/CXIPlatformService/{version}/CXIReferenceEntity/country/{id}/child/state
Get all States of a Country: Method: get
Path: /api/utilitiesAdmin/{version}/country/{id}/child/state
Get State: Method: get
Path: /api/utilitiesAdmin/{version}/country/{id}/child/state/{childid}

Reference Types/Units of Measure

Operations for the Units of Measure

Create, Update, or Delete Units of Measure: Method: post
Path: /api/CXIPlatformService/{version}/CXIReferenceEntity/unitOfMeasure
Get All Units of Measure: Method: get
Path: /api/utilitiesAdmin/{version}/unitOfMeasure
Get Unit of Measure: Method: get
Path: /api/utilitiesAdmin/{version}/unitOfMeasure/{id}

Reference Types/User Action

Operations for User Action Configuration

Create, Update, or Delete User Action: Method: post
Path: /api/CXIPlatformService/{version}/CXIReferenceEntity/userAction
Get all User Actions: Method: get
Path: /api/utilitiesAdmin/{version}/userAction
Get User Action: Method: get
Path: /api/utilitiesAdmin/{version}/userAction/{id}