GET api/superentities/{superEntityId}/chargecodesusabilities
Returns charge codes assigned to the super entity along with information whether these codes are used in any of the following: - As base charge code for any of the buildings assigned to super entity - Recurring Charges - Late Fees - Chargebacks
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
superEntityId |
|
integer |
Required |
Body Parameters
None.
Response Information
Resource Description
Collection of ChargeCodeUsabilityViewModelName | Description | Type | Additional information |
---|---|---|---|
CCId |
|
integer |
None. |
Usabilities |
|
Collection of UsabilityViewModelOfChargeCodeUsabilityEnum |
None. |
InUse |
|
boolean |
None. |
Response Formats
application/json, text/json
Sample:
[ { "ccId": 1, "usabilities": [ { "type": 1, "name": "sample string 1", "description": "sample string 2" }, { "type": 1, "name": "sample string 1", "description": "sample string 2" } ], "inUse": true }, { "ccId": 1, "usabilities": [ { "type": 1, "name": "sample string 1", "description": "sample string 2" }, { "type": 1, "name": "sample string 1", "description": "sample string 2" } ], "inUse": true } ]
application/xml, text/xml
Sample:
<ArrayOfChargeCodeUsabilityViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels.ChargeCode"> <ChargeCodeUsabilityViewModel> <CCId>1</CCId> <Usabilities xmlns:d3p1="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels"> <d3p1:UsabilityViewModelOfChargeCodeUsabilityEnumgQIAKJ21> <d3p1:Description>sample string 2</d3p1:Description> <d3p1:Name>sample string 1</d3p1:Name> <d3p1:Type>BuildingBaseChargeCode</d3p1:Type> </d3p1:UsabilityViewModelOfChargeCodeUsabilityEnumgQIAKJ21> <d3p1:UsabilityViewModelOfChargeCodeUsabilityEnumgQIAKJ21> <d3p1:Description>sample string 2</d3p1:Description> <d3p1:Name>sample string 1</d3p1:Name> <d3p1:Type>BuildingBaseChargeCode</d3p1:Type> </d3p1:UsabilityViewModelOfChargeCodeUsabilityEnumgQIAKJ21> </Usabilities> </ChargeCodeUsabilityViewModel> <ChargeCodeUsabilityViewModel> <CCId>1</CCId> <Usabilities xmlns:d3p1="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels"> <d3p1:UsabilityViewModelOfChargeCodeUsabilityEnumgQIAKJ21> <d3p1:Description>sample string 2</d3p1:Description> <d3p1:Name>sample string 1</d3p1:Name> <d3p1:Type>BuildingBaseChargeCode</d3p1:Type> </d3p1:UsabilityViewModelOfChargeCodeUsabilityEnumgQIAKJ21> <d3p1:UsabilityViewModelOfChargeCodeUsabilityEnumgQIAKJ21> <d3p1:Description>sample string 2</d3p1:Description> <d3p1:Name>sample string 1</d3p1:Name> <d3p1:Type>BuildingBaseChargeCode</d3p1:Type> </d3p1:UsabilityViewModelOfChargeCodeUsabilityEnumgQIAKJ21> </Usabilities> </ChargeCodeUsabilityViewModel> </ArrayOfChargeCodeUsabilityViewModel>