識別碼類型

使用識別碼類型來指定用來識別公用事業客戶的欄位。依預設,解決方案不會內建或隨附任何資料。您必須根據在 Oracle Utilities 客戶資訊系統中新增的識別碼類型來新增識別碼類型。

當您新增識別碼類型時,您使用的格式會在「人員與處所搜尋」頁籤的搜尋列中顯示為協助程式文字。此協助程式文字可讓您的使用者在搜尋人員或處所時,知道必須使用的格式。例如,您可以輸入 xxx-xx-xxxx 作為社會安全號碼的格式。

下表提供有關您需要完成之任務的其他明細。

任務 組態 註釋
啟用識別碼類型

您必須啟用每個識別碼類型,而這些識別碼類型會變成現用。若要啟用更多記錄,請在承載中新增其他識別碼類型。

POST /CXIPlatformService/v1/CXIReferenceEntity/identifierType

範例:

https://<hostname>/api/CXIPlatformService/v1/CXIReferenceEntity/identifierType

{

"items": [

{

"operation": "update",

"data": {

"id": "SSN",

"active": true

}

}

]

}
新增識別碼類型

您可以視需要將多個識別碼類型新增至承載中。

POST /CXIPlatformService/v1/CXIReferenceEntity/identifierType

範例:

{

"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

將多筆記錄新增至要求中的「項目」列表,即可同時新增多筆記錄。
編輯識別碼類型

POST /CXIPlatformService/v1/CXIReferenceEntity/identifierType

範例:

POST https://<hostname>/api/CXIPlatformService/v1/CXIReferenceEntity/identifierType

{

"items": [

{

"operation": "update",

"data": {

"id": "SSN",

"active": true

}

}

]

}
將多筆記錄新增至要求中的「項目」列表,即可同時編輯多筆記錄。
提取識別碼類型

GET /utilitiesAdmin/v1/identifierType?q=active=true

範例:

GET https://<hostname>/api/utilitiesAdmin/v1/identifierType?q=active=true

可使用此範例提取特定識別碼類型:

範例:

{

"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"

}

]

}