Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

MethodNotes
[POST]/partner/login

Start by getting a token for all subsequent API calls.

partner_name: string
username: string
password: string

*Obtain the 3 parameters from our integration support team

[POST]/projects

Project number must be unique. 
Once the project has been created, the selected Purpose (For Permitting or For Design Review) may not be changed.

Pass your project's ID (PK/GUID) to the 'vendor_id' field. (Required)

*Vendor_ID accepts a numeric or string (50 chars). Vendor_id's must be unique in the projects table.

[POST]/contactsContact's email address must be unique.
Use the ID returned to call POST/projectPersons
[POST]/projectPersonsSet isPrimary = true if this individual should receive emails regarding project 'deliverables'. At least one 'primary' contact is recommended. Set isActive = true.
[POST]/project/{project_id}/addressesEither a street address or APN is required. 
[POST]/project/{project_id}/teamMembers

Post a list of EPR users who will actively work on this project. Failure to include an EPR user in the project will prevent that individual from performing their tasks. 

Option: EPR can be configured to automatically create project team members if your application does not provide this functionality.

[POST]/resources/document/upload/create

Uploads file, creates document data record, documentPages records, documentVersions records, documentPageVersions records, sets needsIntake flag to ‘True.’

[POST]/resources/documents/upload/intakeRemoves record from Intake page, updates needsIntake flag to ‘False’, displays document record on Project > Documents page.
[POST]/resources/documentAssignmentsCreates assignment records, displays records in Review page.

...