|
|
|
|
inline_model {
Query (object, optional)
}
-
paths:
{
-
/{lang}/categories:
{
-
get:
{
-
-
summary: "All the root categories",
-
description: " Categories with negative ids are fixed
-
and are common for all areas/api-keys.
-
The fixed categories are as described below:
-
-1: Σημεία ενδιαφέροντος
-
-2: Χρήσιμα Τηλέφωνα
-
-3: Φαρμακεία
-
-4: Παρκινγκ ΑΜΕΑ
-
-5: Νοσοκομεία ",
-
operationId: "root-category-list",
-
-
}
},
-
/{lang}/categories/{categoryId}/subcategories:
{
-
get:
{
-
-
summary: "All the subcategories of the given category",
-
operationId: "subcategory-list",
-
parameters:
[
-
-
-
{
-
name: "include",
-
in: "query",
-
description: "comma separated list of extra
-
resources to include Available values:<ul>
-
<li><b>subcategories</b>: The subcategories
-
of each subcategory</li> </ul>",
-
required: false,
-
type: "array",
-
-
collectionFormat: "csv"
},
-
],
-
}
},
-
/{lang}/pages/{pageSlug}:
{
-
get:
{
-
-
summary: "The page with the given slug",
-
description: "The fixed slugs are: <ul> <li>
-
<b>contact</b>: Contact page</li> </ul>",
-
operationId: "page-by-slug",
-
-
}
},
-
/{lang}/categories/{categoryId}/pois:
{
},
-
/{lang}/pois/{poiId}:
{
},
-
/{lang}/passwordForgot:
{
-
post:
{
-
-
summary: "Reset Password",
-
operationId: "reset-password",
-
-
}
},
-
/{lang}/login:
{
-
post:
{
-
-
summary: "Login",
-
operationId: "login",
-
parameters:
[
-
-
-
{
-
name: "password",
-
in: "query",
-
description: "",
-
required: true,
-
type: "string"
},
-
],
-
}
},
-
/{lang}/eform/categories:
{
-
get:
{
-
-
summary: "Return the whole nested tree of eform categories",
-
operationId: "eforms-catalog-category",
-
-
}
},
-
/{lang}/eform/statuses:
{
-
get:
{
-
-
summary: "Return a list of possible statuses for an eform,
-
with entries in the form status_id: status_label.",
-
operationId: "eforms-catalog-status",
-
-
}
},
-
/{lang}/municipalities/categories/certificates:
{
-
get:
{
-
-
summary: "Return a list of certificate categories",
-
operationId: "certificate-category-index",
-
-
}
},
-
/{lang}/municipalities/categories/problems:
{
-
get:
{
-
-
summary: "Return a list of problem report categories",
-
operationId: "certificate-problem-index",
-
-
}
},
-
/{lang}/municipalities/certificates/{category_id}:
{
-
get:
{
-
-
summary: "Return a list of certificates",
-
operationId: "certificate-index",
-
-
}
},
-
/{lang}/municipalities/{certificate_id}/certificates:
{
-
post:
{
-
-
summary: "Allow a cityzen to submit a request for a certificate",
-
operationId: "certificate-request-submit",
-
parameters:
[
-
-
-
{
-
name: "input",
-
in: "path",
-
description: "The json array of the fields as returned
-
by the according certificate endpoint. Each object in
-
the array should have an extra key named 'value' with
-
the according field value",
-
required: true,
-
type: "string"
},
-
],
-
}
},
-
/{lang}/municipalities/certificate_requests:
{
-
get:
{
-
-
summary: "Return a list of certificate requests submitted by this registered user",
-
operationId: "certificate-request-user-list",
-
-
}
},
-
/{lang}/municipalities/certificate_requests/{$id}:
{
-
get:
{
-
-
summary: "Return the certificate request with the given id
-
submitted by this user",
-
operationId: "certificate-request-user-show",
-
-
}
},
-
/{lang}/user:
{
-
-
post:
{
-
-
summary: "Update the user info",
-
operationId: "profile-update",
-
-
}
},
-
/{lang}/municipalities/crews/login:
{
},
-
/{lang}/municipalities/employees/login:
{
},
-
/{lang}/municipalities/infrastructures:
{
-
post:
{
-
-
summary: "Anonymous submit of a new infrastructure",
-
operationId: "infrastructure-submit-anonymous",
-
parameters:
[
-
-
{
-
name: "infrastructure_type_id",
-
in: "formData",
-
description: "The id of the infrastructure type",
-
required: true,
-
type: "integer"
},
-
-
-
-
{
-
name: "values",
-
in: "formData",
-
description: "The json array of the fields as returned by the
-
according infrastructure fields endpoint. Each object in the
-
array should have an extra key named 'value' with the according field value",
-
required: true,
-
type: "string"
},
-
],
-
responses:
{
-
-
-
422:
{
-
description: "Validation errors. Key is the field
-
with the validation error and value is an array of
-
validation error messages",
-
},
-
}
}
},
-
/{lang}/municipalities/infrastructureTypes:
{
-
get:
{
-
-
summary: "Return a list of infrastructure types",
-
operationId: "infrastructure-index",
-
-
}
},
-
/{lang}/municipalities/reports/fields:
{
-
get:
{
-
-
summary: "Return a list of fields to be used when submitting a problem report",
-
description: "The superset of available fields is: <ul> <li><b>category_id (integer)
-
</b>:The id of the category that the report is for</li> <li><b>description (string)
-
</b>:The description of the problem</li> <li><b>address (string)</b>:The address
-
near where the problem occurred</li> <li><b>lat (string)</b>:Latitude of the
-
occurence</li> <li><b>lng (string)</b>:Longitude of the occurence</li> <li>
-
<b>image (string)</b>:base64 representation of an image of the problem of
-
the occurence</li> </ul>",
-
operationId: "problem-report-field-list",
-
-
responses:
{
-
200:
{
-
description: "The list of fields. If the fields has a list of
-
acceptable values, then 'value_list' will be shown populated with
-
this values",
-
examples:
{
-
data:
[
-
{
-
field: "category_id",
-
required: true,
-
label: "Κατηγορία"
},
-
{
-
field: "description",
-
required: true,
-
label: "Περιγραφή"
},
-
{
-
field: "address",
-
required: false,
-
label: "Διεύθυνση"
},
-
{
-
field: "lat",
-
required: true,
-
label: "lat"
},
-
{
-
field: "lng",
-
required: true,
-
label: "lng"
},
-
{
-
field: "image",
-
required: false,
-
label: "Εικόνα"
}
]
}
},
-
-
}
}
},
-
/{lang}/municipalities/{category_id}/reports:
{
-
post:
{
-
-
summary: "Allow a registered cityzen to submit a problem report. You should
-
send the fields returned by the fields endpoint. If some are required
-
and not set, you' ll get the according error response.",
-
operationId: "cityzen-report-submit",
-
-
responses:
{
-
-
-
422:
{
-
description: "Validation errors. Key is the field with the
-
validation error and value is an array of validation error messages",
-
},
-
}
}
},
-
/{lang}/municipalities/{category_id}/reports/unregistered:
{
-
post:
{
-
-
summary: "Allow an unregistered cityzen to submit a problem report.
-
Apart from the fields described below, you should also send the fields
-
returned by the fields endpoint. If some are required and not set,
-
you' ll get the according error response.",
-
operationId: "unregistered-cityzen-report-submit",
-
-
responses:
{
-
-
-
422:
{
-
description: "Validation errors. Key is the field with the
-
validation error and value is an array of validation error messages",
-
},
-
}
}
},
-
/{lang}/municipalities/reports:
{
-
get:
{
-
-
summary: "Return a list of problem reports submitted by this registered user",
-
operationId: "problem-report-user-list",
-
-
}
},
-
/{lang}/municipalities/reports/{$id}:
{
-
get:
{
-
-
summary: "Return the problem report with the given id submitted by this user",
-
operationId: "problem-report-user-show",
-
-
}
},
-
/{lang}/user/registrationFields:
{
-
get:
{
-
-
summary: "The fields that are presented on the registration form
-
of a new user (apart from email,password)",
-
operationId: "registration_fields",
-
-
responses:
{
-
200:
{
-
description: "The list of fields. If the fields has a list of
-
acceptable values, then 'value_list' will be shown populated
-
with this values",
-
examples:
{
-
data:
[
-
{
-
field: "name",
-
type: "text",
-
required: true,
-
label: "Fullname"
},
-
{
-
field: "municipal_section",
-
type: "list",
-
required: false,
-
label: "Municipal Section",
-
}
]
}
},
-
-
}
}
},
-
/{lang}/user/register:
{
-
post:
{
-
-
summary: "Register with the extra fields returned by registrationFields
-
endpoint. Apart from the fields shown below you can also send all the other
-
fields returned by the previous endpoint. If some are required and not set,
-
you' ll get the according error response.",
-
operationId: "register",
-
parameters:
[
-
-
-
{
-
name: "password",
-
in: "formData",
-
description: "Password",
-
required: true,
-
type: "string"
},
-
],
-
}
},
-
/{lang}/municipalities/tasks:
{
-
get:
{
-
-
summary: "Return a list of work orders that are assigned to the user",
-
operationId: "task-index",
-
-
}
},
-
/{lang}/municipalities/tasks/{id}:
{
-
get:
{
-
-
summary: "Return a specific workorder",
-
operationId: "task-show",
-
-
}
},
-
/lang}/municipalities/tasks/{id}:
{
-
post:
{
-
-
summary: "Allow a crew member to update a certain work order",
-
operationId: "task-update",
-
parameters:
[
-
-
-
{
-
name: "status",
-
in: "formData",
-
description: "The status of the task.
-
Available values:
-
{status_pending,status_read,status_in_progress,
-
status_success,status_error}",
-
required: false,
-
type: "string",
-
enum:
[
-
"status_pending",
-
"status_read",
-
"status_in_progress",
-
"status_success",
-
"status_error"
]
},
-
-
-
],
-
responses:
{
-
-
-
422:
{
-
description: "Validation errors. Key is the field with
-
the validation error and value is an array of validation error messages",
-
},
-
}
}
},
-
/{lang}/municipalities/tasks/status:
{
-
get:
{
-
-
summary: "Return a list of possible statuses for a work order",
-
operationId: "task-status-index",
-
-
}
},
-
/{lang}/notifications:
{
-
get:
{
-
-
summary: "Return a list of notifications for this specific user",
-
operationId: "notification-list",
-
parameters:
[
-
-
-
{
-
name: "read_filter",
-
in: "query",
-
description: "If true only read notification retrieved.
-
If false only unread are retrieved. In not set all are retrieved",
-
type: "boolean"
},
-
{
-
name: "created_at_filter",
-
in: "query",
-
description: "The bottom limit date, since when we want
-
to retrieve dates. The format is YYYY-MM-DD HH:mm e.g 2018-12-31 23:59",
-
type: "string"
}
],
-
}
},
-
/{lang}/notifications/{id}/read:
{
-
post:
{
-
-
summary: "Allow a registered user to mark a notification as read",
-
operationId: "notification-mark-read",
-
-
responses:
{
-
-
-
422:
{
-
description: "Validation errors. Key is the field with the
-
validation error and value is an array of validation error messages",
-
},
-
}
}
},
-
/{lang}/questionnaires:
{
-
get:
{
-
-
summary: "Return a list of questionnaires",
-
operationId: "questionnaire-index",
-
-
}
},
-
/{lang}/questionnaires/{id}:
{
-
get:
{
-
-
summary: "Return a specific questionnaire",
-
operationId: "questionnaire-show",
-
-
}
},
-
/{lang}/questionnaires/{questionnaire_id}/input:
{
-
get:
{
-
-
summary: "Get all fill-ins of the cityzen for the given questionnaire",
-
operationId: "questionnaire-fill-in-index",
-
parameters:
[
-
-
{
-
name: "questionnaire_id",
-
in: "path",
-
description: "The id of the questionnaire that the request is for",
-
required: true,
-
type: "string"
},
-
],
-
responses:
{
-
-
-
422:
{
-
description: "Validation errors. Key is the field with the
-
validation error and value is an array of validation error messages",
-
},
-
}
},
-
post:
{
-
-
summary: "Allow a cityzen to fill in a questionnaire",
-
operationId: "questionnaire-submit",
-
parameters:
[
-
-
{
-
name: "questionnaire_id",
-
in: "path",
-
description: "The id of the questionnaire that the request is for",
-
required: true,
-
type: "string"
},
-
{
-
name: "input",
-
in: "path",
-
description: "The json array of the fields as returned by the
-
according questionnaire endpoint. Each object in the array should
-
have an extra key named 'value' with the according field value",
-
required: true,
-
type: "string"
},
-
],
-
responses:
{
-
-
-
422:
{
-
description: "Validation errors. Key is the field with the
-
validation error and value is an array of validation error messages",
-
},
-
}
}
},
-
/{lang}/questionnaires/{questionnaire_id}/input/unregistered:
{
-
post:
{
-
-
summary: "Allow an unregistered user to fill in a questionnaire",
-
operationId: "unregistered-questionnaire-submit",
-
parameters:
[
-
-
{
-
name: "questionnaire_id",
-
in: "path",
-
description: "The id of the questionnaire that the request is for",
-
required: true,
-
type: "string"
},
-
{
-
name: "input",
-
in: "path",
-
description: "The json array of the fields as returned by the
-
according questionnaire endpoint. Each object in the array should
-
have an extra key named 'value' with the according field value",
-
required: true,
-
type: "string"
},
-
],
-
responses:
{
-
-
-
422:
{
-
description: "Validation errors. Key is the field with the
-
validation error and value is an array of validation error messages",
-
},
-
}
}
},
-
/{lang}/services:
{
-
get:
{
-
-
summary: "Return a list of services",
-
operationId: "service-index",
-
-
}
},
-
/{lang}/services/{id}:
{
-
get:
{
-
-
summary: "Return a specific service",
-
operationId: "service-show",
-
-
}
},
-
/{lang}/services/{service_id}/input:
{
-
get:
{
-
-
summary: "Get all requests of the cityzen for the given Service",
-
operationId: "Service-request-index",
-
-
responses:
{
-
-
-
422:
{
-
description: "Validation errors. Key is the field with the
-
validation error and value is an array of validation error messages",
-
},
-
}
},
-
post:
{
-
-
summary: "Allow a user to submit a service request",
-
operationId: "Service-request-submit",
-
parameters:
[
-
-
-
{
-
name: "input",
-
in: "path",
-
description: "The json array of the fields as returned by the
-
according service endpoint. Each object in the array should have an
-
extra key named 'value' with the according field value",
-
required: true,
-
type: "string"
},
-
],
-
responses:
{
-
-
-
422:
{
-
description: "Validation errors. Key is the field with the
-
validation error and value is an array of validation error messages",
-
},
-
}
}
},
-
/{lang}/services/{service_id}/input/unregistered:
{
-
post:
{
-
-
summary: "Allow an unregistered user to request a service",
-
operationId: "unregistered-service-request-submit",
-
parameters:
[
-
-
-
{
-
name: "input",
-
in: "path",
-
description: "The json array of the fields as returned by the
-
according service endpoint. Each object in the array should have an
-
extra key named 'value' with the according field value",
-
required: true,
-
type: "string"
},
-
],
-
|