Skip to content

Collective Info API

Philipp Zeppezauer edited this page Nov 19, 2014 · 1 revision

Collective Info API /collectiveInfo

Collective Info JSON Entity:

{
  "id" : {
    "type" : "COLLECTIVE",
    "id" : "1",
    "postfix" : ""
  },
  "peers" : [ {
    "type" : "PEER",
    "id" : "Peer1",
    "postfix" : ""
  }, {
    "type" : "PEER",
    "id" : "Peer2",
    "postfix" : ""
  } ],
  "deliveryPolicy" : "TO_ALL_MEMBERS"
}

REST API

GET `/{id}` Get the collective info for a collective with a given Id

GET /{id}

Returns a collective info for a collective with a given id. Returns a JSON object of collective info.

Parameter:
id required - defines the id of the collective

Respond:
200 collective info instance is returned in the body 404 there is no collective with such an id