PolicyHub My Library API

Last updated
Save as PDF

The My Library API provides per user PolicyHub access for actions such as checking your own compliance status for a document.

As an example a call to retrieve the library from the My Library API would return the caller’s view of a library based on what polices have been published to their account regardless of whether that user has administration system access or not. This is akin the PolicyHub inbox website view of the library and different from the administration library view.

Get My Compliance Status for a Document Revision

This method allows you to retrieve your compliance status for a specific document revision within your publication library.

UserComplianceState GetMyComplianceStatus( 
    Credentials credentials,
    int revisionId
)

credentials

The credentials to verify the calling user for this call.

revisionId

The ID of the document revision to retrieve the compliance status of.

return

UserComplianceState - An enumeration of compliance states, one of: Complied, Not Complied, In Progress or Error.

A revision is considered to be in compliance if any publication sent to the requesting user that included the requested document revision has been complied to. If no publication has been complied to by the user, the last available compliance status will be returned. If no publication could be found the user is considered not complied.

Download a Document from My Library

This method allows you to download a document’s file content from your library. If a document has more than one revision available, this will be the last document revision published to your library.

PolicyHubFileData GetMyDocumentData ( 
    Credentials credentials, 
    int documentId
)

credentials	The credentials to verify the calling user for this call.
documentId	The ID of the document to download.
return	PolicyHubFileData - The filename, MIME type and file content for the revision of the requested document last published to your library.

Download a Document Revision

This method allows you to retrieve a specific document revision’s file content published to your library.

PolicyHubFileData GetMyDocumentRevisionData ( 
    Credentials credentials, 
    int revisionId
)

credentials	The credentials to verify the calling user for this call.
revisionId	The ID of the document revision to download.
return	PolicyHubFileData - The filename and content for the revision of the requested document.

Get a List of My Documents for a Folder

This method allows you to retrieve a collection of documents for a given library folder.

PolicyHubDocument[] GetMyDocuments ( 
    Credentials credentials, 
    int folderId
)

credentials	The credentials to verify the calling user for this call.
folderId	The ID of the folder to retrieve documents from.
return	PolicyHubDocument[ ] - An array of documents for the requested folder location in your library.

Get My Compliance Library

This method allows the retrieval of your PolicyHub library, returning a collection of folders as a tree structure.

PolicyHubFolder GetMyLibrary( 
    Credentials credentials
)

credentials	The credentials to verify the calling user for this call.
return	PolicyHubFolder - A tree structure of the PolicyHub library starting at the root node. Each folder may contain one or more children each themselves containing one or more children.