Broadworks-OCIP

 view release on metacpan or  search on metacpan

lib/Broadworks/OCIP/Methods.pod  view on Meta::CPAN

=over 4

=item B<userId> - I<UserId>

=back

Additionally there are generic tagged parameters.

=head3 UserShInterfaceGetPublicIdDataRequest

Returns the Sh non-transparent data stored against a Public User Identity (a
SIP URI or TEL URI).

The response is either a C<UserShInterfaceGetPublicIdDataResponse> or an
C<ErrorResponse>.

Fixed parameters are:-

=over 4

=item B<publicUserIdentity> - I<PublicUserIdentity>

=back

=head3 UserShInterfaceGetUserIdDataRequest

Returns the Sh non-transparent data stored against a userId.

The response is either a C<UserShInterfaceGetUserIdDataResponse> or an
C<ErrorResponse>.

Fixed parameters are:-

=over 4

=item B<userId> - I<UserId>

=back

=head3 UserShInterfaceModifyRequest

Modifies the Sh Interface non-transparent data associated with a Public User
Identity.

The response is a C<SuccessResponse> or C<ErrorResponse>.

Fixed parameters are:-

=over 4

=item B<publicUserIdentity> - I<PublicUserIdentity>

ocip_html/OCISchemaUser.xsd.html  view on Meta::CPAN

</tr>
<tr>
<th>
<a href="#term_Abstract" title="Look up 'Abstract' in glossary">Abstract</a>
</th>
<td>no</td>
</tr>
<tr>
<th>Documentation</th>
<td>
        Returns the Sh non-transparent data stored against a Public User Identity (a SIP URI
        or TEL URI).
        The response is either a UserShInterfaceGetPublicIdDataResponse or an ErrorResponse.
      </td>
</tr>
</table>
<div class="sample box">
<div>
<input style="display: none" onclick="switchState('type_UserShInterfaceGetPublicIdDataRequest_xibox'); return false;" class="control" id="type_UserShInterfaceGetPublicIdDataRequest_xibox_button" type="button" /> <span class="caption">XML Instance Rep...
</div>
<div class="contents" id="type_UserShInterfaceGetPublicIdDataRequest_xibox">

ocip_html/OCISchemaUser.xsd.html  view on Meta::CPAN

<tr>
<th>
<a href="#term_Abstract" title="Look up 'Abstract' in glossary">Abstract</a>
</th>
<td>no</td>
</tr>
<tr>
<th>Documentation</th>
<td>
        Response to the UserShInterfaceGetPublicIdDataRequest.
        The response contains the Sh non-transparent data for the specified Public User Identity.
        The data also includes a userId, userType, and endpointType.
      </td>
</tr>
</table>
<div class="sample box">
<div>
<input style="display: none" onclick="switchState('type_UserShInterfaceGetPublicIdDataResponse_xibox'); return false;" class="control" id="type_UserShInterfaceGetPublicIdDataResponse_xibox_button" type="button" /> <span class="caption">XML Instance R...
</div>
<div class="contents" id="type_UserShInterfaceGetPublicIdDataResponse_xibox">
<div style="margin-left: 0em">&lt;...&gt; <br />

ocip_html/OCISchemaUser.xsd.html  view on Meta::CPAN

</tr>
<tr>
<th>
<a href="#term_Abstract" title="Look up 'Abstract' in glossary">Abstract</a>
</th>
<td>no</td>
</tr>
<tr>
<th>Documentation</th>
<td>
        Returns the Sh non-transparent data stored against a userId.
        The response is either a UserShInterfaceGetUserIdDataResponse or an ErrorResponse.
      </td>
</tr>
</table>
<div class="sample box">
<div>
<input style="display: none" onclick="switchState('type_UserShInterfaceGetUserIdDataRequest_xibox'); return false;" class="control" id="type_UserShInterfaceGetUserIdDataRequest_xibox_button" type="button" /> <span class="caption">XML Instance Represe...
</div>
<div class="contents" id="type_UserShInterfaceGetUserIdDataRequest_xibox">
<div style="margin-left: 0em">&lt;...&gt; <br />

ocip_html/OCISchemaUser.xsd.html  view on Meta::CPAN

<tr>
<th>
<a href="#term_Abstract" title="Look up 'Abstract' in glossary">Abstract</a>
</th>
<td>no</td>
</tr>
<tr>
<th>Documentation</th>
<td>
        Response to the UserShInterfaceGetUserIdDataRequest.
        The response contains the Sh non-transparent data for the specified userId.
        The data also includes a userType, publicUserIdentity and endpointType.
      </td>
</tr>
</table>
<div class="sample box">
<div>
<input style="display: none" onclick="switchState('type_UserShInterfaceGetUserIdDataResponse_xibox'); return false;" class="control" id="type_UserShInterfaceGetUserIdDataResponse_xibox_button" type="button" /> <span class="caption">XML Instance Repre...
</div>
<div class="contents" id="type_UserShInterfaceGetUserIdDataResponse_xibox">
<div style="margin-left: 0em">&lt;...&gt; <br />

ocip_html/OCISchemaUser.xsd.html  view on Meta::CPAN

</tr>
<tr>
<th>
<a href="#term_Abstract" title="Look up 'Abstract' in glossary">Abstract</a>
</th>
<td>no</td>
</tr>
<tr>
<th>Documentation</th>
<td>
        Modifies the Sh Interface non-transparent data associated with a Public User Identity.
        The response is a SuccessResponse or ErrorResponse.
      </td>
</tr>
</table>
<div class="sample box">
<div>
<input style="display: none" onclick="switchState('type_UserShInterfaceModifyRequest_xibox'); return false;" class="control" id="type_UserShInterfaceModifyRequest_xibox_button" type="button" /> <span class="caption">XML Instance Representation</span>...
</div>
<div class="contents" id="type_UserShInterfaceModifyRequest_xibox">
<div style="margin-left: 0em">&lt;...&gt; <br />