networkIdstring(uuid)required
Network Id
intermediaryExternalIdstringrequired
Intermediary Id
Delete an intermediary
delete
Path Parameters
Response
Response
The intermediary is successfully deleted.
delete/intermediaries/{networkId}/{intermediaryExternalId}
Authentication
Path Parameters
Check healthness of api
get
Response
Response
Api is healthy
get/healthcheck
Authentication
Get networks
get
Query Parameters
pageSizeinteger(int32)required
>= 0<= 200
Example:10
pageNumberinteger(int32)required
>= 1<= 200
Example:1
Response
application/json
Response
application/json
0 or more networks are found and retrieved.
PaginatedNetworksResponse
* Additional properties are NOT allowed.
itemsarray | null[object]
* Additional properties are NOT allowed.
Show Child Parameters
totalinteger(int32)
get/networks
Authentication
Query Parameters
application/json
Get a network by Id
get
Path Parameters
networkIdstring(uuid)required
Network Id
Response
application/json
Response
application/json
The network is found and retrieved.
NetworkResponse
* Additional properties are NOT allowed.
idstring(uuid)
namestring | null
networkTypestring
Allowed values:IntegratedNetworkSalesAgentNetworkWithoutTCardSalesAgentNetworkWithTCardFranchiseOrLicenseeCooperativeGroupPortalForNotariesOrBailiffsHybridNetworkAdvertisingAgencyTechnicalRelationshipSyndicate
authorizedMembersCategoriesarray | null[string]
get/networks/{networkId}
Authentication
Path Parameters
application/json
Activity
object * Additional properties are NOT allowed.
languagesarray[object]required
* Additional properties are NOT allowed.
Show Child Parameters
Example