view release on metacpan or  search on metacpan

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

C<ErrorResponse>.

Fixed parameters are:-

=over 4

=item B<serviceProviderId> - I<ServiceProviderId>

=item B<groupId> - I<GroupId>

=item B<accessDevice / deviceLevel> - I<Unknown>

=item B<accessDevice / deviceName> - I<Unknown>

=back

=head2 Login

=head3 AuthenticationRequest

C<AuthenticationRequest> is 1st stage of the 2 stage OCI login process.

Fixed parameters are:-

=over 4

=item B<userId> - I<UserId>

=back

=head3 AuthenticationVerifyRequest14sp8

C<AuthenticationVerifyRequest14sp8> is used to authenticate a user either by
userId/password, userId/sip username/sip password, dn/passcode or a token
previously authorized with the C<ExternalAuthenticationAuthorizeTokenRequest>.
The phone number may be any DN associated with a user.

The response is a C<AuthenticationVerifyResponse14sp8> or an C<ErrorResponse>

Fixed parameters are:-

=over 4

=back

Additionally there are generic tagged parameters.

=head3 AvailabilityTestRequest

C<AvailabilityTestRequest> is for high-availability support. Response is either
C<SuccessResponse> or C<ErrorResponse>.

Fixed parameters are:-

=over 4

=back

=head3 DeviceManagementFileAuthLocationGetRequest18

Get the address and credentials of the File Repository hosting the requested
access device file. Also get the file name and path on the File Repository.

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

Fixed parameters are:-

=over 4

=item B<deviceAccessProtocol> - I<DeviceAccessProtocol16>

=item B<deviceAccessMethod> - I<FileRepositoryAccessType>

=item B<deviceAccessURI> - I<DeviceManagementAccessURI>

=back

Additionally there are generic tagged parameters.

=head3 DeviceManagementPutFileRequest

Informs C<BroadWorks> that a file was uploaded to the repository.

The response is always a C<SuccessResponse>.

Fixed parameters are:-

=over 4

=item B<deviceAccessURI> - I<DeviceManagementAccessURI>

=item B<ipAddress> - I<NetAddress>

=back

=head3 ExternalAuthenticationAuthorizeTokenRequest

This command is part of the Portal API. Sent when a Web or CLI user logs in
using external authentication. The password must be hashed. The password
hashing algorithm is: 1) The message digest of the user's plain password is
calculated using the SHA algorithm. 2) For every four bits in the 160-bit
digest, starting from the first bit, it is converted into a character in ASCII
Hex format (0 through 9, a through f). The result is a 40-character string, for
example, f7a9e24777ec23212c54d7a350bc5bea5477fdbb. 3) The above string then is
used to populate the password field in the request.

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

Fixed parameters are:-

=over 4

=item B<userId> - I<UserId>

=item B<loginToken> - I<LoginToken>

=back

Additionally there are generic tagged parameters.