Api session event participant net cluster set state

From Tygron Support wiki
Jump to navigation Jump to search

API Endpoint: api/session/event/participant/net_cluster_set_state/

Description: Set Timestate for all Net Load of Net Cluster.

Name Importance Type Description Values
0 REQUIRED (STAKEHOLDER Integer ID) Initiating Stakeholder ID
1 REQUIRED (NET_CLUSTER Integer ID) Net Cluster ID
2 REQUIRED (Enumeration) Timestate (NOTHING, REQUEST_CONSTRUCTION_APPROVAL, REQUEST_ZONING_APPROVAL, READY) CONSTRUCTING, CONSTRUCTION_APPROVED, CONSTRUCTION_DENIED, DEMOLISH_APPROVED, DEMOLISH_DENIED, DEMOLISH_FINISHED, DEMOLISHING, NOTHING, PENDING_CONSTRUCTION, PENDING_DEMOLISHING, PENDING_UPGRADE, READY, REQUEST_CONSTRUCTION_APPROVAL, REQUEST_DEMOLISH_APPROVAL, REQUEST_DEMOLISH_ZONING_APPROVAL, REQUEST_PLOT_OWNER_APPROVAL, REQUEST_ZONING_APPROVAL, WAITING_FOR_DATE or WAITING_FOR_DEMOLISH_DATE

Response Codes

Response Code: Description
204 No Content
300-600 Codes Overview

Example POST

Curl example POST:

curl 'https://engine.tygron.com/api/session/event/participant/net_cluster_set_state/' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '[ 1, 1, "NOTHING" ]'

JavaScript example POST:

var options = {
 method: "POST",
 headers: { "Content-Type": "application/json", "Authorization": "Bearer API_TOKEN" },
 body: '[ 1, 1, "NOTHING" ]'
};
fetch("https://engine.tygron.com/api/session/event/participant/net_cluster_set_state/", options)
 .then(response => response.text())
 .then(result => console.log(result))
 .catch(error => console.log('error', error));