Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
D
Developer Documentation
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Wiki
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Package registry
Container registry
Model registry
Operate
Environments
Terraform modules
Monitor
Incidents
Service Desk
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
brienne
Developer Documentation
Commits
cfdbb014
Commit
cfdbb014
authored
7 years ago
by
eileen
Committed by
GitHub
7 years ago
Browse files
Options
Downloads
Patches
Plain Diff
update return outputs (minor editing)
parent
b9940bf1
Branches
Branches containing commit
Tags
Tags containing commit
No related merge requests found
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
docs/framework/api-architecture.md
+3
-3
3 additions, 3 deletions
docs/framework/api-architecture.md
with
3 additions
and
3 deletions
docs/framework/api-architecture.md
+
3
−
3
View file @
cfdbb014
...
...
@@ -22,10 +22,10 @@ Usage documentation is in the [APIv3](/api/index.md) page.
-
API functions should match the relevant BAO names & have the
functions 'get', 'create' and delete'
-
All functions should receive $params as an array(not a reference)
-
All functions should
return
either
-
an id indexed array of results via
-
All functions should either
-
return
an id indexed array of results via
the
`civicrm_api3_create_success()`
function
-
an appropriate message via throw new api_Exception
-
throw an
`API_Exception`
. Note that
`civicrm_api3_create_error`
is deprecated
-
(REVIEW this in light of feedback from bgm that it is not optimal
for translation) Do not use
`ts()`
in error messages (this will be
added in the exception function if you use api_Exception - but you
...
...
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment