Syntch Gateway API

<back to all web services

GetEntityTreeRequest

Entity Relationships
Requires Authentication
Requires the role:Reseller
The following routes are available for this service:
GET/entityrelationshipsGets a list of related resellers and merchants
GetEntityTreeRequest Parameters:
NameParameterData TypeRequiredDescription
ResellerKeyqueryint?NoReseller key to use as the starting point of the hierarchy
GetEntityTreeResult Parameters:
NameParameterData TypeRequiredDescription
EntitiesmodelList<RelatedEntity>NoA collection of entities.
RelatedEntity Parameters:
NameParameterData TypeRequiredDescription
KeyformintNo
NameformstringNo
EntityTypeformstringNo
ParentKeyformint?No
MerchantsformList<RelatedEntity>No

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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/json
HTTP/1.1 200 OK
Content-Type: application/json
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}]}]}]}