You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
GET /api/draft/proposal/template/list?id=<Brand/Campaign/Category id>&<optional paging parameters>&type=<PROPOSAL | COMMENT>
id is optional, if not specified, then all proposal templates known are listed, limited by the paging options.
The id are unambiguous, so its possible to tell if whats being requested are all templates being used by a brand, for a brands campaign, or assigned to a category under an event. This is because the id will be a ulid.
This returns a summary list of templates, and their ID's. It is NOT a signed document, just a normal json response.
Proposal Comments are similar to proposals, they are templated the same way, and can be retrieved by setting &type=COMMENT if its not defined, or set to &type=PROPOSAL then only proposal templates can be returned.
NOTE: There will ONLY be a single Proposal and Comment template defined for each unique campaign_id.
Also, template_id can be reused by multiple brands, campaigns and categories.
GET /api/draft/proposal/template/:<template-id>
Returns the template by this ID. :template-id is a ulid, so can not be list and does not conflict with the above.
It MUST be supplied, so can be a path parameter.
The response IS a signed document (Signed by project catalyst) which contains the requested proposal template.
In future, the template would be signed by whoever authored it.
In a decentralized future, the :template_id may change to something more natural for a decentralized document storage reference, if required. It would not look like a ulid, and so should not be a breaking change.
Acceptance Criteria
List clear, specific, and measurable criteria for when the task is considered complete.
Resources
Add relevant links, documentation, or references.
The text was updated successfully, but these errors were encountered:
Description
Rough Draft Endpoints
id
is optional, if not specified, then all proposal templates known are listed, limited by the paging options.The
id
are unambiguous, so its possible to tell if whats being requested are all templates being used by a brand, for a brands campaign, or assigned to a category under an event. This is because theid
will be a ulid.This returns a summary list of templates, and their ID's. It is NOT a signed document, just a normal json response.
Proposal Comments are similar to proposals, they are templated the same way, and can be retrieved by setting
&type=COMMENT
if its not defined, or set to&type=PROPOSAL
then only proposal templates can be returned.NOTE: There will ONLY be a single Proposal and Comment template defined for each unique
campaign_id
.Also,
template_id
can be reused by multiple brands, campaigns and categories.Returns the template by this ID.
:template-id
is a ulid, so can not belist
and does not conflict with the above.It MUST be supplied, so can be a path parameter.
The response IS a signed document (Signed by project catalyst) which contains the requested proposal template.
In future, the template would be signed by whoever authored it.
In a decentralized future, the
:template_id
may change to something more natural for a decentralized document storage reference, if required. It would not look like a ulid, and so should not be a breaking change.Acceptance Criteria
Resources
The text was updated successfully, but these errors were encountered: