Software token endpoints
AllocateSoftware
AllocateSoftware(System.Int32,DataLayer.Entity.Transaction.BillingStyle,System.Boolean,System.Boolean,System.String)
Allocate software tokens to a child account. This is for MP tokens only. (SMS tokens are MP tokens issued to an SMS end point.)
Parameters
Param: quantity: Number of tokens to allocate
Param: billingStyle: Billing style of the allocation: Allocation, Activation, Authentication or Transfer
Param: withCapacity: True to automatically add license capacity with the tokens
Param: isSale: True if this is a sale, false for rental.
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/AllocateSoftware"
<?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>
<AllocateSoftware xmlns="http://www.cryptocard.com/blackshield/">
<quantity>int</quantity>
<billingStyle>Allocation or Activation or Authentication or Transfer</billingStyle>
<withCapacity>boolean</withCapacity>
<isSale>boolean</isSale>
<toOrganization>string</toOrganization>
</AllocateSoftware>
</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>
<AllocateSoftwareResponse xmlns="http://www.cryptocard.com/blackshield/">
<AllocateSoftwareResult>boolean</AllocateSoftwareResult>
</AllocateSoftwareResponse>
</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>
<AllocateSoftware xmlns="http://www.cryptocard.com/blackshield/">
<quantity>int</quantity>
<billingStyle>Allocation or Activation or Authentication or Transfer</billingStyle>
<withCapacity>boolean</withCapacity>
<isSale>boolean</isSale>
<toOrganization>string</toOrganization>
</AllocateSoftware>
</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>
<AllocateSoftwareResponse xmlns="http://www.cryptocard.com/blackshield/">
<AllocateSoftwareResult>boolean</AllocateSoftwareResult>
</AllocateSoftwareResponse>
</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/AllocateSoftware?quantity=string&billingStyle=string&withCapacity=string&isSale=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/AllocateSoftware HTTP/1.1
Host: cloud.eu.safenetid.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length
quantity=string&billingStyle=string&withCapacity=string&isSale=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>
DeallocateSoftware
DeallocateSoftware(System.Int32,ControlLibrary.AccountsControl.TokensSelection,System.Boolean,System.Boolean,System.String,System.String)
De-allocate software tokens from a child account. This is for MP tokens only. (SMS tokens are MP tokens issued to an SMS end point.)
Parameters
Param: quantity: Number of tokens to de-allocate
Param: deallocationState: State to return tokens to: ReturntoInventory_Initialized, ReturntoInventory_NotInitialized, Faulty, Lost
Param: withCapacity: True to automatically include capacity
Param: isSale: True if tokens are being sold back up the chain.
Param: intoContainer: Container to place the tokens into
Param: fromOrganization: Account to move tokens from
Returns:
- True if tokens are 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/DeallocateSoftware"
<?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>
<DeallocateSoftware xmlns="http://www.cryptocard.com/blackshield/">
<quantity>int</quantity>
<deallocationState>ReturntoInventory_Initialized or ReturntoInventory_NotInitialized or Faulty or Lost</deallocationState>
<withCapacity>boolean</withCapacity>
<isSale>boolean</isSale>
<intoContainer>string</intoContainer>
<fromOrganization>string</fromOrganization>
</DeallocateSoftware>
</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>
<DeallocateSoftwareResponse xmlns="http://www.cryptocard.com/blackshield/">
<DeallocateSoftwareResult>boolean</DeallocateSoftwareResult>
</DeallocateSoftwareResponse>
</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>
<DeallocateSoftware xmlns="http://www.cryptocard.com/blackshield/">
<quantity>int</quantity>
<deallocationState>ReturntoInventory_Initialized or ReturntoInventory_NotInitialized or Faulty or Lost</deallocationState>
<withCapacity>boolean</withCapacity>
<isSale>boolean</isSale>
<intoContainer>string</intoContainer>
<fromOrganization>string</fromOrganization>
</DeallocateSoftware>
</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>
<DeallocateSoftwareResponse xmlns="http://www.cryptocard.com/blackshield/">
<DeallocateSoftwareResult>boolean</DeallocateSoftwareResult>
</DeallocateSoftwareResponse>
</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/DeallocateSoftware?quantity=string&deallocationState=string&withCapacity=string&isSale=string&intoContainer=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/DeallocateSoftware HTTP/1.1
Host: cloud.eu.safenetid.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length
quantity=string&deallocationState=string&withCapacity=string&isSale=string&intoContainer=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>
