Syntch Gateway API

GetEntityTreeRequest

Entity Relationships

**Requires Authentication**
Requires the role:	Reseller

The following routes are available for this service:
GET	/entityrelationships	Gets a list of related resellers and merchants

**GetEntityTreeRequest** Parameters:
Name	Parameter	Data Type	Required	Description
ResellerKey	query	int?	No	Reseller key to use as the starting point of the hierarchy

**GetEntityTreeResult** Parameters:
Name	Parameter	Data Type	Required	Description
Entities	model	List<RelatedEntity>	No	A collection of entities.

**RelatedEntity** Parameters:
Name	Parameter	Data Type	Required
Key	form	int	No
Name	form	string	No
EntityType	form	string	No
ParentKey	form	int?	No
Merchants	form	List<RelatedEntity>	No

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /entityrelationships HTTP/1.1 
Host: syntch.simpay.net 
Accept: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GetEntityTreeResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Gateway.RestApi.EntityRelationships.BindingModels">
  <Entities>
    <RelatedEntity>
      <EntityType>String</EntityType>
      <Key>0</Key>
      <Merchants>
        <RelatedEntity>
          <EntityType>String</EntityType>
          <Key>0</Key>
          <Merchants>
            <RelatedEntity>
              <EntityType>String</EntityType>
              <Key>0</Key>
              <Merchants i:nil="true" />
              <Name>String</Name>
              <ParentKey>0</ParentKey>
            </RelatedEntity>
          </Merchants>
          <Name>String</Name>
          <ParentKey>0</ParentKey>
        </RelatedEntity>
      </Merchants>
      <Name>String</Name>
      <ParentKey>0</ParentKey>
    </RelatedEntity>
  </Entities>
</GetEntityTreeResult>