unitDetailLevel
If unitDetailLevel
is set, the response can contain the following information:
EXCLUDE
: No unit information is returned.
LOW
:name
extId
state
parentExtId
MEDIUM
: All elements from theLOW
detail level plus:displayName
entries
lang
value
displayAbbreviation
entries
lang
value
localizedHname
entries
lang
value
location
description
properties
(ifpropertyDetailLevel
is not set to EXCLUDE)name
value
hname
profileless
policyName
validFrom
validTo
HIGH
: All elements from theMEDIUM
detail level plus:ctlCreUid
ctlCreDat
ctlModUid
ctlModDat
ctlTcn
The following detail levels can be useful in combination with unitDetailLevel
:
propertyDetailLevel
defaultDetailLevel
Example of a request and response with unitDetailLevel
set to MEDIUM
:
Request:
<v1:queryUnits>
<query>
<clientExtId>CHLogin</clientExtId>
<detailLevels>
<unitDetailLevel>MEDIUM</unitDetailLevel>
</detailLevels>
<unit/>
</query>
</v1:queryUnits>
Response:
<ns2:queryUnitsResponse
xmlns:ns2="http://adnovum.ch/nevisidm/ws/services/v1">
<return>
<name>DefaultUnit-CHLogin</name>
<extId>2000002013</extId>
<state>ACTIVE</state>
<description>The first unit of CHLogin</description>
<hname>/2000002013</hname>
<profileless>false</profileless>
</return>
</ns2:queryUnitsResponse>