dhis2-devs team mailing list archive

[Saptarshi Purkayastha <sunbiz@xxxxxxxxx>]

It is generally considered to be bad practice in the design of Web API or REST APIs that two URLs point to the same resources.
Also I would think that people who want to juggle between existing web functionality and Web API, would like to use internal IDs to get the UID and then use the UID for web API calls. This makes it more flexible to use and switch between the two IDs depending what functionality you want to use, either from core web interface (uses IDs) or Web API (uses UIDs)

---
Regards,
Saptarshi PURKAYASTHA
From: janhenrik.overland@xxxxxxxxx
Date: Mon, 4 Nov 2013 16:57:26 +0100
Subject: Re: [Dhis2-devs] Web API - Search by id
To: sunbiz@xxxxxxxxx
CC: dhis2-devs@xxxxxxxxxxxxxxxxxxx

It's just for convenience. If you make an app that looks up organisation units by id, code or name you won't have to change the base url based on the parameter.



On Mon, Nov 4, 2013 at 4:47 PM, Saptarshi Purkayastha <sunbiz@xxxxxxxxx> wrote:








Why would one use the search at all in this case of using the UID?
You can directly get the resource with the UID




http://apps.dhis2.org/demo/api/organisationUnits/ImspTQPwCqd gives Sierra Leone


http://apps.dhis2.org/demo/api/organisationUnits/search/Sierra%20Leone is the search

---


Regards,
Saptarshi PURKAYASTHA
From: janhenrik.overland@xxxxxxxxx
Date: Mon, 4 Nov 2013 16:36:25 +0100
Subject: Re: [Dhis2-devs] Web API - Search by id


To: sunbiz@xxxxxxxxx
CC: dhis2-devs@xxxxxxxxxxxxxxxxxxx



Hi, try the uid. For a web API user there is only one id (which is the uid). We don't want to confuse him by saying "uid" in the docs as it implies that there is an "id" as well.



On Mon, Nov 4, 2013 at 4:11 PM, Saptarshi Purkayastha <sunbiz@xxxxxxxxx> wrote:





The Web API documentation here: http://www.dhis2.org/doc/snapshot/en/user/html/ch25s04.html
suggests that you can search a resource by its id, code and name. 




I tried the following: http://apps.dhis2.org/demo/api/organisationUnits/search/559
But it says 
Object not found for query: 559



So, does it only work for code and name and not for id?

---
Regards,
Saptarshi PURKAYASTHA
 		 	   		  

_______________________________________________

Mailing list: https://launchpad.net/~dhis2-devs

Post to     : dhis2-devs@xxxxxxxxxxxxxxxxxxx

Unsubscribe : https://launchpad.net/~dhis2-devs

More help   : https://help.launchpad.net/ListHelp