API call to get who has a document checked out

I see the api calls for checking if a document is checkedout and if the document is checked out to you. but how do I find out who has it checked out, like the name or whatever is listed in the Out To column?

Top Replies

Offline Dan Williams Mon, Jun 10 2019 6:47 PM in reply to John Drsek +2 verified

John, aaApi_SelectLocationsByProp() might be a better choice as you can specify the document's projectId, documentId, and Check out Location Type and then check the return value (errors…
Offline Jeff Burrill Mon, Jun 10 2019 2:14 PM +1 suggested

Try aaApi_SelectLocations. The data will be in AADMSBUFFER_CHKL buffer.
Offline John Drsek Fri, Jun 4 2021 12:21 PM in reply to John Drsek +1

Was asked for the code, here it is for c#, i have my own dll for all the wrappers and PWConstants., but other then that should be pretty straight forward. //check if its checked out by someone else …

Parents

0 Offline Jeff Burrill Mon, Jun 10 2019 2:14 PM

Try aaApi_SelectLocations. The data will be in AADMSBUFFER_CHKL buffer.
Cancel
Vote Up +1 Vote Down

Sign in to reply

Verify Answer

Reject Answer

Cancel
0 Offline John Drsek Mon, Jun 10 2019 2:25 PM in reply to Jeff Burrill
I don't see a property in that buffer for the user that has it checked out...all I see if UserID...can I get the user name with the ID?
Cancel
Vote Up 0 Vote Down

Sign in to reply

Verify Answer

Cancel
+2 Offline Dan Williams Mon, Jun 10 2019 6:47 PM in reply to John Drsek
John,

aaApi_SelectLocationsByProp()

might be a better choice as you can specify the document's projectId, documentId, and Check out Location Type and then check the return value (errors or no matching records). If the return value is greater than 0, then you can get the userid from the chkl buffer and look up the user's properties with something like aaApi_SelectUser() (and then check the return value for errors, etc. and then get the properties from the user buffer).
Answer Verified By: Brian Flaherty
Cancel
Vote Up +2 Vote Down

Sign in to reply

Verify Answer

Reject Answer

Cancel

Reply

+2 Offline Dan Williams Mon, Jun 10 2019 6:47 PM in reply to John Drsek
John,

aaApi_SelectLocationsByProp()

might be a better choice as you can specify the document's projectId, documentId, and Check out Location Type and then check the return value (errors or no matching records). If the return value is greater than 0, then you can get the userid from the chkl buffer and look up the user's properties with something like aaApi_SelectUser() (and then check the return value for errors, etc. and then get the properties from the user buffer).
Answer Verified By: Brian Flaherty
Cancel
Vote Up +2 Vote Down

Sign in to reply

Verify Answer

Reject Answer

Cancel

Children

0 Offline John Drsek Tue, Jun 11 2019 8:40 AM in reply to Dan Williams
Thanks Dan,

exactly what I needed.
Cancel
Vote Up 0 Vote Down

Sign in to reply

Verify Answer

Cancel

0 Offline John Drsek Fri, Jun 4 2021 12:21 PM in reply to John Drsek

Was asked for the code, here it is for c#, i have my own dll for all the wrappers and PWConstants., but other then that should be pretty straight forward.

//check if its checked out by someone else
                            int intlocations = PWWrappers.aaApi_SelectLocationsByProp(selSheet.propFolderID, selSheet.propFileID, -1, PWConstants.AADMS_CHECKED_OUT, null, null);
                            if (intlocations > 0)
                            {
                                //get the user id at the first location record 
                                int userID = PWWrappers.aaApi_GetLocationNumericProperty(PWConstants.LOC_PROP_USERID, 0);
                                if (userID != 0)
                                {//get user from userID
                                    int gotuser = PWWrappers.aaApi_SelectUser(userID);
                                    if (gotuser == 1)
                                    {//get user name
                                        userName = PWWrappers.aaApi_GetUserStringProperty(PWConstants.USER_PROP_NAME, 0);
                                    }

                                }
                            }