SMS endpoints
AllocateSMSCredits
AllocateSMSCredits(System.Int32,DataLayer.Entity.Transaction.BillingStyle,System.String)
Allocate SMS credits to a child account. SMS credits are not only required for SMS tokens, but for all SMS notification generated by the system. If your account has it's own SMS configuration, allocation of SMS credits does not require SMS credits.
Parameters
Param: quantity: Number of credits to allocate
Param: billingStyle: Billing style of the allocation: Allocation, Activation, Authentication or Transfer
Param: toOrganization: Account to allocate to
Returns:
- True if allocated successfully
SOAP 1.1 sample
The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.
Request:
POST /bsidca/BSIDCA.asmx HTTP/1.1
Host: cloud.eu.safenetid.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.cryptocard.com/blackshield/AllocateSMSCredits"
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<AllocateSMSCredits xmlns="http://www.cryptocard.com/blackshield/">
<quantity>int</quantity>
<billingStyle>Allocation or Activation or Authentication or Transfer</billingStyle>
<toOrganization>string</toOrganization>
</AllocateSMSCredits>
</soap:Body>
</soap:Envelope>
Response:
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<AllocateSMSCreditsResponse xmlns="http://www.cryptocard.com/blackshield/">
<AllocateSMSCreditsResult>boolean</AllocateSMSCreditsResult>
</AllocateSMSCreditsResponse>
</soap:Body>
</soap:Envelope>
SOAP 1.2 sample
The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.
Request:
POST /bsidca/BSIDCA.asmx HTTP/1.1
Host: cloud.eu.safenetid.com
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<AllocateSMSCredits xmlns="http://www.cryptocard.com/blackshield/">
<quantity>int</quantity>
<billingStyle>Allocation or Activation or Authentication or Transfer</billingStyle>
<toOrganization>string</toOrganization>
</AllocateSMSCredits>
</soap12:Body>
</soap12:Envelope>
Response:
HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<AllocateSMSCreditsResponse xmlns="http://www.cryptocard.com/blackshield/">
<AllocateSMSCreditsResult>boolean</AllocateSMSCreditsResult>
</AllocateSMSCreditsResponse>
</soap12:Body>
</soap12:Envelope>
HTTP GET sample
The following is a sample HTTP GET request and response. The placeholders shown need to be replaced with actual values.
Request:
GET /bsidca/BSIDCA.asmx/AllocateSMSCredits?quantity=string&billingStyle=string&toOrganization=string HTTP/1.1
Host: cloud.eu.safenetid.com
Response:
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<boolean xmlns="http://www.cryptocard.com/blackshield/">boolean</boolean>
HTTP POST sample
The following is a sample HTTP POST request and response. The placeholders shown need to be replaced with actual values.
Request:
POST /bsidca/BSIDCA.asmx/AllocateSMSCredits HTTP/1.1
Host: cloud.eu.safenetid.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length
quantity=string&billingStyle=string&toOrganization=string
Response:
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<boolean xmlns="http://www.cryptocard.com/blackshield/">boolean</boolean>
DeallocateSMSCredits
DeallocateSMSCredits(System.Int32,System.String)
De-allocate SMS credits from a child account.
Parameters
Param: quantity: Number of credits to de-allocate
Param: fromOrganization: Account to take the credits from
Returns:
- True if the credits have been de-allocated
SOAP 1.1 sample
The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.
Request:
POST /bsidca/BSIDCA.asmx HTTP/1.1
Host: cloud.eu.safenetid.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.cryptocard.com/blackshield/DeallocateSMSCredits"
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<DeallocateSMSCredits xmlns="http://www.cryptocard.com/blackshield/">
<quantity>int</quantity>
<fromOrganization>string</fromOrganization>
</DeallocateSMSCredits>
</soap:Body>
</soap:Envelope>
Response:
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<DeallocateSMSCreditsResponse xmlns="http://www.cryptocard.com/blackshield/">
<DeallocateSMSCreditsResult>boolean</DeallocateSMSCreditsResult>
</DeallocateSMSCreditsResponse>
</soap:Body>
</soap:Envelope>
SOAP 1.2 sample
The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.
Request:
POST /bsidca/BSIDCA.asmx HTTP/1.1
Host: cloud.eu.safenetid.com
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<DeallocateSMSCredits xmlns="http://www.cryptocard.com/blackshield/">
<quantity>int</quantity>
<fromOrganization>string</fromOrganization>
</DeallocateSMSCredits>
</soap12:Body>
</soap12:Envelope>
Response:
HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<DeallocateSMSCreditsResponse xmlns="http://www.cryptocard.com/blackshield/">
<DeallocateSMSCreditsResult>boolean</DeallocateSMSCreditsResult>
</DeallocateSMSCreditsResponse>
</soap12:Body>
</soap12:Envelope>
HTTP GET sample
The following is a sample HTTP GET request and response. The placeholders shown need to be replaced with actual values.
Request:
GET /bsidca/BSIDCA.asmx/DeallocateSMSCredits?quantity=string&fromOrganization=string HTTP/1.1
Host: cloud.eu.safenetid.com
Response:
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<boolean xmlns="http://www.cryptocard.com/blackshield/">boolean</boolean>
HTTP POST sample
The following is a sample HTTP POST request and response. The placeholders shown need to be replaced with actual values.
Request:
POST /bsidca/BSIDCA.asmx/DeallocateSMSCredits HTTP/1.1
Host: cloud.eu.safenetid.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length
quantity=string&fromOrganization=string
Response:
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<boolean xmlns="http://www.cryptocard.com/blackshield/">boolean</boolean>
RequestSMS
RequestSMS(System.String,System.String,System.String)
Used to request that a new SMS message be sent to a user. This requires their PIN for validation.
Parameters
Param: userName: User the SMS is for
Param: PIN: PIN of the SMS token
Param: organization: Account
Returns
True if an SMS message has been sent
SOAP 1.1 sample
The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.
Request:
POST /bsidca/BSIDCA.asmx HTTP/1.1
Host: cloud.safenet-inc.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.cryptocard.com/blackshield/RequestSMS"
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<RequestSMS xmlns="http://www.cryptocard.com/blackshield/">
<userName>string</userName>
<PIN>string</PIN>
<organization>string</organization>
</RequestSMS>
</soap:Body>
</soap:Envelope>
Response:
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<RequestSMSResponse xmlns="http://www.cryptocard.com/blackshield/">
<RequestSMSResult>boolean</RequestSMSResult>
</RequestSMSResponse>
</soap:Body>
</soap:Envelope>
SOAP 1.2 sample
The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.
Request:
POST /bsidca/BSIDCA.asmx HTTP/1.1
Host: cloud.safenet-inc.com
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<RequestSMS xmlns="http://www.cryptocard.com/blackshield/">
<userName>string</userName>
<PIN>string</PIN>
<organization>string</organization>
</RequestSMS>
</soap12:Body>
</soap12:Envelope>
Response:
HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<RequestSMSResponse xmlns="http://www.cryptocard.com/blackshield/">
<RequestSMSResult>boolean</RequestSMSResult>
</RequestSMSResponse>
</soap12:Body>
</soap12:Envelope>
HTTP GET sample
The following is a sample HTTP GET request and response. The placeholders shown need to be replaced with actual values.
Request:
GET /bsidca/BSIDCA.asmx/RequestSMS?userName=string&PIN=string&organization=string HTTP/1.1
Host: cloud.safenet-inc.com
Response:
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<boolean xmlns="http://www.cryptocard.com/blackshield/">boolean</boolean>
HTTP POST sample
The following is a sample HTTP POST request and response. The placeholders shown need to be replaced with actual values.
Request:
POST /bsidca/BSIDCA.asmx/RequestSMS HTTP/1.1
Host: cloud.safenet-inc.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length
userName=string&PIN=string&organization=string
Response:
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<boolean xmlns="http://www.cryptocard.com/blackshield/">boolean</boolean>
