-
Notifications
You must be signed in to change notification settings - Fork 0
Home
Eric Hilary Smith edited this page Sep 19, 2022
·
1 revision
Welcome to the cornflakeshealthcarecontentresourcemanagement wiki!
- Version:* 1.0.0
{toc:printable=true|style=square|minLevel=2|maxLevel=3|type=list|outline=false|include=.*}
h2. Endpoints
h3. actionsCreateNewThingPost {status:colour=Yellow|title=post|subtle=false} {code} post /actions/create_new_thing {code} *Summary:* *Description:*
h4. Parameters
h5. Body Parameter ||Name||Description||Required||Default||Pattern|| |body |Action request for create_new_thing. |(/) | | |
h4. Responses *Status Code:* 200 *Message:* The action response. {code:title=Response Type}
Object
{code} See [#models]
{code:title=Response Schema |collapse=true}
{
"description" : "The action response.", "schema" : { "type" : "object", "required" : [ "data" ], "properties" : { "data" : { "type" : "array", "items" : { "type" : "object", "properties" : { "id" : { "type" : "string" }, "url" : { "type" : "string" } }, "required" : [ "id" ] } } } }
}
{code} *Status Code:* 400 *Message:* There was something wrong with incoming data from IFTTT. Provide an error response body to clarify what went wrong. {code:title=Response Type}
action_errors
{code} See [#models]
{code:title=Response Schema |collapse=true}
{
"description" : "There was something wrong with incoming data from IFTTT. Provide an error response body to clarify what went wrong.", "schema" : { "$ref" : "#/definitions/action_errors" }
}
{code} *Status Code:* 401 *Message:* IFTTT sent an OAuth2 access token that isn’t valid. {code:title=Response Type}
errors
{code} See [#models]
{code:title=Response Schema |collapse=true}
{
"description" : "IFTTT sent an OAuth2 access token that isn’t valid.", "schema" : { "$ref" : "#/definitions/errors" }
}
{code} *Status Code:* 404 *Message:* IFTTT is trying to reach a URL that doesn’t exist. {code:title=Response Type}
errors
{code} See [#models]
{code:title=Response Schema |collapse=true}
{
"description" : "IFTTT is trying to reach a URL that doesn’t exist.", "schema" : { "$ref" : "#/definitions/errors" }
}
{code} *Status Code:* 429 *Message:* IFTTT has sent too many requests in a given amount of time. {code:title=Response Type}
errors
{code} See [#models]
{code:title=Response Schema |collapse=true}
{
"description" : "IFTTT has sent too many requests in a given amount of time.", "schema" : { "$ref" : "#/definitions/errors" }
}
{code} *Status Code:* 500 *Message:* There was an error in your application logic. {code:title=Response Type}
errors
{code} See [#models]
{code:title=Response Schema |collapse=true}
{
"description" : "There was an error in your application logic.", "schema" : { "$ref" : "#/definitions/errors" }
}
{code} *Status Code:* 503 *Message:* Your service is not available at the moment, but IFTTT should try again later. {code:title=Response Type}
errors
{code} See [#models]
{code:title=Response Schema |collapse=true}
{
"description" : "Your service is not available at the moment, but IFTTT should try again later.", "schema" : { "$ref" : "#/definitions/errors" }
}
{code} ----
h3. statusGet {status:colour=Yellow|title=get|subtle=false} {code} get /status {code} *Summary:* *Description:*
h4. Parameters
h4. Responses *Status Code:* 200 *Message:* OK {code:title=Response Type}
{code} See [#models]
{code:title=Response Schema |collapse=true}
{
"description" : "OK"
}
{code} *Status Code:* 503 *Message:* Your service is not available at the moment, but IFTTT should try again later. {code:title=Response Type}
errors
{code} See [#models]
{code:title=Response Schema |collapse=true}
{
"description" : "Your service is not available at the moment, but IFTTT should try again later.", "schema" : { "$ref" : "#/definitions/errors" }
}
{code} ----
h3. triggersAphidsReaxsonPost {status:colour=Yellow|title=post|subtle=false} {code} post /triggers/aphids_reaxson {code} *Summary:* *Description:*
h4. Parameters
h5. Body Parameter ||Name||Description||Required||Default||Pattern|| |body |Trigger request for aphids_reaxson. |(/) | | |
h4. Responses *Status Code:* 200 *Message:* Trigger response for aphids_reaxson. {code:title=Response Type}
Object
{code} See [#models]
{code:title=Response Schema |collapse=true}
{
"description" : "Trigger response for aphids_reaxson.", "schema" : { "type" : "object", "required" : [ "data" ], "properties" : { "data" : { "type" : "array", "items" : { "type" : "object", "properties" : { "sheety_db_api" : { "$ref" : "#/definitions/string_field" }, "created_at" : { "$ref" : "#/definitions/datetime_field" }, "meta" : { "$ref" : "#/definitions/meta" } }, "required" : [ "meta" ] } } } }
}
{code} *Status Code:* 400 *Message:* There was something wrong with incoming data from IFTTT. Provide an error response body to clarify what went wrong. {code:title=Response Type}
errors
{code} See [#models]
{code:title=Response Schema |collapse=true}
{
"description" : "There was something wrong with incoming data from IFTTT. Provide an error response body to clarify what went wrong.", "schema" : { "$ref" : "#/definitions/errors" }
}
{code} *Status Code:* 401 *Message:* IFTTT sent an OAuth2 access token that isn’t valid. {code:title=Response Type}
errors
{code} See [#models]
{code:title=Response Schema |collapse=true}
{
"description" : "IFTTT sent an OAuth2 access token that isn’t valid.", "schema" : { "$ref" : "#/definitions/errors" }
}
{code} *Status Code:* 404 *Message:* IFTTT is trying to reach a URL that doesn’t exist. {code:title=Response Type}
errors
{code} See [#models]
{code:title=Response Schema |collapse=true}
{
"description" : "IFTTT is trying to reach a URL that doesn’t exist.", "schema" : { "$ref" : "#/definitions/errors" }
}
{code} *Status Code:* 429 *Message:* IFTTT has sent too many requests in a given amount of time. {code:title=Response Type}
errors
{code} See [#models]
{code:title=Response Schema |collapse=true}
{
"description" : "IFTTT has sent too many requests in a given amount of time.", "schema" : { "$ref" : "#/definitions/errors" }
}
{code} *Status Code:* 500 *Message:* There was an error in your application logic. {code:title=Response Type}
errors
{code} See [#models]
{code:title=Response Schema |collapse=true}
{
"description" : "There was an error in your application logic.", "schema" : { "$ref" : "#/definitions/errors" }
}
{code} *Status Code:* 503 *Message:* Your service is not available at the moment, but IFTTT should try again later. {code:title=Response Type}
errors
{code} See [#models]
{code:title=Response Schema |collapse=true}
{
"description" : "Your service is not available at the moment, but IFTTT should try again later.", "schema" : { "$ref" : "#/definitions/errors" }
}
{code} ----
h3. triggersNewThingCreatedPost {status:colour=Yellow|title=post|subtle=false} {code} post /triggers/new_thing_created {code} *Summary:* *Description:*
h4. Parameters
h5. Body Parameter ||Name||Description||Required||Default||Pattern|| |body |Trigger request for new_thing_created. |(/) | | |
h4. Responses *Status Code:* 200 *Message:* Trigger response for new_thing_created. {code:title=Response Type}
Object
{code} See [#models]
{code:title=Response Schema |collapse=true}
{
"description" : "Trigger response for new_thing_created.", "schema" : { "type" : "object", "required" : [ "data" ], "properties" : { "data" : { "type" : "array", "items" : { "type" : "object", "properties" : { "created_at" : { "$ref" : "#/definitions/datetime_field" }, "meta" : { "$ref" : "#/definitions/meta" } }, "required" : [ "meta" ] } } } }
}
{code} *Status Code:* 400 *Message:* There was something wrong with incoming data from IFTTT. Provide an error response body to clarify what went wrong. {code:title=Response Type}
errors
{code} See [#models]
{code:title=Response Schema |collapse=true}
{
"description" : "There was something wrong with incoming data from IFTTT. Provide an error response body to clarify what went wrong.", "schema" : { "$ref" : "#/definitions/errors" }
}
{code} *Status Code:* 401 *Message:* IFTTT sent an OAuth2 access token that isn’t valid. {code:title=Response Type}
errors
{code} See [#models]
{code:title=Response Schema |collapse=true}
{
"description" : "IFTTT sent an OAuth2 access token that isn’t valid.", "schema" : { "$ref" : "#/definitions/errors" }
}
{code} *Status Code:* 404 *Message:* IFTTT is trying to reach a URL that doesn’t exist. {code:title=Response Type}
errors
{code} See [#models]
{code:title=Response Schema |collapse=true}
{
"description" : "IFTTT is trying to reach a URL that doesn’t exist.", "schema" : { "$ref" : "#/definitions/errors" }
}
{code} *Status Code:* 429 *Message:* IFTTT has sent too many requests in a given amount of time. {code:title=Response Type}
errors
{code} See [#models]
{code:title=Response Schema |collapse=true}
{
"description" : "IFTTT has sent too many requests in a given amount of time.", "schema" : { "$ref" : "#/definitions/errors" }
}
{code} *Status Code:* 500 *Message:* There was an error in your application logic. {code:title=Response Type}
errors
{code} See [#models]
{code:title=Response Schema |collapse=true}
{
"description" : "There was an error in your application logic.", "schema" : { "$ref" : "#/definitions/errors" }
}
{code} *Status Code:* 503 *Message:* Your service is not available at the moment, but IFTTT should try again later. {code:title=Response Type}
errors
{code} See [#models]
{code:title=Response Schema |collapse=true}
{
"description" : "Your service is not available at the moment, but IFTTT should try again later.", "schema" : { "$ref" : "#/definitions/errors" }
}
{code} ----
h2. Models
h3. Action_errors ||Field Name||Required||Type||Description|| |errors | |array[Object] | | h3. Base_action_request ||Field Name||Required||Type||Description|| |user | |user | | |ifttt_source | |ifttt_source | | h3. Base_trigger_request ||Field Name||Required||Type||Description|| |trigger_identity | |String |A unique identifier for this set of trigger fields for a given Applet. | |limit | |Integer |Maximum number of items to be returned, default 50. | |user | |user | | |ifttt_source | |ifttt_source | | h3. Date_field ||Field Name||Required||Type||Description|| h3. Datetime_field ||Field Name||Required||Type||Description|| h3. Dynamic_validation ||Field Name||Required||Type||Description|| |valid | |Boolean | | |message | |String |A user-facing message for an invalid field. | h3. Errors ||Field Name||Required||Type||Description|| |errors | |array[Object] | | h3. Ifttt_source ||Field Name||Required||Type||Description|| |id | |String | | |url | |String | | h3. Location_field ||Field Name||Required||Type||Description|| |lat | |Double | | |lng | |Double | | |radius | |Double | | h3. Meta ||Field Name||Required||Type||Description|| |id | |String |A unique identifier for the item. | |timestamp | |Integer |A Unix timestamp in seconds. | h3. Option ||Field Name||Required||Type||Description|| |label | |String |A user-facing label. | |value | |String |The actual field value. | h3. String_field ||Field Name||Required||Type||Description|| h3. User ||Field Name||Required||Type||Description|| |id | |Integer | | |timezone | |String | |