Get the Organization Hierarchy for an Account

get

/bcws/webresources/v1.0/accounts/hierarchy/{id}

Gets the organization hierarchy for the account that matches the specified ID.

Request

Path Parameters
Query Parameters

There's no request body for this operation.

Back to Top

Response

Supported Media Types

200 Response

The account's organization hierarchy was returned successfully.
Body ()
Root Schema : organizationHierarchy
Type: object
Show Source
Nested Schema : children
Type: array
The list of child accounts in the organization hierarchy.
Show Source
Nested Schema : extension
Type: object
The extended attributes.
Nested Schema : parent
Type: object
The parent in the organization hierarchy.
Show Source
Nested Schema : children
Type: object
The list of child accounts in the organization hierarchy.
Show Source
Nested Schema : extension
Type: object
The extended attributes.
Nested Schema : extension
Type: object
The extended attributes.

500 Response

An internal server error occurred.
Back to Top

Examples

This example shows how to get information about the organization hierarchy that the specified account belongs to by submitting a GET request on the REST resource using cURL. For more information about cURL, see "Use cURL".

cURL Command

curl -X GET 'http://hostname:port/bcws/webresources/version/accounts/hierarchy/0.0.0.1+-account+261427'

where:

  • hostname is the URL for the Billing Care REST server.
  • port is the port for the Billing Care REST server.
  • version is the version of the API you're using, such as v1.0.

Example of Response Body

This example shows the contents of the response body in JSON format.

{
    "extension": null,
    "accountId": "0.0.0.1+-account+261427",
    "address": "500 Oracle Parkway",
    "city": "Redwood Shores",
    "company": "Vision Corporation",
    "country": "US",
    "firstName": "Joe",
    "lastName": "Smith",
    "middleName": "",
    "state": "CA",
    "zip": "94065",
    "accountNumber": "0.0.0.1-261427",
    "parent": {
        "extension": null,
        "accountId": "0.0.0.1+-account+149726",
        "address": "No. 3, Bannerghatta Road",
        "city": "Bengaluru",
        "company": "Vision Corporation",
        "country": "INDIA",
        "firstName": "Ananya",
        "lastName": "Patel",
        "middleName": "",
        "state": "ka",
        "zip": "560029",
        "accountNumber": "0.0.0.1-149726",
        "parent": null,
        "organizationHierarchyType": 0
    },
    "children": [],
    "organizationHierarchyType": 0,
    "numberOfDirectChildren": 1
}
Back to Top