Appointments Create API

Route

POST

Purpose


Parameters


updated_at_mt datetime 1 required
FM updated_at value
fm_appt_id integer 3
Create fm_appt_id for appointments API.
order_id integer 3
Create order_id for appointments API.
date_start_local date 4
Create date_start_local for appointments API.
time_start_local time 5
Create time_start_local for appointments API.
time_duration time 8
Create time_duration for appointments API.
time_stop_local time 9
Create time_stop_local for appointments API.
f009 binary 10
Create f009 for appointments API.
f010 binary 11
Create f010 for appointments API.
f011 binary 12
Create f011 for appointments API.
f012 binary 13
Create f012 for appointments API.
f013 binary 14
Create f013 for appointments API.
f014 binary 15
Create f014 for appointments API.
f015 binary 16
Create f015 for appointments API.
f016 binary 17
Create f016 for appointments API.
f017 binary 18
Create f017 for appointments API.
f018 binary 19
Create f018 for appointments API.
f019 binary 20
Create f019 for appointments API.
f020 binary 21
Create f020 for appointments API.
photographer_user_id integer 22
Create photographer_user_id for appointments API.
photographer_name string 23
Create photographer_name for appointments API.
f023 binary 24
Create f023 for appointments API.
delivery_type string 25
Create delivery_type for appointments API.
f025 binary 26
Create f025 for appointments API.
f026 binary 27
Create f026 for appointments API.
f027 binary 28
Create f027 for appointments API.
f028 binary 29
Create f028 for appointments API.
f029 binary 30
Create f029 for appointments API.
f030 binary 31
Create f030 for appointments API.
f031 binary 32
Create f031 for appointments API.
f032 binary 33
Create f032 for appointments API.
f033 binary 34
Create f033 for appointments API.
order_request_app_id integer 34
Create order_request_app_id for appointments API.
f034 binary 35
Create f034 for appointments API.
f035 binary 36
Create f035 for appointments API.
f036 binary 37
Create f036 for appointments API.
updated_in string 37
Create updated_in for appointments API.
f037 binary 38
Create f037 for appointments API.
f038 binary 39
Create f038 for appointments API.
f039 binary 40
Create f039 for appointments API.
updated_by string 41
Create updated_by for appointments API.
created_by string 42
Create created_by for appointments API.
f042 binary 43
Create f042 for appointments API.
f043 binary 44
Create f043 for appointments API.
f044 binary 45
Create f044 for appointments API.
notes text 46
Create notes for appointments API.
f047 binary 48
Create f047 for appointments API.
f048 binary 49
Create f048 for appointments API.
f049 binary 50
Create f049 for appointments API.
f050 binary 51
Create f050 for appointments API.
f051 binary 52
Create f051 for appointments API.
f052 binary 53
Create f052 for appointments API.
f053 binary 54
Create f053 for appointments API.
f054 binary 55
Create f054 for appointments API.
f055 binary 56
Create f055 for appointments API.
f056 binary 57
Create f056 for appointments API.
f057 binary 58
Create f057 for appointments API.
f058 binary 59
Create f058 for appointments API.
f059 binary 60
Create f059 for appointments API.
f060 binary 61
Create f060 for appointments API.
f061 binary 62
Create f061 for appointments API.
f062 binary 63
Create f062 for appointments API.
f063 binary 64
Create f063 for appointments API.
f064 binary 65
Create f064 for appointments API.
f065 binary 66
Create f065 for appointments API.
f066 binary 67
Create f066 for appointments API.
f067 binary 68
Create f067 for appointments API.
f068 binary 69
Create f068 for appointments API.
f069 binary 70
Create f069 for appointments API.
description text 71
Create description for appointments API.
summary string 72
Create summary for appointments API.
f072 binary 73
Create f072 for appointments API.
f073 binary 74
Create f073 for appointments API.
f074 binary 75
Create f074 for appointments API.
f075 binary 76
Create f075 for appointments API.
f076 binary 77
Create f076 for appointments API.
cancelled boolean 78
Create cancelled for appointments API.
f078 binary 79
Create f078 for appointments API.
f079 binary 80
Create f079 for appointments API.
f080 binary 81
Create f080 for appointments API.
f081 binary 82
Create f081 for appointments API.
f082 binary 83
Create f082 for appointments API.
f083 binary 84
Create f083 for appointments API.
f084 binary 85
Create f084 for appointments API.
date_stop_local date 86
Create date_stop_local for appointments API.
f086 binary 87
Create f086 for appointments API.
f087 binary 88
Create f087 for appointments API.
f088 binary 89
Create f088 for appointments API.
f089 binary 90
Create f089 for appointments API.
uuid string 91
Create uuid for appointments API.
f091 binary 92
Create f091 for appointments API.
f092 binary 93
Create f092 for appointments API.
f093 binary 94
Create f093 for appointments API.
f094 binary 95
Create f094 for appointments API.
f095 binary 96
Create f095 for appointments API.
f096 binary 97
Create f096 for appointments API.
f097 binary 98
Create f097 for appointments API.
f098 binary 99
Create f098 for appointments API.
token string 100 required
Authentication token for either an application or session.
f099 binary 100
Create f099 for appointments API.
f100 binary 101
Create f100 for appointments API.
f101 binary 102
Create f101 for appointments API.
f102 binary 103
Create f102 for appointments API.
f103 binary 104
Create f103 for appointments API.
f104 binary 105
Create f104 for appointments API.
time_start_office time 106
Create time_start_office for appointments API.
time_stop_office time 107
Create time_stop_office for appointments API.
date_start_office date 108
Create date_start_office for appointments API.
date_stop_office date 109
Create date_stop_office for appointments API.
application_view string 110
View of application object you would like returned.
f109 binary 110
Create f109 for appointments API.
f110 binary 111
Create f110 for appointments API.
f111 binary 112
Create f111 for appointments API.
f112 binary 113
Create f112 for appointments API.
f113 binary 114
Create f113 for appointments API.
f114 binary 115
Create f114 for appointments API.
f115 binary 116
Create f115 for appointments API.
f116 binary 117
Create f116 for appointments API.
f117 binary 118
Create f117 for appointments API.
f118 binary 119
Create f118 for appointments API.
f119 binary 120
Create f119 for appointments API.
f120 binary 121
Create f120 for appointments API.
f121 binary 122
Create f121 for appointments API.
f122 binary 123
Create f122 for appointments API.
f123 binary 124
Create f123 for appointments API.
f124 binary 125
Create f124 for appointments API.
f125 binary 126
Create f125 for appointments API.
f126 binary 127
Create f126 for appointments API.
f127 binary 128
Create f127 for appointments API.
f128 binary 129
Create f128 for appointments API.
f129 binary 130
Create f129 for appointments API.
f130 binary 131
Create f130 for appointments API.
f131 binary 132
Create f131 for appointments API.
f132 binary 133
Create f132 for appointments API.
f133 binary 134
Create f133 for appointments API.
f134 binary 135
Create f134 for appointments API.
f135 binary 136
Create f135 for appointments API.
f136 binary 137
Create f136 for appointments API.
f137 binary 138
Create f137 for appointments API.
f138 binary 139
Create f138 for appointments API.
f139 binary 140
Create f139 for appointments API.
f140 binary 141
Create f140 for appointments API.
f141 binary 142
Create f141 for appointments API.
allday boolean 143
Create allday for appointments API.
f143 binary 144
Create f143 for appointments API.
confirmed_at datetime 145
Create confirmed_at for appointments API.
confirmed_by string 146
Create confirmed_by for appointments API.
f146 binary 147
Create f146 for appointments API.
f147 binary 148
Create f147 for appointments API.
f148 binary 149
Create f148 for appointments API.
f149 binary 150
Create f149 for appointments API.
f150 binary 151
Create f150 for appointments API.
f151 binary 152
Create f151 for appointments API.
f152 binary 153
Create f152 for appointments API.
f153 binary 154
Create f153 for appointments API.
appt_type string 155
Create appt_type for appointments API.
f155 binary 156
Create f155 for appointments API.
f156 binary 157
Create f156 for appointments API.
f157 binary 158
Create f157 for appointments API.
f158 binary 159
Create f158 for appointments API.
f159 binary 160
Create f159 for appointments API.
f160 binary 161
Create f160 for appointments API.
f161 binary 162
Create f161 for appointments API.
f162 binary 163
Create f162 for appointments API.
f163 binary 164
Create f163 for appointments API.
f164 binary 165
Create f164 for appointments API.
same_day_cancel boolean 166
Create same_day_cancel for appointments API.
f166 binary 167
Create f166 for appointments API.
f167 binary 168
Create f167 for appointments API.
f168 binary 169
Create f168 for appointments API.
f169 binary 170
Create f169 for appointments API.
f170 binary 171
Create f170 for appointments API.
f171 binary 172
Create f171 for appointments API.
f172 binary 173
Create f172 for appointments API.
f173 binary 174
Create f173 for appointments API.
f174 binary 175
Create f174 for appointments API.
location string 176
Create location for appointments API.
f176 binary 177
Create f176 for appointments API.
f177 binary 178
Create f177 for appointments API.
f178 binary 179
Create f178 for appointments API.
f179 binary 180
Create f179 for appointments API.
f180 binary 181
Create f180 for appointments API.
f181 binary 182
Create f181 for appointments API.
f182 binary 183
Create f182 for appointments API.
f183 binary 184
Create f183 for appointments API.
f184 binary 185
Create f184 for appointments API.
on_site_cancel boolean 186
Create on_site_cancel for appointments API.
f186 binary 187
Create f186 for appointments API.
f187 binary 188
Create f187 for appointments API.
f188 binary 189
Create f188 for appointments API.
f189 binary 190
Create f189 for appointments API.
f190 binary 191
Create f190 for appointments API.
f191 binary 192
Create f191 for appointments API.
f192 binary 193
Create f192 for appointments API.
f193 binary 194
Create f193 for appointments API.
f194 binary 195
Create f194 for appointments API.
f195 binary 196
Create f195 for appointments API.
f196 binary 197
Create f196 for appointments API.
f197 binary 198
Create f197 for appointments API.
f198 binary 199
Create f198 for appointments API.
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

