Skip to content

createUserIdentifier ​

Creates a new Identifier for User.

Request ​

http
POST /rest/user/identifiers

Headers ​

HeaderRequiredDescription
x-nextinteract-authtokenYesAuth token returned from loginUser

Parameters ​

JSON Request.

ParameterTypeRequiredDescription
identifierIdintegerYesThe 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.
identifierValuestringYesA text value representing the value e.g. an AHPRA number
json
{
  "identifierId" : 1,
  "identifierValue" : "XYZ0123456789"
}

Response ​

200 OK ​

HTTP 200 and returnd the newly created entity.

json
{
        "IdentifierValue": "XYZ0123456789",
        "identifierName": "AHPRA",
        "identifierDesc": "Australian Health Practitioner Regulation Agency",
        "identifierId" : 1
}

Errors ​

ExceptionDescription
WSInvalidParameterExceptionSee Error Definitions
WSInvalidAuthTokenExceptionSee Error Definitions
WSCacheServiceExceptionSee Error Definitions
WSIdentifierMismatchToUserRecordExceptionSee Error Definitions
WSHCPValidationExceptionSee Error Definitions
WSUserServiceExceptionSee Error Definitions
WSUserRecordIncompleteExceptionSee Error Definitions
WSAlreadyExistsExceptionSee Error Definitions