Overview
Returns the VBT type set for Group, Division, Organization or Company level.
Syntax
C#
[OperationContractAttribute()] SBT.API.DataContracts.Admin.WSVerificationTypeResponse ReadVerificationType( string securityToken, string orgCode)
WSDL
Production: https://ui.solutionsbytext.com/Sbt.App.SetUp/wsservices/GeneralWSService.svc?singlewsdl
Staging: https://test.solutionsbytext.com/Sbt.App.SetUp/wsservices/GeneralWSService.svc?singlewsdl
Parameters
securityToken
- String[1000] (Required) - Security Token to authenticate the user
orgCode
- String[20] (Required) - Organization Code for the group, division, organization or company.
Return Value
WSVerificationTypeResponse
Name | Type | Description |
---|---|---|
Result | bool | True/False whether the call was successful or not. |
ErrorCode | int | For Success/Failure it returns an error number. |
Message | string | Message related to rrror code. |
VerificationType | string | This will return verification type for the organization (E.g. PIN, Reserved Word or None). |
Example
C#
lblError.Text = ""; GroupClient generalService = new GroupClient("ReportWSServiceHttpEndpoint2"); string securityToken = txtToken.Text; string orgCode = txtOrgCode.Text; WSVerificationTypeResponse wSVerificationTypeResponse = generalService.ReadVerificationType(securityToken, orgCode); if (!wSVerificationTypeResponse.Result) { //handle error lblError.Text = wSVerificationTypeResponse.Message; } else { //handle success lblError.Text = wSVerificationTypeResponse.Message; }
SOAP
Soap Request <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://SBTService/ServiceContracts/"> <soapenv:Header/> <soapenv:Body> <ser:ReadVerificationType> <!--Required:--> <ser:securityToken>Security Token</ser:securityToken> <!--Required:--> <ser:orgCode>Org Code</ser:orgCode> </ser:ReadVerificationType> </soapenv:Body> </soapenv:Envelope> Soap Response <s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"> <s:Body> <ReadVerificationTypeResponse xmlns="http://SBTService/ServiceContracts/"> <ReadVerificationTypeResult z:Id="i1" xmlns:a="http://SBTAPIService/DataContract/" xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns:z="http://schemas.microsoft.com/2003/10/Serialization/"> <a:Result>true</a:Result> <a:ErrorCode>1455</a:ErrorCode> <a:Message>Successfully read verification type</a:Message> <a:VerficationType>Pin/Reservedword/None</a:VerficationType> </ReadVerificationTypeResult> </ReadVerificationTypeResponse> </s:Body> </s:Envelope>
PHP
<?php $client = new SoapClient("https://ui.solutionsbytext.com/Sbt.App.SetUp/WSServices/GeneralWSService.svc?wsdl"); $param = array( 'securityToken' => 'securityToken', 'orgCode' => 'orgCode' ); $response = $client->__soapCall('ReadVerificationType', array($param)); echo '<pre/>'; print_r($response); if($response->GetReadVerificationTypeResult->Result){ echo 'Message: '.$response->GetReadVerificationTypeResult->Message; } else { echo 'Message: '.$response->GetReadVerificationTypeResult->Message; } ?>
REST
Method: GET
Response:
The response will be in JSON format like below: {" ReadVerificationTypeResult": { "Result": true, "ErrorCode": 1455, "Message": " Successfully read verification type", "VerificationType": " Pin" }}