Add Solutions Compatibility

3min

Overview
The AddSolnsCompatibility API is designed for developers with apps compatible with multiple solutions. The API allows developers to declare the compatibility of their app with one or more distinct solutions, ensuring seamless subscription to both the app and its associated solutions. For example, if an add-on app for routing is compatible with both DispatchOne and Transport Management Solutions, the developer can use this API to mark its compatibility with both.
Manage Solutions Compatibility
Endpoint
POST /developer/apps/{appid}/compatible-solns
Body Parameters
Parameter
Description
solnIds*﻿
A list of unique IDs corresponding to the solutions compatible with the app. This solutionId will be the GUID of the solution. You can also pass a listingIds to add compatiable solutions.

Example Request
SolnIds
ListingIds
{
	"solnIds": [
		"solution:c49e207d-7595-4b36-a2e7-8d35a96f2712",
		"solution:a23d3f6b-4759-4323-bc84-e2f956a42e14"
	]
}
{
	"solnIds": [
		"solution:c49e207d-7595-4b36-a2e7-8d35a96f2712",
		"solution:a23d3f6b-4759-4323-bc84-e2f956a42e14"
	]
}
﻿
﻿
Developers can use the following endpoints to retrieve compatible solutions, or remove specific solutions from the compatibility list. 
1. Retrieve Compatible Solutions
﻿ GetCompatibleSolutions fetches a list of solutions compatible with a specified app. The response provides a list of all SolnIds that are compatible with the app. Each ID corresponds to a unique solution.
2. Remove Compatible Solutions
﻿RemoveCompatibleSolutions removes specific solutions from the compatibility list, without needing to reconstruct the entire list from scratch.

Parameter	Description
solnIds*	A list of unique IDs corresponding to the solutions compatible with the app. This solutionId will be the GUID of the solution. You can also pass a listingIds to add compatiable solutions.

Updated 29 Feb 2024

Did this page help you?

Update App Attributes

Submit for Review