Skip to content

getUserIdentifier ​

Returns a single Identifier related to a User's profile

Request ​

http
GET /rest/user/identifiers/{userIdentifierId}

Headers ​

HeaderRequiredDescription
x-nextinteract-authtokenYesAuth token returned from loginUser

Parameters ​

identifierId - (required) the primary key of the Identifier record. This id can be used for updates and deletes

Response ​

200 OK ​

json
{
        "IdentifierValue": "XYZ0123456789",
        "identifierName": "AHPRA",
        "identifierDesc": "Australian Health Practitioner Regulation Agency",
        "identifierId" : 1,
        "status": "EXPIRED", 
        "statusDate": 1541650082, 
        "customField1": "customField1", 
        "customField2": "customField2", 
        "customField3": "customField3", 
        "customField4": "customField4", 
        "customField5": "customField5"
}

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