Appearance
updateUserIdentifier ​
Updates an existing Identifier for a User.
Request ​
http
PUT /rest/user/identifiersHeaders ​
| Header | Required | Description |
|---|---|---|
x-nextinteract-authtoken | Yes | Auth token returned from loginUser |
Parameters ​
JSON Request.
| Parameter | Type | Required | Description |
|---|---|---|---|
identifierId | integer | Yes | The Identifier Id associated with the Country/Profession combo. Please use the /rest/refdata/identifiers API to obtain possible values for identifierId. NOTE: Not to be confused with uIdentifierId which is the PK of a created User Identifier i.e. this operation. |
identifierValue | string | Yes | A text value representing the value e.g. an AHPRA number |
json
{
"identifierId" : 1,
"identifierValue" : "XYZ0123456789"
}Response ​
200 OK ​
N/A. HTTP 200 and returns the update entity (value only basically).
json
{
"IdentifierValue": "XYZ0123456789",
"identifierName": "AHPRA",
"identifierDesc": "Australian Health Practitioner Regulation Agency",
"identifierId" : 1
}Errors ​
| Exception | Description |
|---|---|
WSInvalidParameterException | See Error Definitions |
WSInvalidAuthTokenException | See Error Definitions |
WSCacheServiceException | See Error Definitions |
WSIdentifierMismatchToUserRecordException | See Error Definitions |
WSHCPValidationException | See Error Definitions |
WSUserServiceException | See Error Definitions |
WSUserRecordIncompleteException | See Error Definitions |
WSAlreadyExistsException | See Error Definitions |