Download YAML
Common API Dependency matrix
Refer to the following table for the Common API operations used by this digital service.
| Common API | CDC | Post-Consent Cert | Cert Reg | Plan Cert 10.7 | DA | Sec. 68 | Concurrence & Referral | State DA | BIC |
|---|
| V1 | V1 | V1 | V1 | V1 | V2 | V1 | V1 | V1 | V1 |
|---|
| Operation | | | | | | | | | | |
|---|
| Inbound to ePlaninng APIs | CreateRef | | Yes | | | | | | | | |
| EditRegisteredPractitioner | | | | | | | | | | |
| GetCaseInfo | Yes | Yes | Yes | Yes | Yes | Yes | Yes | | Yes | Yes |
| GetCaseInfoSync | Yes | Yes | Yes | | | Yes | Yes | | | Yes |
| Payment | | | Yes | | | | | | | |
| ProvideAddInfo | | | Yes | | | | | | Yes | |
| Reassign | Yes | Yes | Yes | Yes | Yes | Yes | Yes | | Yes | Yes |
| ReqAddInfo | Yes | Yes | Yes | Yes | Yes | Yes | Yes | | Yes | Yes |
| Return | | | | Yes | | | | | | |
| UpdateMetadata | Yes | | | | | | Yes | | Yes | |
| CloseAICase | | | | Yes | | | Yes | | | Yes |
| Documents | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes |
| Withdraw | | Yes | Yes | Yes | Yes | Yes | Yes | | Yes | Yes |
| Reject | | | | | Yes | Yes | | | Yes | |
| CreateExhibition | | | | | | Yes | | | Yes | |
| UpdateExhibition | | | | | | Yes | | | Yes | |
| CreateSubmission | | | | | | Yes | | | Yes | |
| Outbound from ePlanning APIs | UpdateAdditionalInfo | Yes | Yes | Yes | Yes | Yes | Yes | Yes | | Yes | Yes |
| Reassign | Yes | Yes | Yes | | Yes | Yes | | Yes | Yes | Yes |
| CreateSubmission | | | | | | Yes | | | Yes | |
| ExhitbitionStatusUpdate | | | | | | Yes | | | Yes | |
| UpdateMetadata | | | | | | | | Yes | | |
| Withdraw | Yes | Yes | | | Yes | Yes | Yes | | | Yes |
| RequestAddInfo | | | | | | | | | Yes | |
| Documents | Yes | Yes | Yes | Yes | | Yes | Yes | Yes | Yes | Yes |
Authentication
Please use the subscription key provided by the Department to access the APIs.
apiKeyHeader
| Security Scheme Type | API Key |
| Header parameter name: | api-key |
apiKeyQuery
| Security Scheme Type | API Key |
| Query parameter name: | subscription-key |