Application & Process Automation

Getting Started
Authentication & Access
Agency and Program Information
Common Usage Scenarios
Create and Submit a Project
Add/Change Data in an Existing Project
Daily Polling for Project Changes
Using Custom IDs
API Method Reference
GetPrograms
URL Format
Response
XML Attributes
Sample Code
GetForms
URL Format
Response
Forms Attributes
AvailableInStatuses and LeadsToStatus
Status Attributes
Sample Code
GetFormSchema
V1 Response
V2 Response
Sample Code
GetProjects
V1 Response
V2 Response
Sample Code
GetProjectsByNumber
V1 Response
V2 Response
Sample Request
Sample Code
GetProjectsByData
Sample Request
Request XML Nodes and Attributes
V1 Response
V2 Response
CreateNewProject
Sample Response
Response XML Attributes
Sample Code
GetAllProjectData - Admin only
Sample Response
XML Attributes
Sample Code
GetProjectData
Sample Response
XML Attributes
Sample Code
SetProjectData
Sample Request
Request XML Attributes
Sample Response
Response XML Attributes
Sample Code
GetActiveAttachment
Sample Code
URL Format
GetAttachmentAsAdmin – Admin only
URL Format
SetProjectAttachment
Identifying attachment file types
URL Format
Sample Response
Response XML Attributes
Sample Code
SetAttachmentMetadata
Sample Request
Request XML Attributes
Sample Response
Response XML Attributes
Sample Code
GetAttachmentMetadata
URL Format
Sample Response
Response XML Attributes
Sample Code
SubmitProject
URL Format
Sample Response
Response XML Attributes
Sample Code
GetStatusList – Admin only
URL Format
Sample Response
Response XML Attributes
Sample Code
GetProjectStatusHistory – Admin only
URL Format
Sample Response
Response XML Attributes
Sample Code
SetProjectStatus – Admin only
URL Format
Sample Response
Response XML Attributes
Sample Code
GetExportProject – Admin only
URL Format
Sample Response
Response XML Attributes
Sample Code
Code Samples
EncodeAuthorizationHeader
MakeGetRequest
MakePostRequest
MakeGetFileRequest
PowerShell

Using Custom IDs

The unique-looking IDs that PowerClerk is using to identify all objects are automatically generated per program, and make it possible to uniquely identify which object a caller is referring to, without having to worry about program administrators relabelling those objects through the UI. However, it makes the exercise of mapping esp. data fields and attachments an exercise that needs to be repeated per program (incl. if trying to test in a test environment). Custom IDs can be set by an administrator (one that has the privilege to set those) for:
 

  1. data fields
  2. attachments
  3. forms
  4. status

 
Those stay constant if moving from a sandbox to production, or from production to a test environment. They are only unique within their object type, i.e. an attachment and a data field can have the same custom ID. If a custom ID has been set, that can be used in place of the automatically generated unique ID.

What’s Next?