GetBundleType


 

Overview

Quick Links

Retrieves Bundle Types from the system based on the BundleType key. 


Resource Information



Request FormatXML
Response FormatXML

Request Header

NameTypeDescription
StringStringAuthentication Token

Request Body

NameTypeDescription
bundleTypeKey
StringThe key of the BundleType to retrieve



Response

NameTypeDescription
ResultBundleType
The actual result. The BundleType with the specified key.
ResultCodeStringString indicating the result. Either "Success" or "Error".
ResultMessageStringEmpty when call successful, error message otherwise.

In the case of an internal unhandled fault, a Fault object is returned instead. Providing information on what occurred exactly.

Examples

Note that these examples use V1.3.2 of the API and the token authentication flow.

Request

<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
    <Header xmlns:t="http://api.cloudbilling.nl/2018/11/auth/token"><t:ApiToken>TOKEN</t:ApiToken></Header>
    <Body>
        <GetBundleType xmlns="api.billing.inter8.V1_3_2">
            <bundleTypeKey>Key</bundleTypeKey>
        </GetBundleType>
    </Body>
</Envelope>

Response

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
    <s:Body>
        <GetBundleTypeResponse xmlns="api.billing.inter8.V1_3_2">
            <GetBundleTypeResult xmlns:a="http://schemas.datacontract.org/2004/07/Kolonel.Public.Service.API.Contracts.V1_3_2" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
                <a:Result>
                    <a:BundlePrioritySequence>0</a:BundlePrioritySequence>
                    <a:BundleTypeItems>
                        <a:BundleTypeItem>
                            <a:AllowFractions>true</a:AllowFractions>
                            <a:InBundleCost>0</a:InBundleCost>
                            <a:InBundleCostExpression i:nil="true"/>
                            <a:InBundleRate>0</a:InBundleRate>
                            <a:InBundleRateExpression i:nil="true"/>
                            <a:ProductClusterId>534d3e76ef4f893f00f02628</a:ProductClusterId>
                            <a:ProductClusterTagName>National Data</a:ProductClusterTagName>
                            <a:TraverseProductCluster>true</a:TraverseProductCluster>
                            <a:WeightFactor>1</a:WeightFactor>
                            <a:WeightFactorExpression i:nil="true"/>
                        </a:BundleTypeItem>
                    </a:BundleTypeItems>
                    <a:BundleTypeKey>Key</a:BundleTypeKey>
                    <a:Id>534e5cfbef4f895254d34788</a:Id>
                </a:Result>
                <a:ResultCode>Success</a:ResultCode>
                <a:ResultMessage/>
            </GetBundleTypeResult>
        </GetBundleTypeResponse>
    </s:Body>
</s:Envelope>