State

Use the state codes to specify the states in which your utility operates. You can specify one or more states as children of the country the belong to.

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

Task Configuration Comment
Add all needed state records

POST /api/CXIPlatformService/v1/CXIReferenceEntity/country/{id}/child/state

Here, {id} is the country to which states should be added.

Example:

POST https://<hostname>/api/CXIPlatformService/v1/CXIReferenceEntity/country/US/child/state

{

"items": [

{

"operation": "create",

"data": {

"id": "Alabama",

"faValue": "Alabama",

"cisValue": "AL"

}

},         {

"operation": "create",

"data": {

"id": "Alaska",

"faValue": "Alaska",

"cisValue": "AK"

}

}

]

}
Oracle recommends using the same value for 'id' and ‘faValue' in the request.
Edit a state record

POST /CXIPlatformService/v1/CXIReferenceEntity/country/{id}/child/state

Here, {id} is the country associated with the state you are editing.

Example:

POST https://<hostname>/api/CXIPlatformService/v1/CXIReferenceEntity/country/US/child/state

{

"items": [

{

"operation": "update",

"data": {

"id": "Alabama",

"faValue": "Alabama",

"cisValue": "AL"

}

}

]

}
Multiple state records can be edited together by adding them to the “items” list in the request.
Delete a state record

POST /CXIPlatformService/v1/CXIReferenceEntity/country/{id}/child/state

Here, {id} is the country associated with the state you are deleting.

Example:

POST https://<hostname>/api/CXIPlatformService/v1/CXIReferenceEntity/country/US/child/state

{

"items": [

{

"operation": "delete",

"data": {

"id": "Alabama"

}

}

]

}
Multiple state records can be deleted together by adding them to the “items” list in the request.
Fetch state records

GET /utilitiesAdmin/v1/country/{id}/child/state

Here {id} is the id of country associated with the states being fetched.

Example:

GET https://<hostname>/api/utilitiesAdmin/v1/country/US/child/state

A specific state record can be fetched using:

GET /utilitiesAdmin/v1/country/{id}/child/state/{childid}

Example:

GET https://<hostname>/api/utilitiesAdmin/v1/country/US/child/state/Alabama