Skip to end of metadata
Go to start of metadata

Projects are a user created item that will be have a print order placed. A User first picks a Product, i.e. 10x8 photobook, which then creates a Project – an instance of that Product which they then populate with their photos and data etc, creating their book for printing. A Project is only visible to the user who created it (enforced by the session).

Projects are versioned with Project Versions. This is to support editing a Project after it has been ordered and allow reordering an older version (for example, from Order History).

Requires:

Actions

URLVerbInformation
/projectsGET

Returns a list of all existing projects for the currently logged in user

/projectPOSTCreates a new project
/project/{Guid}PUTUpdates an existing project
/project/{Guid}GETRetrieves the details of an existing project
/project/{Guid}DELETEDeletes an existing project

Attributes

The following attributes are for creating or updating a project.

FieldData TypeRequiredInformation
NameStringYUsed for the user to identify the project
ProductIdIntegerYProduct type of the project

The following details are returned about a project

FieldData TypeRequiredInformation
GuidGuidYUsed to uniquely identify a project
NameStringYUsed for the user to identify the project
ProductIdIntegerYProduct type of the project
VersionsArray Of Project VersionsYVersions of the project.
CreatedDateUtcDateTimeYThe date time the project was created, in UTC
LastSavedDateUtcDateTimeYThe date time the project was last saved, in UTC

 

 

  • No labels