f199 binary 200
Create f199 for appointments API.
f200 binary 201
Create f200 for appointments API.
f201 binary 202
Create f201 for appointments API.
f202 binary 203
Create f202 for appointments API.
f203 binary 204
Create f203 for appointments API.
f204 binary 205
Create f204 for appointments API.
f205 binary 206
Create f205 for appointments API.
f206 binary 207
Create f206 for appointments API.
f207 binary 208
Create f207 for appointments API.
f208 binary 209
Create f208 for appointments API.
f209 binary 210
Create f209 for appointments API.
f210 binary 211
Create f210 for appointments API.
f211 binary 212
Create f211 for appointments API.
f212 binary 213
Create f212 for appointments API.
f213 binary 214
Create f213 for appointments API.
f214 binary 215
Create f214 for appointments API.
f215 binary 216
Create f215 for appointments API.
f216 binary 217
Create f216 for appointments API.
f217 binary 218
Create f217 for appointments API.
f218 binary 219
Create f218 for appointments API.
f219 binary 220
Create f219 for appointments API.
f220 binary 221
Create f220 for appointments API.
f221 binary 222
Create f221 for appointments API.
f222 binary 223
Create f222 for appointments API.
f223 binary 224
Create f223 for appointments API.
f224 binary 225
Create f224 for appointments API.
f225 binary 226
Create f225 for appointments API.
f226 binary 227
Create f226 for appointments API.
f227 binary 228
Create f227 for appointments API.
f228 binary 229
Create f228 for appointments API.
f229 binary 230
Create f229 for appointments API.
f230 binary 231
Create f230 for appointments API.
f231 binary 232
Create f231 for appointments API.
f232 binary 233
Create f232 for appointments API.
f233 binary 234
Create f233 for appointments API.
f234 binary 235
Create f234 for appointments API.
f235 binary 236
Create f235 for appointments API.
f236 binary 237
Create f236 for appointments API.
f237 binary 238
Create f237 for appointments API.
f238 binary 239
Create f238 for appointments API.
f239 binary 240
Create f239 for appointments API.
f240 binary 241
Create f240 for appointments API.
f241 binary 242
Create f241 for appointments API.
f242 binary 243
Create f242 for appointments API.
f243 binary 244
Create f243 for appointments API.
f244 binary 245
Create f244 for appointments API.
f245 binary 246
Create f245 for appointments API.
f246 binary 247
Create f246 for appointments API.
f247 binary 248
Create f247 for appointments API.
f248 binary 249
Create f248 for appointments API.
f249 binary 250
Create f249 for appointments API.
f250 binary 251
Create f250 for appointments API.
order_request_appt_id integer 252
Create order_request_appt_id for appointments API.
optional boolean 253
Create optional for appointments API.
f253 binary 254
Create f253 for appointments API.
f254 binary 255
Create f254 for appointments API.
f255 binary 256
Create f255 for appointments API.
f256 binary 257
Create f256 for appointments API.
f257 binary 258
Create f257 for appointments API.
f258 binary 259
Create f258 for appointments API.
f259 binary 260
Create f259 for appointments API.
f260 binary 261
Create f260 for appointments API.
f261 binary 262
Create f261 for appointments API.
created_in string 263
Create created_in for appointments API.
f263 binary 264
Create f263 for appointments API.
confirmed boolean 265
Create confirmed for appointments API.
f265 binary 266
Create f265 for appointments API.
f266 binary 267
Create f266 for appointments API.
f267 binary 268
Create f267 for appointments API.
f268 binary 269
Create f268 for appointments API.
f269 binary 270
Create f269 for appointments API.
f270 binary 271
Create f270 for appointments API.
requested_date date 272
Create requested_date for appointments API.
requested_time time 273
Create requested_time for appointments API.
session_view string 300
View of session object you would like returned.

Request Body Example: application/json

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.

invalid-token 401

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

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.

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.

missing-param 400

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

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.

application-crash 500

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

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.

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.

route-non-existent 500

Response returned when HTTP route does not exist.

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.

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.

route-not-found Uncommon

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

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.

service-not-found Uncommon

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