GET ipbs/all/entities

All Entities

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

CRMEntitiesNested

Name	Description	Type	Additional information
Entity		CRMEntity	None.
EntityRelationships		Collection of CRMIndividualRelationship	None.

Response Formats

application/json, text/json

Sample:

{
  "Entity": {
    "EntityID": "sample string 1",
    "BaseCurrency": "sample string 2",
    "EntityName": "sample string 3",
    "MarkedAs": "sample string 4",
    "ProductType": "sample string 5",
    "DateOfCreation": "2025-04-03T23:42:04.713747-04:00",
    "LastModifiedDate": "2025-04-03T23:42:04.713747-04:00",
    "TerminateDate": "2025-04-03T23:42:04.713747-04:00"
  },
  "EntityRelationships": [
    {
      "EntityID": "sample string 1",
      "KYCID": 2,
      "RoleId": 3,
      "RoleDescription": "sample string 4",
      "MarkedAs": "sample string 5",
      "ProductType": "sample string 6",
      "ProductDescription": "sample string 7"
    },
    {
      "EntityID": "sample string 1",
      "KYCID": 2,
      "RoleId": 3,
      "RoleDescription": "sample string 4",
      "MarkedAs": "sample string 5",
      "ProductType": "sample string 6",
      "ProductDescription": "sample string 7"
    }
  ]
}

text/xml

Sample:

<CRMEntitiesNested xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IPBSAPIV1">
  <Entity>
    <BaseCurrency>sample string 2</BaseCurrency>
    <DateOfCreation>2025-04-03T23:42:04.713747-04:00</DateOfCreation>
    <EntityID>sample string 1</EntityID>
    <EntityName>sample string 3</EntityName>
    <LastModifiedDate>2025-04-03T23:42:04.713747-04:00</LastModifiedDate>
    <MarkedAs>sample string 4</MarkedAs>
    <ProductType>sample string 5</ProductType>
    <TerminateDate>2025-04-03T23:42:04.713747-04:00</TerminateDate>
  </Entity>
  <EntityRelationships>
    <CRMIndividualRelationship>
      <EntityID>sample string 1</EntityID>
      <KYCID>2</KYCID>
      <MarkedAs>sample string 5</MarkedAs>
      <ProductDescription>sample string 7</ProductDescription>
      <ProductType>sample string 6</ProductType>
      <RoleDescription>sample string 4</RoleDescription>
      <RoleId>3</RoleId>
    </CRMIndividualRelationship>
    <CRMIndividualRelationship>
      <EntityID>sample string 1</EntityID>
      <KYCID>2</KYCID>
      <MarkedAs>sample string 5</MarkedAs>
      <ProductDescription>sample string 7</ProductDescription>
      <ProductType>sample string 6</ProductType>
      <RoleDescription>sample string 4</RoleDescription>
      <RoleId>3</RoleId>
    </CRMIndividualRelationship>
  </EntityRelationships>
</CRMEntitiesNested>