Fetching Data

Proofreadings

Proofreadings

When a product is almost finished a proofreading can be sent to get an approval before an order is made. Several proofreadings can be sent to different recipients and in total they make up a proofreading batch.

Fetch proofreading batches

Fetch list of proofreading batches

URI: https://<im4>/proofreading_batches/{'updated'?}/{agency_id?}
?days={days?}
?minutes={minutes?}
?search={search?}
?take={take?}&skip={skip?}
  • Request-type: GET
  • Parameters:
    {'updated'} (part of URI) (optional): If 'updated' included - sort by, take and days use updated_at instead of created_at Since 0.27
    {agency_id} (part of URI) (optional): Agency - fallback to client agency + collaborating agencies
    {days} (integer) (default 120): Days to include - skipped if minutes, search or take set
    {minutes} (integer): Since 0.28 Minutes to include - skipped if search or take set
    {search} (string): Multi-word search – if specified, days and minutes are ignored.
    {take} (integer): Limit result – used for paging – if specified, days and minutes are ignored.
    {skip} (integer): Skip first x results – used for paging – will only work if take specified
  • Return data {mixed} (JSON)
If user has access to multiple agencies – proofreading_batches in all agencies will be returned unless agency_id is specified

Fetch project proofreadings batches

proofreading_batches is a valid key on projects, so get through project:

/project/{projectId}/proofreading_batches

Fetch a specific full proofreading batch

Get a specific proofreading batch with additional information (see proofreading batch table and proofreading table here

/project/{projectId}/proofreading_batch/{batchId}
  • Request-type: GET
  • Parameters:
    {projectId} (part of URI): Project ID
    {batchId} (part of URI): Proofreading batch ID
  • Return data {mixed} (JSON)