POST api/EntityClient/GetEntityForList?businessId={businessId}&showInactive={showInactive}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
businessId

integer

Required

showInactive

boolean

Required

Body Parameters

None.

Response Information

Resource Description

EntityForListVM
NameDescriptionTypeAdditional information
EntityForList

Collection of EntityForList

None.

NumberOfResults

integer

None.

Response

IResponse

None.

Response Formats

application/json, text/json

Sample:
{
  "EntityForList": [
    {
      "EntityID": 1,
      "Entity": "sample string 2"
    },
    {
      "EntityID": 1,
      "Entity": "sample string 2"
    }
  ],
  "NumberOfResults": 1,
  "Response": null
}

application/xml, text/xml

Sample:
<EntityForListVM xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Debtrak.BusinessObjects.ViewModels.Entry">
  <Response i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/Debtrak.BusinessObjects.ViewModels" />
  <EntityForList xmlns:d2p1="http://schemas.datacontract.org/2004/07/Debtrak.BusinessObjects.Models.Entity">
    <d2p1:EntityForList>
      <d2p1:Entity>sample string 2</d2p1:Entity>
      <d2p1:EntityID>1</d2p1:EntityID>
    </d2p1:EntityForList>
    <d2p1:EntityForList>
      <d2p1:Entity>sample string 2</d2p1:Entity>
      <d2p1:EntityID>1</d2p1:EntityID>
    </d2p1:EntityForList>
  </EntityForList>
  <NumberOfResults>1</NumberOfResults>
</EntityForListVM>