Skip to content

Peer Info API

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

Peer Info API /peerInfo

Peer Info JSON Entity:

{
  "id" : {
    "type" : "PEER",
    "id" : "Peer1",
    "postfix" : ""
  },
  "deliveryPolicy" : "AT_LEAST_ONE",
  "privacyPolicies" : null,
  "addresses" : [ {
    "peerId" : {
      "type" : "PEER",
      "id" : "545a24b0041063c4bcfec30f",
      "postfix" : ""
    },
    "channelType" : {
      "type" : "CHANNEL",
      "id" : "Email",
      "postfix" : ""
    },
    "contactParameters" : [ "some.email@provider.com" ]
  }, {
    "peerId" : {
      "type" : "PEER",
      "id" : "545a24b0041063c4bcfec30f",
      "postfix" : ""
    },
    "channelType" : {
      "type" : "CHANNEL",
      "id" : "REST",
      "postfix" : ""
    },
    "contactParameters" : [ "http://localhost:8080/peer1" ]
  } ]
}

REST API

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

GET /{id}

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

Parameter:
id required - defines the id of the peer

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