Identifier Types

Use identifier types to specify the fields that are used to identify your utility customers. By default, no data is seeded or delivered with the solution. You must add your identifier types based on the identifier types added in your Oracle Utilities customer information system.

When you add your identifier types, the format that you use is displayed as helper text in the Search bar of the Person and Premise Search tab. This helper text enables your users to know what format they need to use when searching for a person or premise. For example, you might enter xxx-xx-xxxx as the format for a Social Security Number.

The table below provides additional details on the tasks you need to complete.

Task	Configuration	Comments
Activate an identifier type	Each identifier type has to be activated, which are to be made active. To activate more records, add the additional identifier types in the payload. POST /CXIPlatformService/v1/CXIReferenceEntity/identifierType Example: https://<hostname>/api/CXIPlatformService/v1/CXIReferenceEntity/identifierType { "items": [ { "operation": "update", "data": { "id": "SSN", "active": true } } ] }
Add an identifier type	You can add multiple identifier types to the payload, as needed. POST /CXIPlatformService/v1/CXIReferenceEntity/identifierType Example: { "items": [ { "operation": "create", "data": { "code": "SS", "format": "xx-xxxx", "active": true, "shortLabel": "Social Security No", "id": "SS" } } ] } POST https://<hostname>/api/CXIPlatformService/v1/CXIReferenceEntity/identifierType	Multiple records can be added together by adding them to the "items" list in the request.
Edit an identifier type	POST /CXIPlatformService/v1/CXIReferenceEntity/identifierType Example: POST https://<hostname>/api/CXIPlatformService/v1/CXIReferenceEntity/identifierType { "items": [ { "operation": "update", "data": { "id": "SSN", "active": true } } ] }	Multiple records can be edited at the same time by adding them to the "items" list in the request.
Fetch identifier types	GET /utilitiesAdmin/v1/identifierType?q=active=true Example: GET https://<hostname>/api/utilitiesAdmin/v1/identifierType?q=active=true A specific identifier type can be fetched using this example: Example: { "offset": 0, "limit": 25, "count": 3, "hasMore": false, "items": [ { "code": "PIN", "format": "x-xxx-xxx-xxx-xxx", "active": true, "description": "Personal ID number", "shortLabel": "PIN", "id": "PIN" }, { "code": "SSN", "format": "xx-xxxx", "active": true, "description": "Social Security No", "shortLabel": "ssn", "id": "SSN" } ] }