Service Groups Create API

Route

POST

Purpose

RESTful API for inserting new rows into service_groups table.

Parameters

slug string 1 required

unique slug of service_group that is being created.

name string 3 required

Name of service_group that is being created.

pricing_metric string 4

Pricing Metric of service_group that is being created.

Possible values

sq_ft
list_price

service_type string 5

service type of service_group that is being created.

Possible values

primary
add_on

quantity_required boolean 6

Quantity required boolean of service_group that is being created.

designation_id array 7

Designation ID's of service_group that is being created.

Possible values

available_occupied boolean 8

Designation if the service_group is available_occupied

online_name string 9

Online Order Name of service_group that is being created.

sort_order integer 10

Sort order of the service group.

online boolean 11

Boolean indicating if the service group is online.

Possible values

true
false

active boolean 12

Boolean indicating if the service group is active.

Possible values

true
false

order_api boolean 13

Boolean indicating if the service group is available in the order_api.

Possible values

true
false

appointment_needed boolean 14

Possible values

true
false

production_needed boolean 15

Possible values

true
false

tour_needed boolean 16

Possible values

true
false

primary_service_priority integer 16

shopping_cart_slug string 17

token string 100 required

Authentication token for either an application or session.

application string 200

Slug of application being requested. This is used to determine the role being used to make the request and therefore evaluate if the requester has the correct permissions.

Possible values

planoauth
planoorder
planox2

session_view string 300

View of session object you would like returned.

Request Body Example: application/json

          {"slug": "New Service Group", "name": "New Service Group", "pricing_metric": "sq_ft", "service_type": "primary", "quantity_required": true, "designation_id": [1, 2], "available_occupied": true, "online_name": "New Service Group Online Name", "sort_order": 100, "online": true, "active": true, "order_api": true, "appointment_needed": true, "production_needed": true, "tour_needed": true, "primary_service_priority": 100, "shopping_cart_slug": "test_order_api_v3_slug", "token": "Sw543vdfgswWg98", "application": "planoauth", "session_view": null}

Responses

action-successful 200

This status indicates that the request was successful. If the request returns data, it can be found in the data key.

  {"code": 200, "data": {"id": 2, "name": "Floor Plans", "slug": "floor_plan", "service_type": "primary", "online": false, "active": true, "order_api": true, "quantity_required": false, "designation_id": "[2]", "popular": null, "pricing_metric": null, "available_vacant": null, "available_occupied": false, "sort_order": 1300, "required_for_submission": true, "select_rank": null, "online_name": "Floor Plans", "online_description": null, "tour_needed": true, "production_needed": true, "appointment_needed": true, "created_by_id": null, "updated_at_fm": "2021-07-20T10:28:35.000Z", "updated_in": null, "created_at": "2019-02-27T23:24:03.000Z", "updated_at": "2023-03-14T17:06:17.000Z", "primary_service_priority": 7, "shopping_cart_slug": "floor_plans", "splint_into_packaged_services": null, "parent_packaged_service_group_id": null, "default_packaged_quantity": null}, "status": "action-successful", "message": "..."}

invalid-token 401

This status is returned when the authentication token passed is invalid.

  {"code": 401, "status": "invalid-token", "message": "..."}

session-expired 401

This status is returned a session is older than seven days or hasn't been used in 72 hours. The user will need to reauthenticate. We allow our users to save a remember_me preference which will make there sessions last indefinitely.

  {"code": 401, "status": "session-expired", "message": "..."}

client-required 401

This status is returned when the user makeing the request doesn't have a client, employee or liaison record. This means that they don't have any roles or permissions. Because we only allow our clients to register as a client, the user should be redirected to the PlanoAuth clients registration page where they can use the `/api/v1/users/client_register` API to register as a client. Eventhough the request will not be successful, this status will still return a `session` object because a session token is needed to register as a user.

  {"code": 401, "status": "client-required", "message": "...", "session": {}}

missing-param 400

This status is returned when a required param was not passed with the request.

  {"code": 400, "status": "missing-param", "message": "...", "missing_param": "email"}

invalid-param 400

This status is returned when a param was invalid when passed. For example, passing an id that doesn't exist or passing an invalid email address.

  {"code": 400, "status": "invalid-param", "message": "...", "invalid_param": "email"}

application-crash 500

This status is returned when there is an internal server error. Please try again later.

  {"code": 500, "errors": "...", "status": "application-crash", "message": "..."}

mandrill-email-failed 500

This status is returned when there was an issue using Mandrill to send an email. Any time this response is returned, there will be a notification in the production notifications tab so the dev team will be away of the failure. These errors will most likely correlate with a data issue and will need to be invesigated.

  {"code": 500, "errors": "...", "status": "mandrill-email-failed", "message": "..."}

invalid-content-type 400

This status is returned if the request was made with the incorrect content-type so the request params could not be read. For more infromation on content-type, please refer to https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Type.

  {"code": 400, "status": "invalid-content-type", "message": "...", "content_type_passed": "application/json", "content_type_required": "text/plain"}

route-non-existent 500

Response returned when HTTP route does not exist.

  {"code": 500, "status": "route-non-existent", "message": "..."}

Uncommon Responses

The responses below are not very common.

no-params-decoded Uncommon

This status is returned the request body was decoded, but no params where found.

  {"code": 400, "status": "no-params-decoded", "message": "..."}

invalid-encoded-params Uncommon

This status is returned when the request body could not be decoded properly. This generally means that you are requesting a sensative_params API and your request body was not base64 encoded.

  {"code": 400, "errors": "...", "status": "invalid-encoded-params"}

route-not-found Uncommon

This status is returned when the route record being requested hasn't been deployed yet.

  {"code": 404, "path": "...", "status": "route-not-found", "message": "...", "http_method": "..."}

identify-request-error Uncommon

This status is returned when there is an internal server error before the route could be identified. Please try again later.

  {"code": 500, "errors": "...", "status": "identify-request-error", "message": "..."}

service-not-found Uncommon

This status is returned when the route's API service record being requested hasn't been deployed yet.

  {"code": 404, "status": "service-not-found", "message": "...", "route_id": "...", "api_service_key": "..."}