GroupTreeService

<back to all web services

GroupTreeRequest

Requires Authentication
The following routes are available for this service:
POST/grouptree/{Id}
GroupTreeRequest Parameters:
NameParameterData TypeRequiredDescription
IdpathlongNo
EntityRelationCategoryIdsbodyList<long>No
GroupTreeResponse Parameters:
NameParameterData TypeRequiredDescription
ResultformGroupTreeDataNo
GroupTreeData Parameters:
NameParameterData TypeRequiredDescription
BaseIdformlongNo
EntitiesformList<Entity>No
EntityRelationsformList<EntityRelation>No
Entity Parameters:
NameParameterData TypeRequiredDescription
IDformlongNo
TypeIDformlongNo
CVRNumberformlong?No
PNumberformlong?No
NameformstringNo
AddressformstringNo
PostalCodeIDformlong?No
CityformstringNo
CountryIDformlong?No
CountryformstringNo
AddressFreeTextformstringNo
KVHXformstringNo
StartdateformDateTime?No
EnddateformDateTime?No
StatusIDformlong?No
StatusformstringNo
CreditorStatusInformationIDformlong?No
CreditorStatusInformationformstringNo
CreditorStatusIDformlong?No
CreditorStatusformstringNo
LegalformIDformlong?No
LegalformformstringNo
AdvertisingProtectedformbool?No
EntityRelation Parameters:
NameParameterData TypeRequiredDescription
CategoryIDformlongNo
TypeIDformlongNo
BaseIDformlongNo
ParentIDformlongNo
ChildIDformlongNo
FromDateformDateTime?No
ToDateformDateTime?No
AttributsformDictionary<string, string>No
RelationTagformstringNo
LinkCounterformintNo

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.

POST /jsv/reply/GroupTreeRequest HTTP/1.1 
Host: groupservice.idq01.com 
Content-Type: text/jsv
Content-Length: length

{
	Id: 0,
	EntityRelationCategoryIds: 
	[
		0
	]
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Result: 
	{
		BaseId: 0,
		Entities: 
		[
			{
				
			}
		],
		EntityRelations: 
		[
			{
				CategoryID: 0,
				TypeID: 0,
				BaseID: 0,
				ParentID: 0,
				ChildID: 0,
				FromDate: 0001-01-01,
				ToDate: 0001-01-01,
				Attributs: 
				{
					String: String
				},
				RelationTag: String,
				LinkCounter: 0
			}
		]
	}
}