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 .jsv suffix or ?format=jsv

HTTP + JSV

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: text/jsv

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Entities: 
	[
		{
			Key: 0,
			Name: String,
			EntityType: String,
			ParentKey: 0,
			Merchants: 
			[
				{
					Key: 0,
					Name: String,
					EntityType: String,
					ParentKey: 0,
					Merchants: 
					[
						{
							Key: 0,
							Name: String,
							EntityType: String,
							ParentKey: 0
						}
					]
				}
			]
		}
	]
}