Commit 317c5ba8 by Torkel Ödegaard

Merge pull request #3747 from utkarshcmu/api-docs

Added Orgs API docs
parents 2ccc1918 caa26f59
...@@ -500,6 +500,64 @@ Proxies all calls to the actual datasource. ...@@ -500,6 +500,64 @@ Proxies all calls to the actual datasource.
"name":"Main Org." "name":"Main Org."
} }
### Get Organisation by Id
`GET /api/orgs/:orgId`
**Example Request**:
GET /api/orgs/1 HTTP/1.1
Accept: application/json
Content-Type: application/json
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk
**Example Response**:
HTTP/1.1 200
Content-Type: application/json
{
"id":1,
"name":"Main Org.",
"address":{
"address1":"",
"address2":"",
"city":"",
"zipCode":"",
"state":"",
"country":""
}
}
### Get Organisation by Name
`GET /api/orgs/name/:orgName`
**Example Request**:
GET /api/orgs/name/Main%20Org%2E HTTP/1.1
Accept: application/json
Content-Type: application/json
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk
**Example Response**:
HTTP/1.1 200
Content-Type: application/json
{
"id":1,
"name":"Main Org.",
"address":{
"address1":"",
"address2":"",
"city":"",
"zipCode":"",
"state":"",
"country":""
}
}
### Update current Organisation ### Update current Organisation
`PUT /api/org` `PUT /api/org`
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment