PlcmRegistrationSummary

PlcmRegistrationSummary

Registration summary provides information about registered devices. It also provides information about external SIP peers with which the system is registered, if any. Content-Type: application/vnd.plcm.plcm-registration-summary+xml All attributes are used in ETag calculation except for entity-tag and atom link.


PlcmRegistrationSummary Fields

NameTypeDescriptionAttributes
atomLinkList Array of LinkSee Definition of Link
registrationUuidstring ID which uniquely identifies each device registration event. This is system generated unique identifier.
deviceIdstring ID which uniquely identifies each device.
deviceModelstring Device model name used for registration.
deviceVersionstring Device version used for registration.
deviceTypeDeviceType Type of device used for the registration.
signalingProtocolSignalingProtocol Signaling protocol used for the registration.
directionstring Device registration direction.
aorstring Device AOR.
fqdnstring Device FQDN.
aliasesArray of string List of device alias.
ownerstring Device owner.
ipAddressstring Device IP address.
sitestring Site associated with the device.
territorystring Territory associated with the device.
statusStatus Registration status of the device.
terminationReasonstring Device registration termination reason.
nodeIdstring The Node ID where the record is hosted.
authenticationNamestring Device authentication name.
authenticationStatusAuthenticationStatus Device authentication status.
pathHeaderstring Value of path header.
appserverNamestring Application server that processed the registration
appserverPortstring Application server port where the registration request arrived
entityTagEntityTag The unique value generated from the server object instance. This value is the same value that MUST be applied to the HTTP Entity Tag (ETag) header for a single instance of this object. Client modification of this field is not allowed for this instance.
startTimedateTimeMandatory
endTimedateTime


Nested Types/Restrictions


NameTypeRestrictions
EntityTagstring
Length of value must be >=1
Length of value must be <=64
AuthenticationStatusstring
Value must be one of:
  • H235_AUTHENTICATION_SUCCEEDED
  • H235_AUTHENTICATION_FAILED
  • SIP_AUTHENTICATION_SUCCEEDED
  • SIP_AUTHENTICATION_FAILED
  • SIP_AUTHENTICATION_CHALLENGED
  • SIP_AUTHENTICATION_NOT_CHALLENGED
  • POLY_EVO_AUTHENTICATION_SUCCEEDED
  • POLY_EVO_AUTHENTICATION_FAILED
  • NOT_APPLICABLE
Statusstring
Value must be one of:
  • ACTIVE
  • REJECTED
  • TERMINATED_BY_CALLSERVER
  • TERMINATED_BY_ENDPOINT
  • TIMED_OUT
  • INACTIVE_MANUALLY_ADDED
  • BLOCKED_BY_REGISTRATION_POLICY
  • TRYING
SignalingProtocolstring
Value must be one of:
  • H323
  • POLY_EVO
  • SIP
DeviceTypestring
Value must be one of:
  • ENDPOINT
  • MCU
  • GATEWAY
  • MCU_GATEWAY
  • EXTERNAL_SIP_PEER