Community Tools

Community Tools

APIS

METHOD	API	Desc
GET	/communitytools/:domainname/	GET all tools and their actions and activity events for a given domain
GET	/communitytools/:domainname/tools/:toolid	GET all details for a given tool of a domain
POST	/communitytools/:domainname/tools/:toolid	POST tool name and id, actions, avatar and purpose for a particular domain
PATCH	/communitytools/:domainname/tools/:toolid	Edit details for a given tool of a domain

1.GET all tools and their details for a given domain

URI

HTTP GET /api/v1/communitytools/:domainname

URI Params

Required:

  domainname[text]

Data Params

  None

Success Response

Code : 200

Content : {

"domain": "somedomain",
"tools": [
    {
        "toolid": "somdeid1",
        "actions": [
            "action1",
            "action3",
            "action4",
            "action5"
        ],
        "createdon": "2017-07-19T12:01:26.857Z",
        "updatedon": "2017-07-19T12:01:26.857Z",
        "toolname": "sometool",
        "purpose": "maybesomepurposeagain2",
        "avatar": "somephoto.jpg"
    }
]

}

 OR 
 []

Error Response

    Code :  400 Bad Request
    Content : { error: 'Unexpected Error Occured' }
  OR
    Code : 500 Internal Server error
    Content :{error: 'Internal Error occured'}

2.GET all details for a given tool of a domain

URI

HTTP GET /api/v1/communitytools/:domainname/tools/:toolid

URI Params

Required:

  domainname[text]
  toolid[text]

Data Params

  None

Success Response:

Code : 200

Content : {

"domain": "somedomain",
"toolid": "someid1",
"events": [
    {
        "eventid": "evid",
        "eventname": "evname",
        "description": "evdescription",
        "activity": "somecommunityevent",
        "metadata": "someurldatamaybe"
    },
    {
        "eventid": "evid2",
        "eventname": "evname2",
        "description": "evdescriptiond2",
        "activity": "somecommunityevent2",
        "metadata": "someurldatamaybe2"
    }
],
"toolname": "sometool",
"avatar": "somephoto.jpg",
"toolurl": "abcdef.com/12345",
"actions": [
    "action1",
    "action3",
    "action4",
    "action5"
],
"updatedon": "2017-07-19T12:01:26.857Z"
}

Error Response

    Code :  400 Bad Request
    Content : { error: 'Unexpected error occurred, please try again...!' }
  OR
    Code :  400 Bad Request
    Content :{error:'Please enter a valid tool name'}
  OR
    Code : 505 Internal Server error
    Content :{error: 'Internal Error occured'}

3. POST tool name and id, actions, avatar and purpose events for a particular domain

URI

HTTP POST /api/v1/communitytools/:domainname/tools/:toolid

URI Params

Required:

  domainname[text] toolname[text]

Data Params

  {
"toolname":"sometool",
"avatar":"somephoto.jpg",
"toolurl":"abcdef.com/12345",
"purpose": "maybesomepurposeagain2",
"actions": ["action1","action3", "action4","action5"],
"events":[{
	"eventid":"evid",
	 "eventname": "evname",
	 "description": "evdescdddripdtion",
	 "activity":"somecommunityevent",
	 "actor":"some actor",
	 "object": "new object",
	 "metadata": "someurldatamaybe"
},{
	"eventid":"evid2",
	 "eventname": "evname2",
	 "description": "evdescriptiond2",
	 "activity":"somecommunityevent2",
	 "actor":"some actor2",
	 "object": "new object2",
	 "metadata": "someurldatamaybe2"
}
	]


}

Success Response:

Code : 201

Content : {jwt token will be returned back}

Error Response

    Code :  400 Bad Request
    Content : { error: 'Unexpected error occurred, please try again...!' }
  OR
    
    Code : 505 Internal Server error
    Content :{error: 'Internal Error occured'}

4. UPDATE actions and activity events for a given tool of a domain

URI

HTTP PATCH /api/v1/communitytools/:domainname/tools/:toolid

URI Params

Required:

  domainname[text]
  toolid[text]

Data Params

  {
"toolname":"sometool",
"avatar":"somephoto.jpg",
"toolurl":"abcdef.com/12345",
"purpose": "maybesomepurposeagain2",
"actions": ["action1","action3", "action4","action5"],
"events":[{
	"eventid":"evid",
	 "eventname": "evname",
	 "description": "evdescdddripdtion",
	 "activity":"somecommunityevent",
	 "actor":"some actor",
	 "object": "new object",
	 "metadata": "someurldatamaybe"
},{
	"eventid":"evid2",
	 "eventname": "evname2",
	 "description": "evdescriptiond2",
	 "activity":"somecommunityevent2",
	 "actor":"some actor2",
	 "object": "new object2",
	 "metadata": "someurldatamaybe2"
}
	]


}

Success Response:

Code : 202

Content : {jwt token returned}