{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/service_reminders","auth":"required","examples":{"codes":[]},"method":"post","params":[{"name":"vehicle_id","type":"int","default":"","desc":"","required":true,"in":"body","ref":"","_id":"57ac96d88f312d0e00e96c72"},{"name":"service_task_id","type":"int","default":"","desc":"","required":true,"in":"body","ref":"","_id":"57ac96d88f312d0e00e96c71"},{"name":"meter_interval","type":"int","default":"","desc":"","required":true,"in":"body","ref":"","_id":"57ac96d88f312d0e00e96c70"},{"name":"secondary_meter","type":"boolean","default":"","desc":"","required":false,"in":"body","ref":"","_id":"57ac96d88f312d0e00e96c6f"},{"name":"time_interval","type":"int","default":"","desc":"","required":false,"in":"body","ref":"","_id":"57ac96d88f312d0e00e96c6e"},{"name":"time_frequency","type":"string","default":"","desc":"Accepted values: days, weeks, months, years","required":false,"in":"body","ref":"","_id":"57ac96d88f312d0e00e96c6d"},{"name":"due_soon_meter_threshold","type":"int","default":"","desc":"","required":false,"in":"body","ref":"","_id":"57ac96d88f312d0e00e96c6c"},{"name":"active","type":"boolean","default":"","desc":"","required":false,"in":"body","ref":"","_id":"57ac96d88f312d0e00e96c6b"},{"name":"due_soon_time_threshold_interval","type":"int","default":"","desc":"","required":false,"in":"body","ref":"","_id":"57ac96d88f312d0e00e96c6a"},{"name":"due_soon_time_threshold_frequency","type":"string","default":"","desc":"Accepted values: days, weeks, months, years","required":false,"in":"body","ref":"","_id":"57ac96d88f312d0e00e96c69"},{"name":"user_ids","type":"array_int","default":"","desc":"","required":false,"in":"body","ref":"","_id":"5b33a506f3c7c1000316ab8c"},{"name":"starting_interval","type":"boolean","default":"false","desc":"Boolean to determine whether or not this Service Reminder should have a starting interval.","required":false,"in":"body","ref":"","_id":"5e8decacf262a9001843c138"},{"name":"starting_meter_interval","type":"int","default":"","desc":"","required":false,"in":"body","ref":"","_id":"5e8decacf262a9001843c137"},{"name":"starting_secondary_meter_interval","type":"int","default":"","desc":"","required":false,"in":"body","ref":"","_id":"5e8decacf262a9001843c136"},{"name":"starting_time_interval","type":"int","default":"","desc":"","required":false,"in":"body","ref":"","_id":"5e8decacf262a9001843c135"},{"name":"starting_time_frequency","type":"string","default":"months","desc":"Accepted values: days, weeks, months, years","required":false,"in":"body","ref":"","_id":"5e8decacf262a9001843c134"}],"results":{"codes":[{"status":201,"language":"json","code":"{  \n  \"id\":123,\n  \"active\":true,\n  \"vehicle_id\":152,\n  \"service_task_id\":10635,\n  \"service_task_name\":\"Oil/Filter Change\",\n  \"meter_interval\":6000.0,\n  \"time_interval\":6,\n  \"time_frequency\":\"months\",\n  \"next_due_meter_value\":62788.0,\n  \"next_due_at\":\"2014-06-17T00:00:00.000-05:00\",\n  \"due_soon_at\":\"2014-06-03T00:00:00.000-05:00\",\n  \"due_soon_meter_value\":62288.0,\n  \"due_soon_time_threshold_interval\":2,\n  \"due_soon_time_threshold_frequency\":\"weeks\",\n  \"due_soon_meter_threshold\":500.0,\n  \"secondary_meter\":false,\n  \"archived_at\":null,\n  \"forecasted_next_due_at\":\"2017-08-12T19:00:00.000-05:00\",\n  \"forecasted_due_soon_at\":\"2017-07-30T00:00:00.000-05:00\",\n  \"user_ids\":[\n  \t{\n      \"id\":100,\n      \"name\":\"Bob Robertson\"\n    }\n  ],\n  \"created_at\":\"2011-08-17T16:55:03.905-05:00\",\n  \"updated_at\":\"2016-08-09T07:05:35.027-05:00\"\n}","name":""},{"status":422,"language":"json","code":"{\n  errors: []\n}","name":""}]},"settings":""},"next":{"description":"","pages":[]},"title":"/service_reminders","type":"endpoint","slug":"create-service-reminder","excerpt":"Creates a new service reminder.","body":"","updates":[],"order":1,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"57ac96d88f312d0e00e96c68","__v":5,"githubsync":"","project":"54c0e51215af820d001a38a6","category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"Service Reminders","slug":"service-reminders","order":30,"from_sync":false,"reference":true,"_id":"57ac94252c0b220e00a94570","version":"54f8de4e4339bb1900c8bffb","__v":0,"project":"54c0e51215af820d001a38a6","createdAt":"2016-08-11T15:05:09.896Z"},"version":{"version":"1","version_clean":"1.0.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["54f8de4e4339bb1900c8bffc","54f8de4e4339bb1900c8bffd","54f8de4e4339bb1900c8bffe","54f8de4e4339bb1900c8bfff","54f8de4e4339bb1900c8c000","54ff6057563d7419002d666e","55007b6ecfeeea17004717dc","5501d779f2ef1e0d003116eb","55116ef89f7c7619005f853b","554bb366f245703100ddd39f","554d226b374fec0d007e64db","555e09f18ab3180d001ac605","555e0b2b4f5e5a0d00836d77","561d1f8b92a0cc350018b24f","562a956c96b5f40d0026eb60","5654c3378a26202b00c17cb8","5697a94b0b09a41900b24546","5739d89e37b52e3200a3a3cc","57ac94252c0b220e00a94570","57ac97a1ad44fc0e003be066","57ac9a3a8f312d0e00e96c75","57ac9c187ae5c60e004ba3a3","58178bee62e4500f009404f6","581a39711a63870f008b621d","581a3b4f0c65b20f00247fcb","5926e0606c729e0f00595f95","5954033ea5bbca002d27ae91","596ce53e0aeafe00157eb1ba","596ce87a8b79f4001a8f6139","598cad2e96193400190d879a","598cbcd3dc20c6000fdfb9c3","598cbd8496193400190d8955","59fcc7c9591add0026c91457","5a020b7856ea82001c8c9342","5a09bc64a91882001c56c2ed","5a71fa2de9aa84007a8bccdb","5b3a768a8a21dd0003ca080d","5c7030f099eeb6003116a106","5c9553a7b6957d005006fc09","5c955c3d04233b0063c9f450","5cfe73f7823bba005de7e1ed","5d07eb760568e70040d6ae21","5deec6550e90370067139979"],"_id":"54f8de4e4339bb1900c8bffb","project":"54c0e51215af820d001a38a6","releaseDate":"2015-03-05T22:53:02.044Z","createdAt":"2015-03-05T22:53:02.044Z","forked_from":"54f8de14c6cabe23005c02a2","__v":39},"createdAt":"2016-08-11T15:16:40.192Z","parentDoc":null,"user":"54cba76f6d1eee0d00c33dee"}

post/service_reminders

Creates a new service reminder.

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Body Params

vehicle_id:
required
integer
service_task_id:
required
integer
meter_interval:
required
integer
secondary_meter:
boolean
time_interval:
integer
time_frequency:
string
Accepted values: days, weeks, months, years
due_soon_meter_threshold:
integer
active:
boolean
due_soon_time_threshold_interval:
integer
due_soon_time_threshold_frequency:
string
Accepted values: days, weeks, months, years
user_ids:
array of integers
starting_interval:
booleanfalse
Boolean to determine whether or not this Service Reminder should have a starting interval.
starting_meter_interval:
integer
starting_secondary_meter_interval:
integer
starting_time_interval:
integer
starting_time_frequency:
stringmonths
Accepted values: days, weeks, months, years

Result Format


User Information

Try It Out

post
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}