api.setup.terms¶
/api/setup/terms/¶
GET /api/setup/terms/¶
Description:
Return the existing terms details
can_lock | requires_lock | has_etag | requires_etag |
---|---|---|---|
False | False | False | False |
Filters:
Name | Description |
---|---|
active | Returns active terms only.. E.g: active==True |
internal | Returns all non-internal terms. E.g: internal==False |
name | Returns terms whose name contain the provided substring. E.g: name contains “Net 30” |
Request:
<!-- No XML Request. -->
Response:
<terms_list>
<terms uri="/setup/terms/x/" id="x" etag="[int]">
<!-- See GET /setup/terms/x/ for details -->
</terms>
[...]
</terms_list>
/api/setup/terms/(d+)/¶
GET /api/setup/terms/(d+)/¶
Description:
Returns the details for a specific terms
can_lock | requires_lock | has_etag | requires_etag |
---|---|---|---|
False | False | True | False |
Request:
<!-- No XML Request. -->
Response:
<terms uri="/setup/terms/x/" id="x">
<name>[string]</name>
<account>[bool]</account>
<terms_days>[int]</terms_days>
</terms>