GET api/ApnAdminEntity/List?showInactive={showInactive}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
showInactive

boolean

Default value is False

Body Parameters

None.

Response Information

Resource Description

ApiResultOfListOfEntityListItem
NameDescriptionTypeAdditional information
Response

ApiResponse

None.

Data

Collection of EntityListItem

None.

Response Formats

application/json, text/json

Sample:
{
  "Response": {
    "Success": true,
    "ErrorMessage": "sample string 2"
  },
  "Data": [
    {
      "EntityID": 1,
      "Entity": "sample string 2",
      "EntityCode": "sample string 3",
      "TradingAs": "sample string 4",
      "LegalEntityName": "sample string 5",
      "ParentEntityID": 1,
      "ParentEntity": "sample string 6"
    },
    {
      "EntityID": 1,
      "Entity": "sample string 2",
      "EntityCode": "sample string 3",
      "TradingAs": "sample string 4",
      "LegalEntityName": "sample string 5",
      "ParentEntityID": 1,
      "ParentEntity": "sample string 6"
    }
  ]
}

application/xml, text/xml

Sample:
<ApiResultOfArrayOfEntityListItem289WtATZ xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Debtrak.ApnExtensions">
  <Data xmlns:d2p1="http://schemas.datacontract.org/2004/07/Debtrak.ApnExtensions.Admin">
    <d2p1:EntityListItem>
      <d2p1:Entity>sample string 2</d2p1:Entity>
      <d2p1:EntityCode>sample string 3</d2p1:EntityCode>
      <d2p1:EntityID>1</d2p1:EntityID>
      <d2p1:LegalEntityName>sample string 5</d2p1:LegalEntityName>
      <d2p1:ParentEntity>sample string 6</d2p1:ParentEntity>
      <d2p1:ParentEntityID>1</d2p1:ParentEntityID>
      <d2p1:TradingAs>sample string 4</d2p1:TradingAs>
    </d2p1:EntityListItem>
    <d2p1:EntityListItem>
      <d2p1:Entity>sample string 2</d2p1:Entity>
      <d2p1:EntityCode>sample string 3</d2p1:EntityCode>
      <d2p1:EntityID>1</d2p1:EntityID>
      <d2p1:LegalEntityName>sample string 5</d2p1:LegalEntityName>
      <d2p1:ParentEntity>sample string 6</d2p1:ParentEntity>
      <d2p1:ParentEntityID>1</d2p1:ParentEntityID>
      <d2p1:TradingAs>sample string 4</d2p1:TradingAs>
    </d2p1:EntityListItem>
  </Data>
  <Response>
    <ErrorMessage>sample string 2</ErrorMessage>
    <Success>true</Success>
  </Response>
</ApiResultOfArrayOfEntityListItem289WtATZ>