service-request

Create a new ServiceRequest

This method is used by the ReCollect Widgets and Mobile Apps, and can also be used to integrate ReCollect with other ticketing systems.

The {place_id} parameter can reference external ids (such as customer account IDs) using the external: prefix. Contact ReCollect Support to determine how your external ids are named.

When this request is made with a valid API key for a given area, no items need to be supplied, and the counts_towards_limit parameter can be set. This can be useful to record collection requests in ReCollect, so that the system can correctly apply service limits.

An optional parameter: skip_emails can be set to a true value, to avoid sending a confirmation and reminder email to the requestor of the BIC. Useful when updating ReCollect about requests created externally.

The process_name parameter can be used to specify which ServiceProcess this request is for.

The event_id parameter is the ID of an event in the special collection that is in your places schedule. See `/api/areas/:area_id/services/:service_id/events`.

post/places/{place_id}/services/{svc_id}/service/requests

Request

  • Base URL: https://api.recollect.net/api
  • URL: https://api.recollect.net/api/places/{place_id}/services/{svc_id}/service/requests
  • Auth: none declared

Path parameters

place_idstring required

Place ID is the UUID for a given place within ReCollect

svc_idstring required

Service ID. When used with an Area, a Service name (like "waste") can be used.

Request body

skip_emailsboolean
commentsstring
accountstring
phonestring phone-number
event_idinteger
counts_towards_limitboolean
itemsinteger[]
process_namestring
emailstring email

Response

201 Created

updated_atstring date-time
service_idinteger
datestring date-time
idinteger
request_urlstring
optsobject
created_atstring date-time
place_urlstring
pickup_ymdstring date
area_namestring
created_bystring email
email_contactstring
counts_towards_limit1 | 0
external_idstring
cancelled1 | 0
phone_contactstring
updated_at_localtimestring date-time
created_at_localtimestring date-time
parcel_infoobject
commentsstring

Changes

No recorded changes to this operation across all 1 revision of this API.