|
- openapi: 3.1.0
- info:
- title: 'Imaq Platform'
- description: ''
- version: 1.0.0
- servers:
- -
- url: /
- description: ''
- paths:
- /api/auth:
- post:
- operationId: postCredentialsItem
- tags:
- - Auth
- responses:
- '200':
- description: 'Get JWT token'
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/AuthResponse'
- summary: 'Get JWT token to login.'
- requestBody:
- description: 'Generate new JWT Token'
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/Credentials'
- required: false
- security: []
- /api/events:
- get:
- operationId: api_events_get_collection
- tags:
- - Event
- responses:
- '200':
- description: 'Event collection'
- content:
- application/ld+json:
- schema:
- type: object
- properties:
- member: { type: array, items: { $ref: '#/components/schemas/Event.jsonld' } }
- totalItems: { type: integer, minimum: 0 }
- view: { type: object, properties: { '@id': { type: string, format: iri-reference }, '@type': { type: string }, first: { type: string, format: iri-reference }, last: { type: string, format: iri-reference }, previous: { type: string, format: iri-reference }, next: { type: string, format: iri-reference } }, example: { '@id': string, type: string, first: string, last: string, previous: string, next: string } }
- search: { type: object, properties: { '@type': { type: string }, template: { type: string }, variableRepresentation: { type: string }, mapping: { type: array, items: { type: object, properties: { '@type': { type: string }, variable: { type: string }, property: { type: [string, 'null'] }, required: { type: boolean } } } } } }
- required:
- - member
- '403':
- description: Forbidden
- content:
- application/ld+json:
- schema:
- $ref: '#/components/schemas/Error.jsonld'
- application/problem+json:
- schema:
- $ref: '#/components/schemas/Error'
- application/json:
- schema:
- $ref: '#/components/schemas/Error'
- links: { }
- summary: 'Retrieves the collection of Event resources.'
- description: 'Retrieves the collection of Event resources.'
- parameters:
- -
- name: page
- in: query
- description: 'The collection page number'
- required: false
- deprecated: false
- allowEmptyValue: true
- schema:
- type: integer
- default: 1
- style: form
- explode: false
- allowReserved: false
- -
- name: itemsPerPage
- in: query
- description: 'The number of items per page'
- required: false
- deprecated: false
- allowEmptyValue: true
- schema:
- type: integer
- default: 50
- minimum: 0
- maximum: 200
- style: form
- explode: false
- allowReserved: false
- -
- name: name
- in: query
- description: ''
- required: false
- deprecated: false
- allowEmptyValue: false
- schema:
- type: string
- style: form
- explode: false
- allowReserved: false
- -
- name: custom_json_filter
- in: query
- description: ''
- required: false
- deprecated: false
- allowEmptyValue: false
- schema:
- type: string
- style: form
- explode: false
- allowReserved: false
- -
- name: custom_json_order
- in: query
- description: ''
- required: false
- deprecated: false
- allowEmptyValue: true
- schema:
- type: string
- style: form
- explode: false
- allowReserved: false
- deprecated: false
- '/api/events/{id}':
- get:
- operationId: api_events_id_get
- tags:
- - Event
- responses:
- '200':
- description: 'Event resource'
- content:
- application/ld+json:
- schema:
- $ref: '#/components/schemas/Event.jsonld'
- '403':
- description: Forbidden
- content:
- application/ld+json:
- schema:
- $ref: '#/components/schemas/Error.jsonld'
- application/problem+json:
- schema:
- $ref: '#/components/schemas/Error'
- application/json:
- schema:
- $ref: '#/components/schemas/Error'
- links: { }
- '404':
- description: 'Not found'
- content:
- application/ld+json:
- schema:
- $ref: '#/components/schemas/Error.jsonld'
- application/problem+json:
- schema:
- $ref: '#/components/schemas/Error'
- application/json:
- schema:
- $ref: '#/components/schemas/Error'
- links: { }
- summary: 'Retrieves a Event resource.'
- description: 'Retrieves a Event resource.'
- parameters:
- -
- name: id
- in: path
- description: 'Event identifier'
- required: true
- deprecated: false
- allowEmptyValue: false
- schema:
- type: string
- style: simple
- explode: false
- allowReserved: false
- deprecated: false
- /api/locations:
- get:
- operationId: api_locations_get_collection
- tags:
- - Location
- responses:
- '200':
- description: 'Location collection'
- content:
- application/ld+json:
- schema:
- type: object
- properties:
- member: { type: array, items: { $ref: '#/components/schemas/Location.jsonld' } }
- totalItems: { type: integer, minimum: 0 }
- view: { type: object, properties: { '@id': { type: string, format: iri-reference }, '@type': { type: string }, first: { type: string, format: iri-reference }, last: { type: string, format: iri-reference }, previous: { type: string, format: iri-reference }, next: { type: string, format: iri-reference } }, example: { '@id': string, type: string, first: string, last: string, previous: string, next: string } }
- search: { type: object, properties: { '@type': { type: string }, template: { type: string }, variableRepresentation: { type: string }, mapping: { type: array, items: { type: object, properties: { '@type': { type: string }, variable: { type: string }, property: { type: [string, 'null'] }, required: { type: boolean } } } } } }
- required:
- - member
- '403':
- description: Forbidden
- content:
- application/ld+json:
- schema:
- $ref: '#/components/schemas/Error.jsonld'
- application/problem+json:
- schema:
- $ref: '#/components/schemas/Error'
- application/json:
- schema:
- $ref: '#/components/schemas/Error'
- links: { }
- summary: 'Retrieves the collection of Location resources.'
- description: 'Retrieves the collection of Location resources.'
- parameters:
- -
- name: page
- in: query
- description: 'The collection page number'
- required: false
- deprecated: false
- allowEmptyValue: true
- schema:
- type: integer
- default: 1
- style: form
- explode: false
- allowReserved: false
- -
- name: itemsPerPage
- in: query
- description: 'The number of items per page'
- required: false
- deprecated: false
- allowEmptyValue: true
- schema:
- type: integer
- default: 50
- minimum: 0
- maximum: 200
- style: form
- explode: false
- allowReserved: false
- -
- name: locationNameCodeSearch
- in: query
- description: ''
- required: false
- deprecated: false
- allowEmptyValue: true
- schema:
- type: string
- style: form
- explode: false
- allowReserved: false
- -
- name: custom_json_filter
- in: query
- description: ''
- required: false
- deprecated: false
- allowEmptyValue: false
- schema:
- type: string
- style: form
- explode: false
- allowReserved: false
- -
- name: custom_json_order
- in: query
- description: ''
- required: false
- deprecated: false
- allowEmptyValue: true
- schema:
- type: string
- style: form
- explode: false
- allowReserved: false
- deprecated: false
- post:
- operationId: api_locations_post
- tags:
- - Location
- responses:
- '201':
- description: 'Location resource created'
- content:
- application/ld+json:
- schema:
- $ref: '#/components/schemas/Location.jsonld'
- links: { }
- '400':
- description: 'Invalid input'
- content:
- application/ld+json:
- schema:
- $ref: '#/components/schemas/Error.jsonld'
- application/problem+json:
- schema:
- $ref: '#/components/schemas/Error'
- application/json:
- schema:
- $ref: '#/components/schemas/Error'
- links: { }
- '422':
- description: 'An error occurred'
- content:
- application/ld+json:
- schema:
- $ref: '#/components/schemas/ConstraintViolation.jsonld-jsonld'
- application/problem+json:
- schema:
- $ref: '#/components/schemas/ConstraintViolation-json'
- application/json:
- schema:
- $ref: '#/components/schemas/ConstraintViolation-json'
- links: { }
- '403':
- description: Forbidden
- content:
- application/ld+json:
- schema:
- $ref: '#/components/schemas/Error.jsonld'
- application/problem+json:
- schema:
- $ref: '#/components/schemas/Error'
- application/json:
- schema:
- $ref: '#/components/schemas/Error'
- links: { }
- summary: 'Creates a Location resource.'
- description: 'Creates a Location resource.'
- parameters: []
- requestBody:
- description: 'The new Location resource'
- content:
- application/ld+json:
- schema:
- $ref: '#/components/schemas/Location.jsonld'
- required: true
- deprecated: false
- '/api/locations/{id}':
- get:
- operationId: api_locations_id_get
- tags:
- - Location
- responses:
- '200':
- description: 'Location resource'
- content:
- application/ld+json:
- schema:
- $ref: '#/components/schemas/Location.jsonld'
- '403':
- description: Forbidden
- content:
- application/ld+json:
- schema:
- $ref: '#/components/schemas/Error.jsonld'
- application/problem+json:
- schema:
- $ref: '#/components/schemas/Error'
- application/json:
- schema:
- $ref: '#/components/schemas/Error'
- links: { }
- '404':
- description: 'Not found'
- content:
- application/ld+json:
- schema:
- $ref: '#/components/schemas/Error.jsonld'
- application/problem+json:
- schema:
- $ref: '#/components/schemas/Error'
- application/json:
- schema:
- $ref: '#/components/schemas/Error'
- links: { }
- summary: 'Retrieves a Location resource.'
- description: 'Retrieves a Location resource.'
- parameters:
- -
- name: id
- in: path
- description: 'Location identifier'
- required: true
- deprecated: false
- allowEmptyValue: false
- schema:
- type: string
- style: simple
- explode: false
- allowReserved: false
- deprecated: false
- delete:
- operationId: api_locations_id_delete
- tags:
- - Location
- responses:
- '204':
- description: 'Location resource deleted'
- '403':
- description: Forbidden
- content:
- application/ld+json:
- schema:
- $ref: '#/components/schemas/Error.jsonld'
- application/problem+json:
- schema:
- $ref: '#/components/schemas/Error'
- application/json:
- schema:
- $ref: '#/components/schemas/Error'
- links: { }
- '404':
- description: 'Not found'
- content:
- application/ld+json:
- schema:
- $ref: '#/components/schemas/Error.jsonld'
- application/problem+json:
- schema:
- $ref: '#/components/schemas/Error'
- application/json:
- schema:
- $ref: '#/components/schemas/Error'
- links: { }
- summary: 'Removes the Location resource.'
- description: 'Removes the Location resource.'
- parameters:
- -
- name: id
- in: path
- description: 'Location identifier'
- required: true
- deprecated: false
- allowEmptyValue: false
- schema:
- type: string
- style: simple
- explode: false
- allowReserved: false
- deprecated: false
- patch:
- operationId: api_locations_id_patch
- tags:
- - Location
- responses:
- '200':
- description: 'Location resource updated'
- content:
- application/ld+json:
- schema:
- $ref: '#/components/schemas/Location.jsonld'
- links: { }
- '400':
- description: 'Invalid input'
- content:
- application/ld+json:
- schema:
- $ref: '#/components/schemas/Error.jsonld'
- application/problem+json:
- schema:
- $ref: '#/components/schemas/Error'
- application/json:
- schema:
- $ref: '#/components/schemas/Error'
- links: { }
- '422':
- description: 'An error occurred'
- content:
- application/ld+json:
- schema:
- $ref: '#/components/schemas/ConstraintViolation.jsonld-jsonld'
- application/problem+json:
- schema:
- $ref: '#/components/schemas/ConstraintViolation-json'
- application/json:
- schema:
- $ref: '#/components/schemas/ConstraintViolation-json'
- links: { }
- '403':
- description: Forbidden
- content:
- application/ld+json:
- schema:
- $ref: '#/components/schemas/Error.jsonld'
- application/problem+json:
- schema:
- $ref: '#/components/schemas/Error'
- application/json:
- schema:
- $ref: '#/components/schemas/Error'
- links: { }
- '404':
- description: 'Not found'
- content:
- application/ld+json:
- schema:
- $ref: '#/components/schemas/Error.jsonld'
- application/problem+json:
- schema:
- $ref: '#/components/schemas/Error'
- application/json:
- schema:
- $ref: '#/components/schemas/Error'
- links: { }
- summary: 'Updates the Location resource.'
- description: 'Updates the Location resource.'
- parameters:
- -
- name: id
- in: path
- description: 'Location identifier'
- required: true
- deprecated: false
- allowEmptyValue: false
- schema:
- type: string
- style: simple
- explode: false
- allowReserved: false
- requestBody:
- description: 'The updated Location resource'
- content:
- application/merge-patch+json:
- schema:
- $ref: '#/components/schemas/Location'
- required: true
- deprecated: false
- /api/media_objects:
- get:
- operationId: api_media_objects_get_collection
- tags:
- - MediaObject
- responses:
- '200':
- description: 'MediaObject collection'
- content:
- application/ld+json:
- schema:
- type: object
- properties:
- member: { type: array, items: { $ref: '#/components/schemas/MediaObject.jsonld' } }
- totalItems: { type: integer, minimum: 0 }
- view: { type: object, properties: { '@id': { type: string, format: iri-reference }, '@type': { type: string }, first: { type: string, format: iri-reference }, last: { type: string, format: iri-reference }, previous: { type: string, format: iri-reference }, next: { type: string, format: iri-reference } }, example: { '@id': string, type: string, first: string, last: string, previous: string, next: string } }
- search: { type: object, properties: { '@type': { type: string }, template: { type: string }, variableRepresentation: { type: string }, mapping: { type: array, items: { type: object, properties: { '@type': { type: string }, variable: { type: string }, property: { type: [string, 'null'] }, required: { type: boolean } } } } } }
- required:
- - member
- '403':
- description: Forbidden
- content:
- application/ld+json:
- schema:
- $ref: '#/components/schemas/Error.jsonld'
- application/problem+json:
- schema:
- $ref: '#/components/schemas/Error'
- application/json:
- schema:
- $ref: '#/components/schemas/Error'
- links: { }
- summary: 'Retrieves the collection of MediaObject resources.'
- description: 'Retrieves the collection of MediaObject resources.'
- parameters:
- -
- name: page
- in: query
- description: 'The collection page number'
- required: false
- deprecated: false
- allowEmptyValue: true
- schema:
- type: integer
- default: 1
- style: form
- explode: false
- allowReserved: false
- -
- name: itemsPerPage
- in: query
- description: 'The number of items per page'
- required: false
- deprecated: false
- allowEmptyValue: true
- schema:
- type: integer
- default: 50
- minimum: 0
- maximum: 200
- style: form
- explode: false
- allowReserved: false
- deprecated: false
- post:
- operationId: api_media_objects_post
- tags:
- - MediaObject
- responses:
- '201':
- description: 'MediaObject resource created'
- content:
- application/ld+json:
- schema:
- $ref: '#/components/schemas/MediaObject.jsonld'
- links: { }
- '400':
- description: 'Invalid input'
- content:
- application/ld+json:
- schema:
- $ref: '#/components/schemas/Error.jsonld'
- application/problem+json:
- schema:
- $ref: '#/components/schemas/Error'
- application/json:
- schema:
- $ref: '#/components/schemas/Error'
- links: { }
- '422':
- description: 'An error occurred'
- content:
- application/ld+json:
- schema:
- $ref: '#/components/schemas/ConstraintViolation.jsonld-jsonld'
- application/problem+json:
- schema:
- $ref: '#/components/schemas/ConstraintViolation-json'
- application/json:
- schema:
- $ref: '#/components/schemas/ConstraintViolation-json'
- links: { }
- '403':
- description: Forbidden
- content:
- application/ld+json:
- schema:
- $ref: '#/components/schemas/Error.jsonld'
- application/problem+json:
- schema:
- $ref: '#/components/schemas/Error'
- application/json:
- schema:
- $ref: '#/components/schemas/Error'
- links: { }
- summary: 'Creates a MediaObject resource.'
- description: 'Creates a MediaObject resource.'
- parameters: []
- requestBody:
- description: 'The new MediaObject resource'
- content:
- multipart/form-data:
- schema:
- type: object
- properties:
- file:
- type: string
- format: binary
- required: false
- deprecated: false
- '/api/media_objects/{id}':
- get:
- operationId: api_media_objects_id_get
- tags:
- - MediaObject
- responses:
- '200':
- description: 'MediaObject resource'
- content:
- application/ld+json:
- schema:
- $ref: '#/components/schemas/MediaObject.jsonld'
- '403':
- description: Forbidden
- content:
- application/ld+json:
- schema:
- $ref: '#/components/schemas/Error.jsonld'
- application/problem+json:
- schema:
- $ref: '#/components/schemas/Error'
- application/json:
- schema:
- $ref: '#/components/schemas/Error'
- links: { }
- '404':
- description: 'Not found'
- content:
- application/ld+json:
- schema:
- $ref: '#/components/schemas/Error.jsonld'
- application/problem+json:
- schema:
- $ref: '#/components/schemas/Error'
- application/json:
- schema:
- $ref: '#/components/schemas/Error'
- links: { }
- summary: 'Retrieves a MediaObject resource.'
- description: 'Retrieves a MediaObject resource.'
- parameters:
- -
- name: id
- in: path
- description: 'MediaObject identifier'
- required: true
- deprecated: false
- allowEmptyValue: false
- schema:
- type: string
- style: simple
- explode: false
- allowReserved: false
- deprecated: false
- delete:
- operationId: api_media_objects_id_delete
- tags:
- - MediaObject
- responses:
- '204':
- description: 'MediaObject resource deleted'
- '403':
- description: Forbidden
- content:
- application/ld+json:
- schema:
- $ref: '#/components/schemas/Error.jsonld'
- application/problem+json:
- schema:
- $ref: '#/components/schemas/Error'
- application/json:
- schema:
- $ref: '#/components/schemas/Error'
- links: { }
- '404':
- description: 'Not found'
- content:
- application/ld+json:
- schema:
- $ref: '#/components/schemas/Error.jsonld'
- application/problem+json:
- schema:
- $ref: '#/components/schemas/Error'
- application/json:
- schema:
- $ref: '#/components/schemas/Error'
- links: { }
- summary: 'Removes the MediaObject resource.'
- description: 'Removes the MediaObject resource.'
- parameters:
- -
- name: id
- in: path
- description: 'MediaObject identifier'
- required: true
- deprecated: false
- allowEmptyValue: false
- schema:
- type: string
- style: simple
- explode: false
- allowReserved: false
- deprecated: false
- /api/shipping_companies:
- get:
- operationId: api_shipping_companies_get_collection
- tags:
- - ShippingCompany
- responses:
- '200':
- description: 'ShippingCompany collection'
- content:
- application/ld+json:
- schema:
- type: object
- properties:
- member: { type: array, items: { $ref: '#/components/schemas/ShippingCompany.jsonld' } }
- totalItems: { type: integer, minimum: 0 }
- view: { type: object, properties: { '@id': { type: string, format: iri-reference }, '@type': { type: string }, first: { type: string, format: iri-reference }, last: { type: string, format: iri-reference }, previous: { type: string, format: iri-reference }, next: { type: string, format: iri-reference } }, example: { '@id': string, type: string, first: string, last: string, previous: string, next: string } }
- search: { type: object, properties: { '@type': { type: string }, template: { type: string }, variableRepresentation: { type: string }, mapping: { type: array, items: { type: object, properties: { '@type': { type: string }, variable: { type: string }, property: { type: [string, 'null'] }, required: { type: boolean } } } } } }
- required:
- - member
- '403':
- description: Forbidden
- content:
- application/ld+json:
- schema:
- $ref: '#/components/schemas/Error.jsonld'
- application/problem+json:
- schema:
- $ref: '#/components/schemas/Error'
- application/json:
- schema:
- $ref: '#/components/schemas/Error'
- links: { }
- summary: 'Retrieves the collection of ShippingCompany resources.'
- description: 'Retrieves the collection of ShippingCompany resources.'
- parameters:
- -
- name: page
- in: query
- description: 'The collection page number'
- required: false
- deprecated: false
- allowEmptyValue: true
- schema:
- type: integer
- default: 1
- style: form
- explode: false
- allowReserved: false
- -
- name: itemsPerPage
- in: query
- description: 'The number of items per page'
- required: false
- deprecated: false
- allowEmptyValue: true
- schema:
- type: integer
- default: 50
- minimum: 0
- maximum: 200
- style: form
- explode: false
- allowReserved: false
- -
- name: name
- in: query
- description: ''
- required: false
- deprecated: false
- allowEmptyValue: false
- schema:
- type: string
- style: form
- explode: false
- allowReserved: false
- -
- name: custom_json_filter
- in: query
- description: ''
- required: false
- deprecated: false
- allowEmptyValue: false
- schema:
- type: string
- style: form
- explode: false
- allowReserved: false
- -
- name: custom_json_order
- in: query
- description: ''
- required: false
- deprecated: false
- allowEmptyValue: true
- schema:
- type: string
- style: form
- explode: false
- allowReserved: false
- deprecated: false
- post:
- operationId: api_shipping_companies_post
- tags:
- - ShippingCompany
- responses:
- '201':
- description: 'ShippingCompany resource created'
- content:
- application/ld+json:
- schema:
- $ref: '#/components/schemas/ShippingCompany.jsonld'
- links: { }
- '400':
- description: 'Invalid input'
- content:
- application/ld+json:
- schema:
- $ref: '#/components/schemas/Error.jsonld'
- application/problem+json:
- schema:
- $ref: '#/components/schemas/Error'
- application/json:
- schema:
- $ref: '#/components/schemas/Error'
- links: { }
- '422':
- description: 'An error occurred'
- content:
- application/ld+json:
- schema:
- $ref: '#/components/schemas/ConstraintViolation.jsonld-jsonld'
- application/problem+json:
- schema:
- $ref: '#/components/schemas/ConstraintViolation-json'
- application/json:
- schema:
- $ref: '#/components/schemas/ConstraintViolation-json'
- links: { }
- '403':
- description: Forbidden
- content:
- application/ld+json:
- schema:
- $ref: '#/components/schemas/Error.jsonld'
- application/problem+json:
- schema:
- $ref: '#/components/schemas/Error'
- application/json:
- schema:
- $ref: '#/components/schemas/Error'
- links: { }
- summary: 'Creates a ShippingCompany resource.'
- description: 'Creates a ShippingCompany resource.'
- parameters: []
- requestBody:
- description: 'The new ShippingCompany resource'
- content:
- application/ld+json:
- schema:
- $ref: '#/components/schemas/ShippingCompany.jsonld'
- required: true
- deprecated: false
- '/api/shipping_companies/{id}':
- get:
- operationId: api_shipping_companies_id_get
- tags:
- - ShippingCompany
- responses:
- '200':
- description: 'ShippingCompany resource'
- content:
- application/ld+json:
- schema:
- $ref: '#/components/schemas/ShippingCompany.jsonld'
- '403':
- description: Forbidden
- content:
- application/ld+json:
- schema:
- $ref: '#/components/schemas/Error.jsonld'
- application/problem+json:
- schema:
- $ref: '#/components/schemas/Error'
- application/json:
- schema:
- $ref: '#/components/schemas/Error'
- links: { }
- '404':
- description: 'Not found'
- content:
- application/ld+json:
- schema:
- $ref: '#/components/schemas/Error.jsonld'
- application/problem+json:
- schema:
- $ref: '#/components/schemas/Error'
- application/json:
- schema:
- $ref: '#/components/schemas/Error'
- links: { }
- summary: 'Retrieves a ShippingCompany resource.'
- description: 'Retrieves a ShippingCompany resource.'
- parameters:
- -
- name: id
- in: path
- description: 'ShippingCompany identifier'
- required: true
- deprecated: false
- allowEmptyValue: false
- schema:
- type: string
- style: simple
- explode: false
- allowReserved: false
- deprecated: false
- delete:
- operationId: api_shipping_companies_id_delete
- tags:
- - ShippingCompany
- responses:
- '204':
- description: 'ShippingCompany resource deleted'
- '403':
- description: Forbidden
- content:
- application/ld+json:
- schema:
- $ref: '#/components/schemas/Error.jsonld'
- application/problem+json:
- schema:
- $ref: '#/components/schemas/Error'
- application/json:
- schema:
- $ref: '#/components/schemas/Error'
- links: { }
- '404':
- description: 'Not found'
- content:
- application/ld+json:
- schema:
- $ref: '#/components/schemas/Error.jsonld'
- application/problem+json:
- schema:
- $ref: '#/components/schemas/Error'
- application/json:
- schema:
- $ref: '#/components/schemas/Error'
- links: { }
- summary: 'Removes the ShippingCompany resource.'
- description: 'Removes the ShippingCompany resource.'
- parameters:
- -
- name: id
- in: path
- description: 'ShippingCompany identifier'
- required: true
- deprecated: false
- allowEmptyValue: false
- schema:
- type: string
- style: simple
- explode: false
- allowReserved: false
- deprecated: false
- patch:
- operationId: api_shipping_companies_id_patch
- tags:
- - ShippingCompany
- responses:
- '200':
- description: 'ShippingCompany resource updated'
- content:
- application/ld+json:
- schema:
- $ref: '#/components/schemas/ShippingCompany.jsonld'
- links: { }
- '400':
- description: 'Invalid input'
- content:
- application/ld+json:
- schema:
- $ref: '#/components/schemas/Error.jsonld'
- application/problem+json:
- schema:
- $ref: '#/components/schemas/Error'
- application/json:
- schema:
- $ref: '#/components/schemas/Error'
- links: { }
- '422':
- description: 'An error occurred'
- content:
- application/ld+json:
- schema:
- $ref: '#/components/schemas/ConstraintViolation.jsonld-jsonld'
- application/problem+json:
- schema:
- $ref: '#/components/schemas/ConstraintViolation-json'
- application/json:
- schema:
- $ref: '#/components/schemas/ConstraintViolation-json'
- links: { }
- '403':
- description: Forbidden
- content:
- application/ld+json:
- schema:
- $ref: '#/components/schemas/Error.jsonld'
- application/problem+json:
- schema:
- $ref: '#/components/schemas/Error'
- application/json:
- schema:
- $ref: '#/components/schemas/Error'
- links: { }
- '404':
- description: 'Not found'
- content:
- application/ld+json:
- schema:
- $ref: '#/components/schemas/Error.jsonld'
- application/problem+json:
- schema:
- $ref: '#/components/schemas/Error'
- application/json:
- schema:
- $ref: '#/components/schemas/Error'
- links: { }
- summary: 'Updates the ShippingCompany resource.'
- description: 'Updates the ShippingCompany resource.'
- parameters:
- -
- name: id
- in: path
- description: 'ShippingCompany identifier'
- required: true
- deprecated: false
- allowEmptyValue: false
- schema:
- type: string
- style: simple
- explode: false
- allowReserved: false
- requestBody:
- description: 'The updated ShippingCompany resource'
- content:
- application/merge-patch+json:
- schema:
- $ref: '#/components/schemas/ShippingCompany'
- required: true
- deprecated: false
- /api/trips:
- get:
- operationId: api_trips_get_collection
- tags:
- - Trip
- responses:
- '200':
- description: 'Trip collection'
- content:
- application/ld+json:
- schema:
- type: object
- properties:
- member: { type: array, items: { $ref: '#/components/schemas/Trip.jsonld' } }
- totalItems: { type: integer, minimum: 0 }
- view: { type: object, properties: { '@id': { type: string, format: iri-reference }, '@type': { type: string }, first: { type: string, format: iri-reference }, last: { type: string, format: iri-reference }, previous: { type: string, format: iri-reference }, next: { type: string, format: iri-reference } }, example: { '@id': string, type: string, first: string, last: string, previous: string, next: string } }
- search: { type: object, properties: { '@type': { type: string }, template: { type: string }, variableRepresentation: { type: string }, mapping: { type: array, items: { type: object, properties: { '@type': { type: string }, variable: { type: string }, property: { type: [string, 'null'] }, required: { type: boolean } } } } } }
- required:
- - member
- '403':
- description: Forbidden
- content:
- application/ld+json:
- schema:
- $ref: '#/components/schemas/Error.jsonld'
- application/problem+json:
- schema:
- $ref: '#/components/schemas/Error'
- application/json:
- schema:
- $ref: '#/components/schemas/Error'
- links: { }
- summary: 'Retrieves the collection of Trip resources.'
- description: 'Retrieves the collection of Trip resources.'
- parameters:
- -
- name: page
- in: query
- description: 'The collection page number'
- required: false
- deprecated: false
- allowEmptyValue: true
- schema:
- type: integer
- default: 1
- style: form
- explode: false
- allowReserved: false
- -
- name: itemsPerPage
- in: query
- description: 'The number of items per page'
- required: false
- deprecated: false
- allowEmptyValue: true
- schema:
- type: integer
- default: 50
- minimum: 0
- maximum: 200
- style: form
- explode: false
- allowReserved: false
- -
- name: id
- in: query
- description: ''
- required: false
- deprecated: false
- allowEmptyValue: false
- schema:
- type: integer
- style: form
- explode: false
- allowReserved: false
- -
- name: custom_json_filter
- in: query
- description: ''
- required: false
- deprecated: false
- allowEmptyValue: false
- schema:
- type: string
- style: form
- explode: false
- allowReserved: false
- -
- name: custom_json_order
- in: query
- description: ''
- required: false
- deprecated: false
- allowEmptyValue: true
- schema:
- type: string
- style: form
- explode: false
- allowReserved: false
- deprecated: false
- post:
- operationId: api_trips_post
- tags:
- - Trip
- responses:
- '201':
- description: 'Trip resource created'
- content:
- application/ld+json:
- schema:
- $ref: '#/components/schemas/Trip.jsonld'
- links: { }
- '400':
- description: 'Invalid input'
- content:
- application/ld+json:
- schema:
- $ref: '#/components/schemas/Error.jsonld'
- application/problem+json:
- schema:
- $ref: '#/components/schemas/Error'
- application/json:
- schema:
- $ref: '#/components/schemas/Error'
- links: { }
- '422':
- description: 'An error occurred'
- content:
- application/ld+json:
- schema:
- $ref: '#/components/schemas/ConstraintViolation.jsonld-jsonld'
- application/problem+json:
- schema:
- $ref: '#/components/schemas/ConstraintViolation-json'
- application/json:
- schema:
- $ref: '#/components/schemas/ConstraintViolation-json'
- links: { }
- '403':
- description: Forbidden
- content:
- application/ld+json:
- schema:
- $ref: '#/components/schemas/Error.jsonld'
- application/problem+json:
- schema:
- $ref: '#/components/schemas/Error'
- application/json:
- schema:
- $ref: '#/components/schemas/Error'
- links: { }
- summary: 'Creates a Trip resource.'
- description: 'Creates a Trip resource.'
- parameters: []
- requestBody:
- description: 'The new Trip resource'
- content:
- application/ld+json:
- schema:
- $ref: '#/components/schemas/Trip.jsonld'
- required: true
- deprecated: false
- '/api/trips/{id}':
- get:
- operationId: api_trips_id_get
- tags:
- - Trip
- responses:
- '200':
- description: 'Trip resource'
- content:
- application/ld+json:
- schema:
- $ref: '#/components/schemas/Trip.jsonld'
- '403':
- description: Forbidden
- content:
- application/ld+json:
- schema:
- $ref: '#/components/schemas/Error.jsonld'
- application/problem+json:
- schema:
- $ref: '#/components/schemas/Error'
- application/json:
- schema:
- $ref: '#/components/schemas/Error'
- links: { }
- '404':
- description: 'Not found'
- content:
- application/ld+json:
- schema:
- $ref: '#/components/schemas/Error.jsonld'
- application/problem+json:
- schema:
- $ref: '#/components/schemas/Error'
- application/json:
- schema:
- $ref: '#/components/schemas/Error'
- links: { }
- summary: 'Retrieves a Trip resource.'
- description: 'Retrieves a Trip resource.'
- parameters:
- -
- name: id
- in: path
- description: 'Trip identifier'
- required: true
- deprecated: false
- allowEmptyValue: false
- schema:
- type: string
- style: simple
- explode: false
- allowReserved: false
- deprecated: false
- delete:
- operationId: api_trips_id_delete
- tags:
- - Trip
- responses:
- '204':
- description: 'Trip resource deleted'
- '403':
- description: Forbidden
- content:
- application/ld+json:
- schema:
- $ref: '#/components/schemas/Error.jsonld'
- application/problem+json:
- schema:
- $ref: '#/components/schemas/Error'
- application/json:
- schema:
- $ref: '#/components/schemas/Error'
- links: { }
- '404':
- description: 'Not found'
- content:
- application/ld+json:
- schema:
- $ref: '#/components/schemas/Error.jsonld'
- application/problem+json:
- schema:
- $ref: '#/components/schemas/Error'
- application/json:
- schema:
- $ref: '#/components/schemas/Error'
- links: { }
- summary: 'Removes the Trip resource.'
- description: 'Removes the Trip resource.'
- parameters:
- -
- name: id
- in: path
- description: 'Trip identifier'
- required: true
- deprecated: false
- allowEmptyValue: false
- schema:
- type: string
- style: simple
- explode: false
- allowReserved: false
- deprecated: false
- patch:
- operationId: api_trips_id_patch
- tags:
- - Trip
- responses:
- '200':
- description: 'Trip resource updated'
- content:
- application/ld+json:
- schema:
- $ref: '#/components/schemas/Trip.jsonld'
- links: { }
- '400':
- description: 'Invalid input'
- content:
- application/ld+json:
- schema:
- $ref: '#/components/schemas/Error.jsonld'
- application/problem+json:
- schema:
- $ref: '#/components/schemas/Error'
- application/json:
- schema:
- $ref: '#/components/schemas/Error'
- links: { }
- '422':
- description: 'An error occurred'
- content:
- application/ld+json:
- schema:
- $ref: '#/components/schemas/ConstraintViolation.jsonld-jsonld'
- application/problem+json:
- schema:
- $ref: '#/components/schemas/ConstraintViolation-json'
- application/json:
- schema:
- $ref: '#/components/schemas/ConstraintViolation-json'
- links: { }
- '403':
- description: Forbidden
- content:
- application/ld+json:
- schema:
- $ref: '#/components/schemas/Error.jsonld'
- application/problem+json:
- schema:
- $ref: '#/components/schemas/Error'
- application/json:
- schema:
- $ref: '#/components/schemas/Error'
- links: { }
- '404':
- description: 'Not found'
- content:
- application/ld+json:
- schema:
- $ref: '#/components/schemas/Error.jsonld'
- application/problem+json:
- schema:
- $ref: '#/components/schemas/Error'
- application/json:
- schema:
- $ref: '#/components/schemas/Error'
- links: { }
- summary: 'Updates the Trip resource.'
- description: 'Updates the Trip resource.'
- parameters:
- -
- name: id
- in: path
- description: 'Trip identifier'
- required: true
- deprecated: false
- allowEmptyValue: false
- schema:
- type: string
- style: simple
- explode: false
- allowReserved: false
- requestBody:
- description: 'The updated Trip resource'
- content:
- application/merge-patch+json:
- schema:
- $ref: '#/components/schemas/Trip'
- required: true
- deprecated: false
- /api/trip_locations:
- get:
- operationId: api_trip_locations_get_collection
- tags:
- - TripLocation
- responses:
- '200':
- description: 'TripLocation collection'
- content:
- application/ld+json:
- schema:
- type: object
- properties:
- member: { type: array, items: { $ref: '#/components/schemas/TripLocation.jsonld' } }
- totalItems: { type: integer, minimum: 0 }
- view: { type: object, properties: { '@id': { type: string, format: iri-reference }, '@type': { type: string }, first: { type: string, format: iri-reference }, last: { type: string, format: iri-reference }, previous: { type: string, format: iri-reference }, next: { type: string, format: iri-reference } }, example: { '@id': string, type: string, first: string, last: string, previous: string, next: string } }
- search: { type: object, properties: { '@type': { type: string }, template: { type: string }, variableRepresentation: { type: string }, mapping: { type: array, items: { type: object, properties: { '@type': { type: string }, variable: { type: string }, property: { type: [string, 'null'] }, required: { type: boolean } } } } } }
- required:
- - member
- '403':
- description: Forbidden
- content:
- application/ld+json:
- schema:
- $ref: '#/components/schemas/Error.jsonld'
- application/problem+json:
- schema:
- $ref: '#/components/schemas/Error'
- application/json:
- schema:
- $ref: '#/components/schemas/Error'
- links: { }
- summary: 'Retrieves the collection of TripLocation resources.'
- description: 'Retrieves the collection of TripLocation resources.'
- parameters:
- -
- name: page
- in: query
- description: 'The collection page number'
- required: false
- deprecated: false
- allowEmptyValue: true
- schema:
- type: integer
- default: 1
- style: form
- explode: false
- allowReserved: false
- -
- name: itemsPerPage
- in: query
- description: 'The number of items per page'
- required: false
- deprecated: false
- allowEmptyValue: true
- schema:
- type: integer
- default: 50
- minimum: 0
- maximum: 200
- style: form
- explode: false
- allowReserved: false
- -
- name: trip
- in: query
- description: ''
- required: false
- deprecated: false
- allowEmptyValue: false
- schema:
- type: string
- style: form
- explode: false
- allowReserved: false
- -
- name: 'trip[]'
- in: query
- description: ''
- required: false
- deprecated: false
- allowEmptyValue: false
- schema:
- type: array
- items:
- type: string
- style: form
- explode: true
- allowReserved: false
- -
- name: custom_json_filter
- in: query
- description: ''
- required: false
- deprecated: false
- allowEmptyValue: false
- schema:
- type: string
- style: form
- explode: false
- allowReserved: false
- -
- name: custom_json_order
- in: query
- description: ''
- required: false
- deprecated: false
- allowEmptyValue: true
- schema:
- type: string
- style: form
- explode: false
- allowReserved: false
- deprecated: false
- post:
- operationId: api_trip_locations_post
- tags:
- - TripLocation
- responses:
- '201':
- description: 'TripLocation resource created'
- content:
- application/ld+json:
- schema:
- $ref: '#/components/schemas/TripLocation.jsonld'
- links: { }
- '400':
- description: 'Invalid input'
- content:
- application/ld+json:
- schema:
- $ref: '#/components/schemas/Error.jsonld'
- application/problem+json:
- schema:
- $ref: '#/components/schemas/Error'
- application/json:
- schema:
- $ref: '#/components/schemas/Error'
- links: { }
- '422':
- description: 'An error occurred'
- content:
- application/ld+json:
- schema:
- $ref: '#/components/schemas/ConstraintViolation.jsonld-jsonld'
- application/problem+json:
- schema:
- $ref: '#/components/schemas/ConstraintViolation-json'
- application/json:
- schema:
- $ref: '#/components/schemas/ConstraintViolation-json'
- links: { }
- '403':
- description: Forbidden
- content:
- application/ld+json:
- schema:
- $ref: '#/components/schemas/Error.jsonld'
- application/problem+json:
- schema:
- $ref: '#/components/schemas/Error'
- application/json:
- schema:
- $ref: '#/components/schemas/Error'
- links: { }
- summary: 'Creates a TripLocation resource.'
- description: 'Creates a TripLocation resource.'
- parameters: []
- requestBody:
- description: 'The new TripLocation resource'
- content:
- application/ld+json:
- schema:
- $ref: '#/components/schemas/TripLocation.jsonld'
- required: true
- deprecated: false
- '/api/trip_locations/{id}':
- get:
- operationId: api_trip_locations_id_get
- tags:
- - TripLocation
- responses:
- '200':
- description: 'TripLocation resource'
- content:
- application/ld+json:
- schema:
- $ref: '#/components/schemas/TripLocation.jsonld'
- '403':
- description: Forbidden
- content:
- application/ld+json:
- schema:
- $ref: '#/components/schemas/Error.jsonld'
- application/problem+json:
- schema:
- $ref: '#/components/schemas/Error'
- application/json:
- schema:
- $ref: '#/components/schemas/Error'
- links: { }
- '404':
- description: 'Not found'
- content:
- application/ld+json:
- schema:
- $ref: '#/components/schemas/Error.jsonld'
- application/problem+json:
- schema:
- $ref: '#/components/schemas/Error'
- application/json:
- schema:
- $ref: '#/components/schemas/Error'
- links: { }
- summary: 'Retrieves a TripLocation resource.'
- description: 'Retrieves a TripLocation resource.'
- parameters:
- -
- name: id
- in: path
- description: 'TripLocation identifier'
- required: true
- deprecated: false
- allowEmptyValue: false
- schema:
- type: string
- style: simple
- explode: false
- allowReserved: false
- deprecated: false
- delete:
- operationId: api_trip_locations_id_delete
- tags:
- - TripLocation
- responses:
- '204':
- description: 'TripLocation resource deleted'
- '403':
- description: Forbidden
- content:
- application/ld+json:
- schema:
- $ref: '#/components/schemas/Error.jsonld'
- application/problem+json:
- schema:
- $ref: '#/components/schemas/Error'
- application/json:
- schema:
- $ref: '#/components/schemas/Error'
- links: { }
- '404':
- description: 'Not found'
- content:
- application/ld+json:
- schema:
- $ref: '#/components/schemas/Error.jsonld'
- application/problem+json:
- schema:
- $ref: '#/components/schemas/Error'
- application/json:
- schema:
- $ref: '#/components/schemas/Error'
- links: { }
- summary: 'Removes the TripLocation resource.'
- description: 'Removes the TripLocation resource.'
- parameters:
- -
- name: id
- in: path
- description: 'TripLocation identifier'
- required: true
- deprecated: false
- allowEmptyValue: false
- schema:
- type: string
- style: simple
- explode: false
- allowReserved: false
- deprecated: false
- patch:
- operationId: api_trip_locations_id_patch
- tags:
- - TripLocation
- responses:
- '200':
- description: 'TripLocation resource updated'
- content:
- application/ld+json:
- schema:
- $ref: '#/components/schemas/TripLocation.jsonld'
- links: { }
- '400':
- description: 'Invalid input'
- content:
- application/ld+json:
- schema:
- $ref: '#/components/schemas/Error.jsonld'
- application/problem+json:
- schema:
- $ref: '#/components/schemas/Error'
- application/json:
- schema:
- $ref: '#/components/schemas/Error'
- links: { }
- '422':
- description: 'An error occurred'
- content:
- application/ld+json:
- schema:
- $ref: '#/components/schemas/ConstraintViolation.jsonld-jsonld'
- application/problem+json:
- schema:
- $ref: '#/components/schemas/ConstraintViolation-json'
- application/json:
- schema:
- $ref: '#/components/schemas/ConstraintViolation-json'
- links: { }
- '403':
- description: Forbidden
- content:
- application/ld+json:
- schema:
- $ref: '#/components/schemas/Error.jsonld'
- application/problem+json:
- schema:
- $ref: '#/components/schemas/Error'
- application/json:
- schema:
- $ref: '#/components/schemas/Error'
- links: { }
- '404':
- description: 'Not found'
- content:
- application/ld+json:
- schema:
- $ref: '#/components/schemas/Error.jsonld'
- application/problem+json:
- schema:
- $ref: '#/components/schemas/Error'
- application/json:
- schema:
- $ref: '#/components/schemas/Error'
- links: { }
- summary: 'Updates the TripLocation resource.'
- description: 'Updates the TripLocation resource.'
- parameters:
- -
- name: id
- in: path
- description: 'TripLocation identifier'
- required: true
- deprecated: false
- allowEmptyValue: false
- schema:
- type: string
- style: simple
- explode: false
- allowReserved: false
- requestBody:
- description: 'The updated TripLocation resource'
- content:
- application/merge-patch+json:
- schema:
- $ref: '#/components/schemas/TripLocation'
- required: true
- deprecated: false
- /api/users:
- get:
- operationId: api_users_get_collection
- tags:
- - User
- responses:
- '200':
- description: 'User collection'
- content:
- application/ld+json:
- schema:
- type: object
- properties:
- member: { type: array, items: { $ref: '#/components/schemas/User.jsonld' } }
- totalItems: { type: integer, minimum: 0 }
- view: { type: object, properties: { '@id': { type: string, format: iri-reference }, '@type': { type: string }, first: { type: string, format: iri-reference }, last: { type: string, format: iri-reference }, previous: { type: string, format: iri-reference }, next: { type: string, format: iri-reference } }, example: { '@id': string, type: string, first: string, last: string, previous: string, next: string } }
- search: { type: object, properties: { '@type': { type: string }, template: { type: string }, variableRepresentation: { type: string }, mapping: { type: array, items: { type: object, properties: { '@type': { type: string }, variable: { type: string }, property: { type: [string, 'null'] }, required: { type: boolean } } } } } }
- required:
- - member
- '403':
- description: Forbidden
- content:
- application/ld+json:
- schema:
- $ref: '#/components/schemas/Error.jsonld'
- application/problem+json:
- schema:
- $ref: '#/components/schemas/Error'
- application/json:
- schema:
- $ref: '#/components/schemas/Error'
- links: { }
- summary: 'Retrieves the collection of User resources.'
- description: 'Retrieves the collection of User resources.'
- parameters:
- -
- name: page
- in: query
- description: 'The collection page number'
- required: false
- deprecated: false
- allowEmptyValue: true
- schema:
- type: integer
- default: 1
- style: form
- explode: false
- allowReserved: false
- -
- name: itemsPerPage
- in: query
- description: 'The number of items per page'
- required: false
- deprecated: false
- allowEmptyValue: true
- schema:
- type: integer
- default: 50
- minimum: 0
- maximum: 200
- style: form
- explode: false
- allowReserved: false
- -
- name: firstName
- in: query
- description: ''
- required: false
- deprecated: false
- allowEmptyValue: false
- schema:
- type: string
- style: form
- explode: false
- allowReserved: false
- -
- name: lastName
- in: query
- description: ''
- required: false
- deprecated: false
- allowEmptyValue: false
- schema:
- type: string
- style: form
- explode: false
- allowReserved: false
- -
- name: userNameSearch
- in: query
- description: ''
- required: false
- deprecated: false
- allowEmptyValue: true
- schema:
- type: string
- style: form
- explode: false
- allowReserved: false
- -
- name: custom_json_filter
- in: query
- description: ''
- required: false
- deprecated: false
- allowEmptyValue: false
- schema:
- type: string
- style: form
- explode: false
- allowReserved: false
- -
- name: custom_json_order
- in: query
- description: ''
- required: false
- deprecated: false
- allowEmptyValue: true
- schema:
- type: string
- style: form
- explode: false
- allowReserved: false
- deprecated: false
- post:
- operationId: api_users_post
- tags:
- - User
- responses:
- '201':
- description: 'User resource created'
- content:
- application/ld+json:
- schema:
- $ref: '#/components/schemas/User.jsonld'
- links: { }
- '400':
- description: 'Invalid input'
- content:
- application/ld+json:
- schema:
- $ref: '#/components/schemas/Error.jsonld'
- application/problem+json:
- schema:
- $ref: '#/components/schemas/Error'
- application/json:
- schema:
- $ref: '#/components/schemas/Error'
- links: { }
- '422':
- description: 'An error occurred'
- content:
- application/ld+json:
- schema:
- $ref: '#/components/schemas/ConstraintViolation.jsonld-jsonld'
- application/problem+json:
- schema:
- $ref: '#/components/schemas/ConstraintViolation-json'
- application/json:
- schema:
- $ref: '#/components/schemas/ConstraintViolation-json'
- links: { }
- '403':
- description: Forbidden
- content:
- application/ld+json:
- schema:
- $ref: '#/components/schemas/Error.jsonld'
- application/problem+json:
- schema:
- $ref: '#/components/schemas/Error'
- application/json:
- schema:
- $ref: '#/components/schemas/Error'
- links: { }
- summary: 'Creates a User resource.'
- description: 'Creates a User resource.'
- parameters: []
- requestBody:
- description: 'The new User resource'
- content:
- application/ld+json:
- schema:
- $ref: '#/components/schemas/User.jsonld'
- required: true
- deprecated: false
- '/api/users/{id}':
- get:
- operationId: api_users_id_get
- tags:
- - User
- responses:
- '200':
- description: 'User resource'
- content:
- application/ld+json:
- schema:
- $ref: '#/components/schemas/User.jsonld'
- '403':
- description: Forbidden
- content:
- application/ld+json:
- schema:
- $ref: '#/components/schemas/Error.jsonld'
- application/problem+json:
- schema:
- $ref: '#/components/schemas/Error'
- application/json:
- schema:
- $ref: '#/components/schemas/Error'
- links: { }
- '404':
- description: 'Not found'
- content:
- application/ld+json:
- schema:
- $ref: '#/components/schemas/Error.jsonld'
- application/problem+json:
- schema:
- $ref: '#/components/schemas/Error'
- application/json:
- schema:
- $ref: '#/components/schemas/Error'
- links: { }
- summary: 'Retrieves a User resource.'
- description: 'Retrieves a User resource.'
- parameters:
- -
- name: id
- in: path
- description: 'User identifier'
- required: true
- deprecated: false
- allowEmptyValue: false
- schema:
- type: string
- style: simple
- explode: false
- allowReserved: false
- deprecated: false
- delete:
- operationId: api_users_id_delete
- tags:
- - User
- responses:
- '204':
- description: 'User resource deleted'
- '403':
- description: Forbidden
- content:
- application/ld+json:
- schema:
- $ref: '#/components/schemas/Error.jsonld'
- application/problem+json:
- schema:
- $ref: '#/components/schemas/Error'
- application/json:
- schema:
- $ref: '#/components/schemas/Error'
- links: { }
- '404':
- description: 'Not found'
- content:
- application/ld+json:
- schema:
- $ref: '#/components/schemas/Error.jsonld'
- application/problem+json:
- schema:
- $ref: '#/components/schemas/Error'
- application/json:
- schema:
- $ref: '#/components/schemas/Error'
- links: { }
- summary: 'Removes the User resource.'
- description: 'Removes the User resource.'
- parameters:
- -
- name: id
- in: path
- description: 'User identifier'
- required: true
- deprecated: false
- allowEmptyValue: false
- schema:
- type: string
- style: simple
- explode: false
- allowReserved: false
- deprecated: false
- patch:
- operationId: api_users_id_patch
- tags:
- - User
- responses:
- '200':
- description: 'User resource updated'
- content:
- application/ld+json:
- schema:
- $ref: '#/components/schemas/User.jsonld'
- links: { }
- '400':
- description: 'Invalid input'
- content:
- application/ld+json:
- schema:
- $ref: '#/components/schemas/Error.jsonld'
- application/problem+json:
- schema:
- $ref: '#/components/schemas/Error'
- application/json:
- schema:
- $ref: '#/components/schemas/Error'
- links: { }
- '422':
- description: 'An error occurred'
- content:
- application/ld+json:
- schema:
- $ref: '#/components/schemas/ConstraintViolation.jsonld-jsonld'
- application/problem+json:
- schema:
- $ref: '#/components/schemas/ConstraintViolation-json'
- application/json:
- schema:
- $ref: '#/components/schemas/ConstraintViolation-json'
- links: { }
- '403':
- description: Forbidden
- content:
- application/ld+json:
- schema:
- $ref: '#/components/schemas/Error.jsonld'
- application/problem+json:
- schema:
- $ref: '#/components/schemas/Error'
- application/json:
- schema:
- $ref: '#/components/schemas/Error'
- links: { }
- '404':
- description: 'Not found'
- content:
- application/ld+json:
- schema:
- $ref: '#/components/schemas/Error.jsonld'
- application/problem+json:
- schema:
- $ref: '#/components/schemas/Error'
- application/json:
- schema:
- $ref: '#/components/schemas/Error'
- links: { }
- summary: 'Updates the User resource.'
- description: 'Updates the User resource.'
- parameters:
- -
- name: id
- in: path
- description: 'User identifier'
- required: true
- deprecated: false
- allowEmptyValue: false
- schema:
- type: string
- style: simple
- explode: false
- allowReserved: false
- requestBody:
- description: 'The updated User resource'
- content:
- application/merge-patch+json:
- schema:
- $ref: '#/components/schemas/User'
- required: true
- deprecated: false
- /api/user_trips:
- get:
- operationId: api_user_trips_get_collection
- tags:
- - UserTrip
- responses:
- '200':
- description: 'UserTrip collection'
- content:
- application/ld+json:
- schema:
- type: object
- properties:
- member: { type: array, items: { $ref: '#/components/schemas/UserTrip.jsonld' } }
- totalItems: { type: integer, minimum: 0 }
- view: { type: object, properties: { '@id': { type: string, format: iri-reference }, '@type': { type: string }, first: { type: string, format: iri-reference }, last: { type: string, format: iri-reference }, previous: { type: string, format: iri-reference }, next: { type: string, format: iri-reference } }, example: { '@id': string, type: string, first: string, last: string, previous: string, next: string } }
- search: { type: object, properties: { '@type': { type: string }, template: { type: string }, variableRepresentation: { type: string }, mapping: { type: array, items: { type: object, properties: { '@type': { type: string }, variable: { type: string }, property: { type: [string, 'null'] }, required: { type: boolean } } } } } }
- required:
- - member
- '403':
- description: Forbidden
- content:
- application/ld+json:
- schema:
- $ref: '#/components/schemas/Error.jsonld'
- application/problem+json:
- schema:
- $ref: '#/components/schemas/Error'
- application/json:
- schema:
- $ref: '#/components/schemas/Error'
- links: { }
- summary: 'Retrieves the collection of UserTrip resources.'
- description: 'Retrieves the collection of UserTrip resources.'
- parameters:
- -
- name: page
- in: query
- description: 'The collection page number'
- required: false
- deprecated: false
- allowEmptyValue: true
- schema:
- type: integer
- default: 1
- style: form
- explode: false
- allowReserved: false
- -
- name: itemsPerPage
- in: query
- description: 'The number of items per page'
- required: false
- deprecated: false
- allowEmptyValue: true
- schema:
- type: integer
- default: 50
- minimum: 0
- maximum: 200
- style: form
- explode: false
- allowReserved: false
- -
- name: trip
- in: query
- description: ''
- required: false
- deprecated: false
- allowEmptyValue: false
- schema:
- type: string
- style: form
- explode: false
- allowReserved: false
- -
- name: 'trip[]'
- in: query
- description: ''
- required: false
- deprecated: false
- allowEmptyValue: false
- schema:
- type: array
- items:
- type: string
- style: form
- explode: true
- allowReserved: false
- -
- name: user
- in: query
- description: ''
- required: false
- deprecated: false
- allowEmptyValue: false
- schema:
- type: string
- style: form
- explode: false
- allowReserved: false
- -
- name: 'user[]'
- in: query
- description: ''
- required: false
- deprecated: false
- allowEmptyValue: false
- schema:
- type: array
- items:
- type: string
- style: form
- explode: true
- allowReserved: false
- -
- name: custom_json_filter
- in: query
- description: ''
- required: false
- deprecated: false
- allowEmptyValue: false
- schema:
- type: string
- style: form
- explode: false
- allowReserved: false
- -
- name: custom_json_order
- in: query
- description: ''
- required: false
- deprecated: false
- allowEmptyValue: true
- schema:
- type: string
- style: form
- explode: false
- allowReserved: false
- deprecated: false
- post:
- operationId: api_user_trips_post
- tags:
- - UserTrip
- responses:
- '201':
- description: 'UserTrip resource created'
- content:
- application/ld+json:
- schema:
- $ref: '#/components/schemas/UserTrip.jsonld'
- links: { }
- '400':
- description: 'Invalid input'
- content:
- application/ld+json:
- schema:
- $ref: '#/components/schemas/Error.jsonld'
- application/problem+json:
- schema:
- $ref: '#/components/schemas/Error'
- application/json:
- schema:
- $ref: '#/components/schemas/Error'
- links: { }
- '422':
- description: 'An error occurred'
- content:
- application/ld+json:
- schema:
- $ref: '#/components/schemas/ConstraintViolation.jsonld-jsonld'
- application/problem+json:
- schema:
- $ref: '#/components/schemas/ConstraintViolation-json'
- application/json:
- schema:
- $ref: '#/components/schemas/ConstraintViolation-json'
- links: { }
- '403':
- description: Forbidden
- content:
- application/ld+json:
- schema:
- $ref: '#/components/schemas/Error.jsonld'
- application/problem+json:
- schema:
- $ref: '#/components/schemas/Error'
- application/json:
- schema:
- $ref: '#/components/schemas/Error'
- links: { }
- summary: 'Creates a UserTrip resource.'
- description: 'Creates a UserTrip resource.'
- parameters: []
- requestBody:
- description: 'The new UserTrip resource'
- content:
- application/ld+json:
- schema:
- $ref: '#/components/schemas/UserTrip.jsonld'
- required: true
- deprecated: false
- '/api/user_trips/{id}':
- get:
- operationId: api_user_trips_id_get
- tags:
- - UserTrip
- responses:
- '200':
- description: 'UserTrip resource'
- content:
- application/ld+json:
- schema:
- $ref: '#/components/schemas/UserTrip.jsonld'
- '403':
- description: Forbidden
- content:
- application/ld+json:
- schema:
- $ref: '#/components/schemas/Error.jsonld'
- application/problem+json:
- schema:
- $ref: '#/components/schemas/Error'
- application/json:
- schema:
- $ref: '#/components/schemas/Error'
- links: { }
- '404':
- description: 'Not found'
- content:
- application/ld+json:
- schema:
- $ref: '#/components/schemas/Error.jsonld'
- application/problem+json:
- schema:
- $ref: '#/components/schemas/Error'
- application/json:
- schema:
- $ref: '#/components/schemas/Error'
- links: { }
- summary: 'Retrieves a UserTrip resource.'
- description: 'Retrieves a UserTrip resource.'
- parameters:
- -
- name: id
- in: path
- description: 'UserTrip identifier'
- required: true
- deprecated: false
- allowEmptyValue: false
- schema:
- type: string
- style: simple
- explode: false
- allowReserved: false
- deprecated: false
- delete:
- operationId: api_user_trips_id_delete
- tags:
- - UserTrip
- responses:
- '204':
- description: 'UserTrip resource deleted'
- '403':
- description: Forbidden
- content:
- application/ld+json:
- schema:
- $ref: '#/components/schemas/Error.jsonld'
- application/problem+json:
- schema:
- $ref: '#/components/schemas/Error'
- application/json:
- schema:
- $ref: '#/components/schemas/Error'
- links: { }
- '404':
- description: 'Not found'
- content:
- application/ld+json:
- schema:
- $ref: '#/components/schemas/Error.jsonld'
- application/problem+json:
- schema:
- $ref: '#/components/schemas/Error'
- application/json:
- schema:
- $ref: '#/components/schemas/Error'
- links: { }
- summary: 'Removes the UserTrip resource.'
- description: 'Removes the UserTrip resource.'
- parameters:
- -
- name: id
- in: path
- description: 'UserTrip identifier'
- required: true
- deprecated: false
- allowEmptyValue: false
- schema:
- type: string
- style: simple
- explode: false
- allowReserved: false
- deprecated: false
- patch:
- operationId: api_user_trips_id_patch
- tags:
- - UserTrip
- responses:
- '200':
- description: 'UserTrip resource updated'
- content:
- application/ld+json:
- schema:
- $ref: '#/components/schemas/UserTrip.jsonld'
- links: { }
- '400':
- description: 'Invalid input'
- content:
- application/ld+json:
- schema:
- $ref: '#/components/schemas/Error.jsonld'
- application/problem+json:
- schema:
- $ref: '#/components/schemas/Error'
- application/json:
- schema:
- $ref: '#/components/schemas/Error'
- links: { }
- '422':
- description: 'An error occurred'
- content:
- application/ld+json:
- schema:
- $ref: '#/components/schemas/ConstraintViolation.jsonld-jsonld'
- application/problem+json:
- schema:
- $ref: '#/components/schemas/ConstraintViolation-json'
- application/json:
- schema:
- $ref: '#/components/schemas/ConstraintViolation-json'
- links: { }
- '403':
- description: Forbidden
- content:
- application/ld+json:
- schema:
- $ref: '#/components/schemas/Error.jsonld'
- application/problem+json:
- schema:
- $ref: '#/components/schemas/Error'
- application/json:
- schema:
- $ref: '#/components/schemas/Error'
- links: { }
- '404':
- description: 'Not found'
- content:
- application/ld+json:
- schema:
- $ref: '#/components/schemas/Error.jsonld'
- application/problem+json:
- schema:
- $ref: '#/components/schemas/Error'
- application/json:
- schema:
- $ref: '#/components/schemas/Error'
- links: { }
- summary: 'Updates the UserTrip resource.'
- description: 'Updates the UserTrip resource.'
- parameters:
- -
- name: id
- in: path
- description: 'UserTrip identifier'
- required: true
- deprecated: false
- allowEmptyValue: false
- schema:
- type: string
- style: simple
- explode: false
- allowReserved: false
- requestBody:
- description: 'The updated UserTrip resource'
- content:
- application/merge-patch+json:
- schema:
- $ref: '#/components/schemas/UserTrip'
- required: true
- deprecated: false
- /api/user_trip_events:
- get:
- operationId: api_user_trip_events_get_collection
- tags:
- - UserTripEvent
- responses:
- '200':
- description: 'UserTripEvent collection'
- content:
- application/ld+json:
- schema:
- type: object
- properties:
- member: { type: array, items: { $ref: '#/components/schemas/UserTripEvent.jsonld' } }
- totalItems: { type: integer, minimum: 0 }
- view: { type: object, properties: { '@id': { type: string, format: iri-reference }, '@type': { type: string }, first: { type: string, format: iri-reference }, last: { type: string, format: iri-reference }, previous: { type: string, format: iri-reference }, next: { type: string, format: iri-reference } }, example: { '@id': string, type: string, first: string, last: string, previous: string, next: string } }
- search: { type: object, properties: { '@type': { type: string }, template: { type: string }, variableRepresentation: { type: string }, mapping: { type: array, items: { type: object, properties: { '@type': { type: string }, variable: { type: string }, property: { type: [string, 'null'] }, required: { type: boolean } } } } } }
- required:
- - member
- '403':
- description: Forbidden
- content:
- application/ld+json:
- schema:
- $ref: '#/components/schemas/Error.jsonld'
- application/problem+json:
- schema:
- $ref: '#/components/schemas/Error'
- application/json:
- schema:
- $ref: '#/components/schemas/Error'
- links: { }
- summary: 'Retrieves the collection of UserTripEvent resources.'
- description: 'Retrieves the collection of UserTripEvent resources.'
- parameters:
- -
- name: page
- in: query
- description: 'The collection page number'
- required: false
- deprecated: false
- allowEmptyValue: true
- schema:
- type: integer
- default: 1
- style: form
- explode: false
- allowReserved: false
- -
- name: itemsPerPage
- in: query
- description: 'The number of items per page'
- required: false
- deprecated: false
- allowEmptyValue: true
- schema:
- type: integer
- default: 50
- minimum: 0
- maximum: 200
- style: form
- explode: false
- allowReserved: false
- -
- name: userTrip
- in: query
- description: ''
- required: false
- deprecated: false
- allowEmptyValue: false
- schema:
- type: string
- style: form
- explode: false
- allowReserved: false
- -
- name: 'userTrip[]'
- in: query
- description: ''
- required: false
- deprecated: false
- allowEmptyValue: false
- schema:
- type: array
- items:
- type: string
- style: form
- explode: true
- allowReserved: false
- -
- name: tripId
- in: query
- description: 'Filter UserTripEvents by Trip ID'
- required: false
- deprecated: false
- allowEmptyValue: false
- schema:
- type: integer
- style: form
- explode: false
- allowReserved: false
- -
- name: custom_json_filter
- in: query
- description: ''
- required: false
- deprecated: false
- allowEmptyValue: false
- schema:
- type: string
- style: form
- explode: false
- allowReserved: false
- -
- name: custom_json_order
- in: query
- description: ''
- required: false
- deprecated: false
- allowEmptyValue: true
- schema:
- type: string
- style: form
- explode: false
- allowReserved: false
- deprecated: false
- post:
- operationId: api_user_trip_events_post
- tags:
- - UserTripEvent
- responses:
- '201':
- description: 'UserTripEvent resource created'
- content:
- application/ld+json:
- schema:
- $ref: '#/components/schemas/UserTripEvent.jsonld'
- links: { }
- '400':
- description: 'Invalid input'
- content:
- application/ld+json:
- schema:
- $ref: '#/components/schemas/Error.jsonld'
- application/problem+json:
- schema:
- $ref: '#/components/schemas/Error'
- application/json:
- schema:
- $ref: '#/components/schemas/Error'
- links: { }
- '422':
- description: 'An error occurred'
- content:
- application/ld+json:
- schema:
- $ref: '#/components/schemas/ConstraintViolation.jsonld-jsonld'
- application/problem+json:
- schema:
- $ref: '#/components/schemas/ConstraintViolation-json'
- application/json:
- schema:
- $ref: '#/components/schemas/ConstraintViolation-json'
- links: { }
- '403':
- description: Forbidden
- content:
- application/ld+json:
- schema:
- $ref: '#/components/schemas/Error.jsonld'
- application/problem+json:
- schema:
- $ref: '#/components/schemas/Error'
- application/json:
- schema:
- $ref: '#/components/schemas/Error'
- links: { }
- summary: 'Creates a UserTripEvent resource.'
- description: 'Creates a UserTripEvent resource.'
- parameters: []
- requestBody:
- description: 'The new UserTripEvent resource'
- content:
- application/ld+json:
- schema:
- $ref: '#/components/schemas/UserTripEvent.jsonld'
- required: true
- deprecated: false
- '/api/user_trip_events/{id}':
- get:
- operationId: api_user_trip_events_id_get
- tags:
- - UserTripEvent
- responses:
- '200':
- description: 'UserTripEvent resource'
- content:
- application/ld+json:
- schema:
- $ref: '#/components/schemas/UserTripEvent.jsonld'
- '403':
- description: Forbidden
- content:
- application/ld+json:
- schema:
- $ref: '#/components/schemas/Error.jsonld'
- application/problem+json:
- schema:
- $ref: '#/components/schemas/Error'
- application/json:
- schema:
- $ref: '#/components/schemas/Error'
- links: { }
- '404':
- description: 'Not found'
- content:
- application/ld+json:
- schema:
- $ref: '#/components/schemas/Error.jsonld'
- application/problem+json:
- schema:
- $ref: '#/components/schemas/Error'
- application/json:
- schema:
- $ref: '#/components/schemas/Error'
- links: { }
- summary: 'Retrieves a UserTripEvent resource.'
- description: 'Retrieves a UserTripEvent resource.'
- parameters:
- -
- name: id
- in: path
- description: 'UserTripEvent identifier'
- required: true
- deprecated: false
- allowEmptyValue: false
- schema:
- type: string
- style: simple
- explode: false
- allowReserved: false
- deprecated: false
- delete:
- operationId: api_user_trip_events_id_delete
- tags:
- - UserTripEvent
- responses:
- '204':
- description: 'UserTripEvent resource deleted'
- '403':
- description: Forbidden
- content:
- application/ld+json:
- schema:
- $ref: '#/components/schemas/Error.jsonld'
- application/problem+json:
- schema:
- $ref: '#/components/schemas/Error'
- application/json:
- schema:
- $ref: '#/components/schemas/Error'
- links: { }
- '404':
- description: 'Not found'
- content:
- application/ld+json:
- schema:
- $ref: '#/components/schemas/Error.jsonld'
- application/problem+json:
- schema:
- $ref: '#/components/schemas/Error'
- application/json:
- schema:
- $ref: '#/components/schemas/Error'
- links: { }
- summary: 'Removes the UserTripEvent resource.'
- description: 'Removes the UserTripEvent resource.'
- parameters:
- -
- name: id
- in: path
- description: 'UserTripEvent identifier'
- required: true
- deprecated: false
- allowEmptyValue: false
- schema:
- type: string
- style: simple
- explode: false
- allowReserved: false
- deprecated: false
- patch:
- operationId: api_user_trip_events_id_patch
- tags:
- - UserTripEvent
- responses:
- '200':
- description: 'UserTripEvent resource updated'
- content:
- application/ld+json:
- schema:
- $ref: '#/components/schemas/UserTripEvent.jsonld'
- links: { }
- '400':
- description: 'Invalid input'
- content:
- application/ld+json:
- schema:
- $ref: '#/components/schemas/Error.jsonld'
- application/problem+json:
- schema:
- $ref: '#/components/schemas/Error'
- application/json:
- schema:
- $ref: '#/components/schemas/Error'
- links: { }
- '422':
- description: 'An error occurred'
- content:
- application/ld+json:
- schema:
- $ref: '#/components/schemas/ConstraintViolation.jsonld-jsonld'
- application/problem+json:
- schema:
- $ref: '#/components/schemas/ConstraintViolation-json'
- application/json:
- schema:
- $ref: '#/components/schemas/ConstraintViolation-json'
- links: { }
- '403':
- description: Forbidden
- content:
- application/ld+json:
- schema:
- $ref: '#/components/schemas/Error.jsonld'
- application/problem+json:
- schema:
- $ref: '#/components/schemas/Error'
- application/json:
- schema:
- $ref: '#/components/schemas/Error'
- links: { }
- '404':
- description: 'Not found'
- content:
- application/ld+json:
- schema:
- $ref: '#/components/schemas/Error.jsonld'
- application/problem+json:
- schema:
- $ref: '#/components/schemas/Error'
- application/json:
- schema:
- $ref: '#/components/schemas/Error'
- links: { }
- summary: 'Updates the UserTripEvent resource.'
- description: 'Updates the UserTripEvent resource.'
- parameters:
- -
- name: id
- in: path
- description: 'UserTripEvent identifier'
- required: true
- deprecated: false
- allowEmptyValue: false
- schema:
- type: string
- style: simple
- explode: false
- allowReserved: false
- requestBody:
- description: 'The updated UserTripEvent resource'
- content:
- application/merge-patch+json:
- schema:
- $ref: '#/components/schemas/UserTripEvent'
- required: true
- deprecated: false
- /api/user_zones:
- get:
- operationId: api_user_zones_get_collection
- tags:
- - UserZone
- responses:
- '200':
- description: 'UserZone collection'
- content:
- application/ld+json:
- schema:
- type: object
- properties:
- member: { type: array, items: { $ref: '#/components/schemas/UserZone.jsonld' } }
- totalItems: { type: integer, minimum: 0 }
- view: { type: object, properties: { '@id': { type: string, format: iri-reference }, '@type': { type: string }, first: { type: string, format: iri-reference }, last: { type: string, format: iri-reference }, previous: { type: string, format: iri-reference }, next: { type: string, format: iri-reference } }, example: { '@id': string, type: string, first: string, last: string, previous: string, next: string } }
- search: { type: object, properties: { '@type': { type: string }, template: { type: string }, variableRepresentation: { type: string }, mapping: { type: array, items: { type: object, properties: { '@type': { type: string }, variable: { type: string }, property: { type: [string, 'null'] }, required: { type: boolean } } } } } }
- required:
- - member
- '403':
- description: Forbidden
- content:
- application/ld+json:
- schema:
- $ref: '#/components/schemas/Error.jsonld'
- application/problem+json:
- schema:
- $ref: '#/components/schemas/Error'
- application/json:
- schema:
- $ref: '#/components/schemas/Error'
- links: { }
- summary: 'Retrieves the collection of UserZone resources.'
- description: 'Retrieves the collection of UserZone resources.'
- parameters:
- -
- name: page
- in: query
- description: 'The collection page number'
- required: false
- deprecated: false
- allowEmptyValue: true
- schema:
- type: integer
- default: 1
- style: form
- explode: false
- allowReserved: false
- -
- name: itemsPerPage
- in: query
- description: 'The number of items per page'
- required: false
- deprecated: false
- allowEmptyValue: true
- schema:
- type: integer
- default: 50
- minimum: 0
- maximum: 200
- style: form
- explode: false
- allowReserved: false
- -
- name: user
- in: query
- description: ''
- required: false
- deprecated: false
- allowEmptyValue: false
- schema:
- type: string
- style: form
- explode: false
- allowReserved: false
- -
- name: 'user[]'
- in: query
- description: ''
- required: false
- deprecated: false
- allowEmptyValue: false
- schema:
- type: array
- items:
- type: string
- style: form
- explode: true
- allowReserved: false
- -
- name: zone
- in: query
- description: ''
- required: false
- deprecated: false
- allowEmptyValue: false
- schema:
- type: string
- style: form
- explode: false
- allowReserved: false
- -
- name: 'zone[]'
- in: query
- description: ''
- required: false
- deprecated: false
- allowEmptyValue: false
- schema:
- type: array
- items:
- type: string
- style: form
- explode: true
- allowReserved: false
- -
- name: custom_json_filter
- in: query
- description: ''
- required: false
- deprecated: false
- allowEmptyValue: false
- schema:
- type: string
- style: form
- explode: false
- allowReserved: false
- -
- name: custom_json_order
- in: query
- description: ''
- required: false
- deprecated: false
- allowEmptyValue: true
- schema:
- type: string
- style: form
- explode: false
- allowReserved: false
- deprecated: false
- post:
- operationId: api_user_zones_post
- tags:
- - UserZone
- responses:
- '201':
- description: 'UserZone resource created'
- content:
- application/ld+json:
- schema:
- $ref: '#/components/schemas/UserZone.jsonld'
- links: { }
- '400':
- description: 'Invalid input'
- content:
- application/ld+json:
- schema:
- $ref: '#/components/schemas/Error.jsonld'
- application/problem+json:
- schema:
- $ref: '#/components/schemas/Error'
- application/json:
- schema:
- $ref: '#/components/schemas/Error'
- links: { }
- '422':
- description: 'An error occurred'
- content:
- application/ld+json:
- schema:
- $ref: '#/components/schemas/ConstraintViolation.jsonld-jsonld'
- application/problem+json:
- schema:
- $ref: '#/components/schemas/ConstraintViolation-json'
- application/json:
- schema:
- $ref: '#/components/schemas/ConstraintViolation-json'
- links: { }
- '403':
- description: Forbidden
- content:
- application/ld+json:
- schema:
- $ref: '#/components/schemas/Error.jsonld'
- application/problem+json:
- schema:
- $ref: '#/components/schemas/Error'
- application/json:
- schema:
- $ref: '#/components/schemas/Error'
- links: { }
- summary: 'Creates a UserZone resource.'
- description: 'Creates a UserZone resource.'
- parameters: []
- requestBody:
- description: 'The new UserZone resource'
- content:
- application/ld+json:
- schema:
- $ref: '#/components/schemas/UserZone.jsonld'
- required: true
- deprecated: false
- '/api/user_zones/{id}':
- get:
- operationId: api_user_zones_id_get
- tags:
- - UserZone
- responses:
- '200':
- description: 'UserZone resource'
- content:
- application/ld+json:
- schema:
- $ref: '#/components/schemas/UserZone.jsonld'
- '403':
- description: Forbidden
- content:
- application/ld+json:
- schema:
- $ref: '#/components/schemas/Error.jsonld'
- application/problem+json:
- schema:
- $ref: '#/components/schemas/Error'
- application/json:
- schema:
- $ref: '#/components/schemas/Error'
- links: { }
- '404':
- description: 'Not found'
- content:
- application/ld+json:
- schema:
- $ref: '#/components/schemas/Error.jsonld'
- application/problem+json:
- schema:
- $ref: '#/components/schemas/Error'
- application/json:
- schema:
- $ref: '#/components/schemas/Error'
- links: { }
- summary: 'Retrieves a UserZone resource.'
- description: 'Retrieves a UserZone resource.'
- parameters:
- -
- name: id
- in: path
- description: 'UserZone identifier'
- required: true
- deprecated: false
- allowEmptyValue: false
- schema:
- type: string
- style: simple
- explode: false
- allowReserved: false
- deprecated: false
- delete:
- operationId: api_user_zones_id_delete
- tags:
- - UserZone
- responses:
- '204':
- description: 'UserZone resource deleted'
- '403':
- description: Forbidden
- content:
- application/ld+json:
- schema:
- $ref: '#/components/schemas/Error.jsonld'
- application/problem+json:
- schema:
- $ref: '#/components/schemas/Error'
- application/json:
- schema:
- $ref: '#/components/schemas/Error'
- links: { }
- '404':
- description: 'Not found'
- content:
- application/ld+json:
- schema:
- $ref: '#/components/schemas/Error.jsonld'
- application/problem+json:
- schema:
- $ref: '#/components/schemas/Error'
- application/json:
- schema:
- $ref: '#/components/schemas/Error'
- links: { }
- summary: 'Removes the UserZone resource.'
- description: 'Removes the UserZone resource.'
- parameters:
- -
- name: id
- in: path
- description: 'UserZone identifier'
- required: true
- deprecated: false
- allowEmptyValue: false
- schema:
- type: string
- style: simple
- explode: false
- allowReserved: false
- deprecated: false
- patch:
- operationId: api_user_zones_id_patch
- tags:
- - UserZone
- responses:
- '200':
- description: 'UserZone resource updated'
- content:
- application/ld+json:
- schema:
- $ref: '#/components/schemas/UserZone.jsonld'
- links: { }
- '400':
- description: 'Invalid input'
- content:
- application/ld+json:
- schema:
- $ref: '#/components/schemas/Error.jsonld'
- application/problem+json:
- schema:
- $ref: '#/components/schemas/Error'
- application/json:
- schema:
- $ref: '#/components/schemas/Error'
- links: { }
- '422':
- description: 'An error occurred'
- content:
- application/ld+json:
- schema:
- $ref: '#/components/schemas/ConstraintViolation.jsonld-jsonld'
- application/problem+json:
- schema:
- $ref: '#/components/schemas/ConstraintViolation-json'
- application/json:
- schema:
- $ref: '#/components/schemas/ConstraintViolation-json'
- links: { }
- '403':
- description: Forbidden
- content:
- application/ld+json:
- schema:
- $ref: '#/components/schemas/Error.jsonld'
- application/problem+json:
- schema:
- $ref: '#/components/schemas/Error'
- application/json:
- schema:
- $ref: '#/components/schemas/Error'
- links: { }
- '404':
- description: 'Not found'
- content:
- application/ld+json:
- schema:
- $ref: '#/components/schemas/Error.jsonld'
- application/problem+json:
- schema:
- $ref: '#/components/schemas/Error'
- application/json:
- schema:
- $ref: '#/components/schemas/Error'
- links: { }
- summary: 'Updates the UserZone resource.'
- description: 'Updates the UserZone resource.'
- parameters:
- -
- name: id
- in: path
- description: 'UserZone identifier'
- required: true
- deprecated: false
- allowEmptyValue: false
- schema:
- type: string
- style: simple
- explode: false
- allowReserved: false
- requestBody:
- description: 'The updated UserZone resource'
- content:
- application/merge-patch+json:
- schema:
- $ref: '#/components/schemas/UserZone'
- required: true
- deprecated: false
- /api/vessels:
- get:
- operationId: api_vessels_get_collection
- tags:
- - Vessel
- responses:
- '200':
- description: 'Vessel collection'
- content:
- application/ld+json:
- schema:
- type: object
- properties:
- member: { type: array, items: { $ref: '#/components/schemas/Vessel.jsonld' } }
- totalItems: { type: integer, minimum: 0 }
- view: { type: object, properties: { '@id': { type: string, format: iri-reference }, '@type': { type: string }, first: { type: string, format: iri-reference }, last: { type: string, format: iri-reference }, previous: { type: string, format: iri-reference }, next: { type: string, format: iri-reference } }, example: { '@id': string, type: string, first: string, last: string, previous: string, next: string } }
- search: { type: object, properties: { '@type': { type: string }, template: { type: string }, variableRepresentation: { type: string }, mapping: { type: array, items: { type: object, properties: { '@type': { type: string }, variable: { type: string }, property: { type: [string, 'null'] }, required: { type: boolean } } } } } }
- required:
- - member
- '403':
- description: Forbidden
- content:
- application/ld+json:
- schema:
- $ref: '#/components/schemas/Error.jsonld'
- application/problem+json:
- schema:
- $ref: '#/components/schemas/Error'
- application/json:
- schema:
- $ref: '#/components/schemas/Error'
- links: { }
- summary: 'Retrieves the collection of Vessel resources.'
- description: 'Retrieves the collection of Vessel resources.'
- parameters:
- -
- name: page
- in: query
- description: 'The collection page number'
- required: false
- deprecated: false
- allowEmptyValue: true
- schema:
- type: integer
- default: 1
- style: form
- explode: false
- allowReserved: false
- -
- name: itemsPerPage
- in: query
- description: 'The number of items per page'
- required: false
- deprecated: false
- allowEmptyValue: true
- schema:
- type: integer
- default: 50
- minimum: 0
- maximum: 200
- style: form
- explode: false
- allowReserved: false
- -
- name: name
- in: query
- description: ''
- required: false
- deprecated: false
- allowEmptyValue: false
- schema:
- type: string
- style: form
- explode: false
- allowReserved: false
- -
- name: custom_json_filter
- in: query
- description: ''
- required: false
- deprecated: false
- allowEmptyValue: false
- schema:
- type: string
- style: form
- explode: false
- allowReserved: false
- -
- name: custom_json_order
- in: query
- description: ''
- required: false
- deprecated: false
- allowEmptyValue: true
- schema:
- type: string
- style: form
- explode: false
- allowReserved: false
- deprecated: false
- post:
- operationId: api_vessels_post
- tags:
- - Vessel
- responses:
- '201':
- description: 'Vessel resource created'
- content:
- application/ld+json:
- schema:
- $ref: '#/components/schemas/Vessel.jsonld'
- links: { }
- '400':
- description: 'Invalid input'
- content:
- application/ld+json:
- schema:
- $ref: '#/components/schemas/Error.jsonld'
- application/problem+json:
- schema:
- $ref: '#/components/schemas/Error'
- application/json:
- schema:
- $ref: '#/components/schemas/Error'
- links: { }
- '422':
- description: 'An error occurred'
- content:
- application/ld+json:
- schema:
- $ref: '#/components/schemas/ConstraintViolation.jsonld-jsonld'
- application/problem+json:
- schema:
- $ref: '#/components/schemas/ConstraintViolation-json'
- application/json:
- schema:
- $ref: '#/components/schemas/ConstraintViolation-json'
- links: { }
- '403':
- description: Forbidden
- content:
- application/ld+json:
- schema:
- $ref: '#/components/schemas/Error.jsonld'
- application/problem+json:
- schema:
- $ref: '#/components/schemas/Error'
- application/json:
- schema:
- $ref: '#/components/schemas/Error'
- links: { }
- summary: 'Creates a Vessel resource.'
- description: 'Creates a Vessel resource.'
- parameters: []
- requestBody:
- description: 'The new Vessel resource'
- content:
- application/ld+json:
- schema:
- $ref: '#/components/schemas/Vessel.jsonld'
- required: true
- deprecated: false
- '/api/vessels/{id}':
- get:
- operationId: api_vessels_id_get
- tags:
- - Vessel
- responses:
- '200':
- description: 'Vessel resource'
- content:
- application/ld+json:
- schema:
- $ref: '#/components/schemas/Vessel.jsonld'
- '403':
- description: Forbidden
- content:
- application/ld+json:
- schema:
- $ref: '#/components/schemas/Error.jsonld'
- application/problem+json:
- schema:
- $ref: '#/components/schemas/Error'
- application/json:
- schema:
- $ref: '#/components/schemas/Error'
- links: { }
- '404':
- description: 'Not found'
- content:
- application/ld+json:
- schema:
- $ref: '#/components/schemas/Error.jsonld'
- application/problem+json:
- schema:
- $ref: '#/components/schemas/Error'
- application/json:
- schema:
- $ref: '#/components/schemas/Error'
- links: { }
- summary: 'Retrieves a Vessel resource.'
- description: 'Retrieves a Vessel resource.'
- parameters:
- -
- name: id
- in: path
- description: 'Vessel identifier'
- required: true
- deprecated: false
- allowEmptyValue: false
- schema:
- type: string
- style: simple
- explode: false
- allowReserved: false
- deprecated: false
- delete:
- operationId: api_vessels_id_delete
- tags:
- - Vessel
- responses:
- '204':
- description: 'Vessel resource deleted'
- '403':
- description: Forbidden
- content:
- application/ld+json:
- schema:
- $ref: '#/components/schemas/Error.jsonld'
- application/problem+json:
- schema:
- $ref: '#/components/schemas/Error'
- application/json:
- schema:
- $ref: '#/components/schemas/Error'
- links: { }
- '404':
- description: 'Not found'
- content:
- application/ld+json:
- schema:
- $ref: '#/components/schemas/Error.jsonld'
- application/problem+json:
- schema:
- $ref: '#/components/schemas/Error'
- application/json:
- schema:
- $ref: '#/components/schemas/Error'
- links: { }
- summary: 'Removes the Vessel resource.'
- description: 'Removes the Vessel resource.'
- parameters:
- -
- name: id
- in: path
- description: 'Vessel identifier'
- required: true
- deprecated: false
- allowEmptyValue: false
- schema:
- type: string
- style: simple
- explode: false
- allowReserved: false
- deprecated: false
- patch:
- operationId: api_vessels_id_patch
- tags:
- - Vessel
- responses:
- '200':
- description: 'Vessel resource updated'
- content:
- application/ld+json:
- schema:
- $ref: '#/components/schemas/Vessel.jsonld'
- links: { }
- '400':
- description: 'Invalid input'
- content:
- application/ld+json:
- schema:
- $ref: '#/components/schemas/Error.jsonld'
- application/problem+json:
- schema:
- $ref: '#/components/schemas/Error'
- application/json:
- schema:
- $ref: '#/components/schemas/Error'
- links: { }
- '422':
- description: 'An error occurred'
- content:
- application/ld+json:
- schema:
- $ref: '#/components/schemas/ConstraintViolation.jsonld-jsonld'
- application/problem+json:
- schema:
- $ref: '#/components/schemas/ConstraintViolation-json'
- application/json:
- schema:
- $ref: '#/components/schemas/ConstraintViolation-json'
- links: { }
- '403':
- description: Forbidden
- content:
- application/ld+json:
- schema:
- $ref: '#/components/schemas/Error.jsonld'
- application/problem+json:
- schema:
- $ref: '#/components/schemas/Error'
- application/json:
- schema:
- $ref: '#/components/schemas/Error'
- links: { }
- '404':
- description: 'Not found'
- content:
- application/ld+json:
- schema:
- $ref: '#/components/schemas/Error.jsonld'
- application/problem+json:
- schema:
- $ref: '#/components/schemas/Error'
- application/json:
- schema:
- $ref: '#/components/schemas/Error'
- links: { }
- summary: 'Updates the Vessel resource.'
- description: 'Updates the Vessel resource.'
- parameters:
- -
- name: id
- in: path
- description: 'Vessel identifier'
- required: true
- deprecated: false
- allowEmptyValue: false
- schema:
- type: string
- style: simple
- explode: false
- allowReserved: false
- requestBody:
- description: 'The updated Vessel resource'
- content:
- application/merge-patch+json:
- schema:
- $ref: '#/components/schemas/Vessel'
- required: true
- deprecated: false
- /api/zones:
- get:
- operationId: api_zones_get_collection
- tags:
- - Zone
- responses:
- '200':
- description: 'Zone collection'
- content:
- application/ld+json:
- schema:
- type: object
- properties:
- member: { type: array, items: { $ref: '#/components/schemas/Zone.jsonld' } }
- totalItems: { type: integer, minimum: 0 }
- view: { type: object, properties: { '@id': { type: string, format: iri-reference }, '@type': { type: string }, first: { type: string, format: iri-reference }, last: { type: string, format: iri-reference }, previous: { type: string, format: iri-reference }, next: { type: string, format: iri-reference } }, example: { '@id': string, type: string, first: string, last: string, previous: string, next: string } }
- search: { type: object, properties: { '@type': { type: string }, template: { type: string }, variableRepresentation: { type: string }, mapping: { type: array, items: { type: object, properties: { '@type': { type: string }, variable: { type: string }, property: { type: [string, 'null'] }, required: { type: boolean } } } } } }
- required:
- - member
- '403':
- description: Forbidden
- content:
- application/ld+json:
- schema:
- $ref: '#/components/schemas/Error.jsonld'
- application/problem+json:
- schema:
- $ref: '#/components/schemas/Error'
- application/json:
- schema:
- $ref: '#/components/schemas/Error'
- links: { }
- summary: 'Retrieves the collection of Zone resources.'
- description: 'Retrieves the collection of Zone resources.'
- parameters:
- -
- name: page
- in: query
- description: 'The collection page number'
- required: false
- deprecated: false
- allowEmptyValue: true
- schema:
- type: integer
- default: 1
- style: form
- explode: false
- allowReserved: false
- -
- name: itemsPerPage
- in: query
- description: 'The number of items per page'
- required: false
- deprecated: false
- allowEmptyValue: true
- schema:
- type: integer
- default: 50
- minimum: 0
- maximum: 200
- style: form
- explode: false
- allowReserved: false
- -
- name: name
- in: query
- description: ''
- required: false
- deprecated: false
- allowEmptyValue: false
- schema:
- type: string
- style: form
- explode: false
- allowReserved: false
- -
- name: custom_json_filter
- in: query
- description: ''
- required: false
- deprecated: false
- allowEmptyValue: false
- schema:
- type: string
- style: form
- explode: false
- allowReserved: false
- -
- name: custom_json_order
- in: query
- description: ''
- required: false
- deprecated: false
- allowEmptyValue: true
- schema:
- type: string
- style: form
- explode: false
- allowReserved: false
- deprecated: false
- post:
- operationId: api_zones_post
- tags:
- - Zone
- responses:
- '201':
- description: 'Zone resource created'
- content:
- application/ld+json:
- schema:
- $ref: '#/components/schemas/Zone.jsonld'
- links: { }
- '400':
- description: 'Invalid input'
- content:
- application/ld+json:
- schema:
- $ref: '#/components/schemas/Error.jsonld'
- application/problem+json:
- schema:
- $ref: '#/components/schemas/Error'
- application/json:
- schema:
- $ref: '#/components/schemas/Error'
- links: { }
- '422':
- description: 'An error occurred'
- content:
- application/ld+json:
- schema:
- $ref: '#/components/schemas/ConstraintViolation.jsonld-jsonld'
- application/problem+json:
- schema:
- $ref: '#/components/schemas/ConstraintViolation-json'
- application/json:
- schema:
- $ref: '#/components/schemas/ConstraintViolation-json'
- links: { }
- '403':
- description: Forbidden
- content:
- application/ld+json:
- schema:
- $ref: '#/components/schemas/Error.jsonld'
- application/problem+json:
- schema:
- $ref: '#/components/schemas/Error'
- application/json:
- schema:
- $ref: '#/components/schemas/Error'
- links: { }
- summary: 'Creates a Zone resource.'
- description: 'Creates a Zone resource.'
- parameters: []
- requestBody:
- description: 'The new Zone resource'
- content:
- application/ld+json:
- schema:
- $ref: '#/components/schemas/Zone.jsonld'
- required: true
- deprecated: false
- '/api/zones/{id}':
- get:
- operationId: api_zones_id_get
- tags:
- - Zone
- responses:
- '200':
- description: 'Zone resource'
- content:
- application/ld+json:
- schema:
- $ref: '#/components/schemas/Zone.jsonld'
- '403':
- description: Forbidden
- content:
- application/ld+json:
- schema:
- $ref: '#/components/schemas/Error.jsonld'
- application/problem+json:
- schema:
- $ref: '#/components/schemas/Error'
- application/json:
- schema:
- $ref: '#/components/schemas/Error'
- links: { }
- '404':
- description: 'Not found'
- content:
- application/ld+json:
- schema:
- $ref: '#/components/schemas/Error.jsonld'
- application/problem+json:
- schema:
- $ref: '#/components/schemas/Error'
- application/json:
- schema:
- $ref: '#/components/schemas/Error'
- links: { }
- summary: 'Retrieves a Zone resource.'
- description: 'Retrieves a Zone resource.'
- parameters:
- -
- name: id
- in: path
- description: 'Zone identifier'
- required: true
- deprecated: false
- allowEmptyValue: false
- schema:
- type: string
- style: simple
- explode: false
- allowReserved: false
- deprecated: false
- delete:
- operationId: api_zones_id_delete
- tags:
- - Zone
- responses:
- '204':
- description: 'Zone resource deleted'
- '403':
- description: Forbidden
- content:
- application/ld+json:
- schema:
- $ref: '#/components/schemas/Error.jsonld'
- application/problem+json:
- schema:
- $ref: '#/components/schemas/Error'
- application/json:
- schema:
- $ref: '#/components/schemas/Error'
- links: { }
- '404':
- description: 'Not found'
- content:
- application/ld+json:
- schema:
- $ref: '#/components/schemas/Error.jsonld'
- application/problem+json:
- schema:
- $ref: '#/components/schemas/Error'
- application/json:
- schema:
- $ref: '#/components/schemas/Error'
- links: { }
- summary: 'Removes the Zone resource.'
- description: 'Removes the Zone resource.'
- parameters:
- -
- name: id
- in: path
- description: 'Zone identifier'
- required: true
- deprecated: false
- allowEmptyValue: false
- schema:
- type: string
- style: simple
- explode: false
- allowReserved: false
- deprecated: false
- patch:
- operationId: api_zones_id_patch
- tags:
- - Zone
- responses:
- '200':
- description: 'Zone resource updated'
- content:
- application/ld+json:
- schema:
- $ref: '#/components/schemas/Zone.jsonld'
- links: { }
- '400':
- description: 'Invalid input'
- content:
- application/ld+json:
- schema:
- $ref: '#/components/schemas/Error.jsonld'
- application/problem+json:
- schema:
- $ref: '#/components/schemas/Error'
- application/json:
- schema:
- $ref: '#/components/schemas/Error'
- links: { }
- '422':
- description: 'An error occurred'
- content:
- application/ld+json:
- schema:
- $ref: '#/components/schemas/ConstraintViolation.jsonld-jsonld'
- application/problem+json:
- schema:
- $ref: '#/components/schemas/ConstraintViolation-json'
- application/json:
- schema:
- $ref: '#/components/schemas/ConstraintViolation-json'
- links: { }
- '403':
- description: Forbidden
- content:
- application/ld+json:
- schema:
- $ref: '#/components/schemas/Error.jsonld'
- application/problem+json:
- schema:
- $ref: '#/components/schemas/Error'
- application/json:
- schema:
- $ref: '#/components/schemas/Error'
- links: { }
- '404':
- description: 'Not found'
- content:
- application/ld+json:
- schema:
- $ref: '#/components/schemas/Error.jsonld'
- application/problem+json:
- schema:
- $ref: '#/components/schemas/Error'
- application/json:
- schema:
- $ref: '#/components/schemas/Error'
- links: { }
- summary: 'Updates the Zone resource.'
- description: 'Updates the Zone resource.'
- parameters:
- -
- name: id
- in: path
- description: 'Zone identifier'
- required: true
- deprecated: false
- allowEmptyValue: false
- schema:
- type: string
- style: simple
- explode: false
- allowReserved: false
- requestBody:
- description: 'The updated Zone resource'
- content:
- application/merge-patch+json:
- schema:
- $ref: '#/components/schemas/Zone'
- required: true
- deprecated: false
- components:
- schemas:
- ConstraintViolation-json:
- type: object
- description: 'Unprocessable entity'
- deprecated: false
- properties:
- status:
- default: 422
- example: 422
- type: integer
- violations:
- type: array
- items:
- type: object
- properties:
- propertyPath:
- type: string
- description: 'The property path of the violation'
- message:
- type: string
- description: 'The message associated with the violation'
- detail:
- readOnly: true
- type: string
- type:
- readOnly: true
- type: string
- title:
- readOnly: true
- type:
- - string
- - 'null'
- instance:
- readOnly: true
- type:
- - string
- - 'null'
- ConstraintViolation.jsonld-jsonld:
- type: object
- description: 'Unprocessable entity'
- deprecated: false
- properties:
- '@context':
- readOnly: true
- oneOf:
- -
- type: string
- -
- type: object
- properties:
- '@vocab':
- type: string
- hydra:
- type: string
- enum: ['http://www.w3.org/ns/hydra/core#']
- required:
- - '@vocab'
- - hydra
- additionalProperties: true
- '@id':
- readOnly: true
- type: string
- '@type':
- readOnly: true
- type: string
- status:
- default: 422
- example: 422
- type: integer
- violations:
- type: array
- items:
- type: object
- properties:
- propertyPath:
- type: string
- description: 'The property path of the violation'
- message:
- type: string
- description: 'The message associated with the violation'
- detail:
- readOnly: true
- type: string
- description:
- readOnly: true
- type: string
- type:
- readOnly: true
- type: string
- title:
- readOnly: true
- type:
- - string
- - 'null'
- instance:
- readOnly: true
- type:
- - string
- - 'null'
- Error:
- type: object
- description: 'A representation of common errors.'
- deprecated: false
- properties:
- title:
- readOnly: true
- description: 'A short, human-readable summary of the problem.'
- type:
- - string
- - 'null'
- detail:
- readOnly: true
- description: 'A human-readable explanation specific to this occurrence of the problem.'
- type:
- - string
- - 'null'
- status:
- type: number
- example: 404
- default: 400
- instance:
- readOnly: true
- description: 'A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.'
- type:
- - string
- - 'null'
- type:
- readOnly: true
- description: 'A URI reference that identifies the problem type'
- type: string
- Error.jsonld:
- type: object
- description: 'A representation of common errors.'
- deprecated: false
- properties:
- '@context':
- readOnly: true
- oneOf:
- -
- type: string
- -
- type: object
- properties:
- '@vocab':
- type: string
- hydra:
- type: string
- enum: ['http://www.w3.org/ns/hydra/core#']
- required:
- - '@vocab'
- - hydra
- additionalProperties: true
- '@id':
- readOnly: true
- type: string
- '@type':
- readOnly: true
- type: string
- title:
- readOnly: true
- description: 'A short, human-readable summary of the problem.'
- type:
- - string
- - 'null'
- detail:
- readOnly: true
- description: 'A human-readable explanation specific to this occurrence of the problem.'
- type:
- - string
- - 'null'
- status:
- type: number
- example: 404
- default: 400
- instance:
- readOnly: true
- description: 'A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.'
- type:
- - string
- - 'null'
- type:
- readOnly: true
- description: 'A URI reference that identifies the problem type'
- type: string
- description:
- readOnly: true
- type:
- - string
- - 'null'
- Event.jsonld:
- type: object
- description: ''
- deprecated: false
- properties:
- '@context':
- readOnly: true
- oneOf:
- -
- type: string
- -
- type: object
- properties:
- '@vocab':
- type: string
- hydra:
- type: string
- enum: ['http://www.w3.org/ns/hydra/core#']
- required:
- - '@vocab'
- - hydra
- additionalProperties: true
- '@id':
- readOnly: true
- type: string
- '@type':
- readOnly: true
- type: string
- dbId:
- readOnly: true
- type:
- - integer
- - 'null'
- name:
- type: string
- identifier:
- type: string
- sequence:
- type: integer
- mandatory:
- type: boolean
- createdAt:
- readOnly: true
- type:
- - string
- - 'null'
- format: date-time
- Location:
- type: object
- description: ''
- deprecated: false
- properties:
- dbId:
- readOnly: true
- type:
- - integer
- - 'null'
- zone:
- readOnly: true
- type: string
- format: iri-reference
- example: 'https://example.com/'
- zoneIri:
- type:
- - string
- - 'null'
- format: iri-reference
- example: 'https://example.com/'
- name:
- type: string
- code:
- type: string
- zoneName:
- readOnly: true
- type: string
- isZone:
- type: boolean
- isPlace:
- type: boolean
- isPort:
- type: boolean
- isStartEnd:
- type: boolean
- createdAt:
- readOnly: true
- type:
- - string
- - 'null'
- format: date-time
- required:
- - zoneIri
- - name
- - code
- Location.jsonld:
- type: object
- description: ''
- deprecated: false
- properties:
- '@context':
- readOnly: true
- oneOf:
- -
- type: string
- -
- type: object
- properties:
- '@vocab':
- type: string
- hydra:
- type: string
- enum: ['http://www.w3.org/ns/hydra/core#']
- required:
- - '@vocab'
- - hydra
- additionalProperties: true
- '@id':
- readOnly: true
- type: string
- '@type':
- readOnly: true
- type: string
- dbId:
- readOnly: true
- type:
- - integer
- - 'null'
- zone:
- readOnly: true
- $ref: '#/components/schemas/Zone.jsonld'
- zoneIri:
- type:
- - string
- - 'null'
- format: iri-reference
- example: 'https://example.com/'
- name:
- type: string
- code:
- type: string
- zoneName:
- readOnly: true
- type: string
- isZone:
- type: boolean
- isPlace:
- type: boolean
- isPort:
- type: boolean
- isStartEnd:
- type: boolean
- createdAt:
- readOnly: true
- type:
- - string
- - 'null'
- format: date-time
- required:
- - zoneIri
- - name
- - code
- MediaObject.jsonld:
- type: object
- description: ''
- deprecated: false
- properties:
- '@context':
- readOnly: true
- oneOf:
- -
- type: string
- -
- type: object
- properties:
- '@vocab':
- type: string
- hydra:
- type: string
- enum: ['http://www.w3.org/ns/hydra/core#']
- required:
- - '@vocab'
- - hydra
- additionalProperties: true
- '@id':
- readOnly: true
- type: string
- '@type':
- readOnly: true
- type: string
- dbId:
- readOnly: true
- type:
- - integer
- - 'null'
- contentUrl:
- externalDocs:
- url: 'https://schema.org/contentUrl'
- type:
- - string
- - 'null'
- filePath:
- readOnly: true
- type:
- - string
- - 'null'
- createdAt:
- readOnly: true
- type:
- - string
- - 'null'
- format: date-time
- ShippingCompany:
- type: object
- description: ''
- deprecated: false
- properties:
- dbId:
- readOnly: true
- type:
- - integer
- - 'null'
- name:
- type: string
- code:
- type: string
- createdAt:
- readOnly: true
- type:
- - string
- - 'null'
- format: date-time
- required:
- - name
- - code
- ShippingCompany.jsonld:
- type: object
- description: ''
- deprecated: false
- properties:
- '@context':
- readOnly: true
- oneOf:
- -
- type: string
- -
- type: object
- properties:
- '@vocab':
- type: string
- hydra:
- type: string
- enum: ['http://www.w3.org/ns/hydra/core#']
- required:
- - '@vocab'
- - hydra
- additionalProperties: true
- '@id':
- readOnly: true
- type: string
- '@type':
- readOnly: true
- type: string
- dbId:
- readOnly: true
- type:
- - integer
- - 'null'
- name:
- type: string
- code:
- type: string
- createdAt:
- readOnly: true
- type:
- - string
- - 'null'
- format: date-time
- required:
- - name
- - code
- Trip:
- type: object
- description: ''
- deprecated: false
- properties:
- dbId:
- readOnly: true
- type:
- - integer
- - 'null'
- vessel:
- readOnly: true
- type: string
- format: iri-reference
- example: 'https://example.com/'
- vesselIri:
- type:
- - string
- - 'null'
- format: iri-reference
- example: 'https://example.com/'
- pilotageReference:
- type:
- - string
- - 'null'
- startLocation:
- readOnly: true
- type: string
- format: iri-reference
- example: 'https://example.com/'
- startLocationIri:
- type:
- - string
- - 'null'
- format: iri-reference
- example: 'https://example.com/'
- endLocation:
- readOnly: true
- type: string
- format: iri-reference
- example: 'https://example.com/'
- endLocationIri:
- type:
- - string
- - 'null'
- format: iri-reference
- example: 'https://example.com/'
- startDate:
- type: string
- format: date-time
- endDate:
- type: string
- format: date-time
- note:
- type:
- - string
- - 'null'
- completed:
- type: boolean
- createdAt:
- readOnly: true
- type:
- - string
- - 'null'
- format: date-time
- required:
- - vesselIri
- - startLocationIri
- - endLocationIri
- - startDate
- - endDate
- Trip.jsonld:
- type: object
- description: ''
- deprecated: false
- properties:
- '@context':
- readOnly: true
- oneOf:
- -
- type: string
- -
- type: object
- properties:
- '@vocab':
- type: string
- hydra:
- type: string
- enum: ['http://www.w3.org/ns/hydra/core#']
- required:
- - '@vocab'
- - hydra
- additionalProperties: true
- '@id':
- readOnly: true
- type: string
- '@type':
- readOnly: true
- type: string
- dbId:
- readOnly: true
- type:
- - integer
- - 'null'
- vessel:
- readOnly: true
- $ref: '#/components/schemas/Vessel.jsonld'
- vesselIri:
- type:
- - string
- - 'null'
- format: iri-reference
- example: 'https://example.com/'
- pilotageReference:
- type:
- - string
- - 'null'
- startLocation:
- readOnly: true
- $ref: '#/components/schemas/Location.jsonld'
- startLocationIri:
- type:
- - string
- - 'null'
- format: iri-reference
- example: 'https://example.com/'
- endLocation:
- readOnly: true
- $ref: '#/components/schemas/Location.jsonld'
- endLocationIri:
- type:
- - string
- - 'null'
- format: iri-reference
- example: 'https://example.com/'
- startDate:
- type: string
- format: date-time
- endDate:
- type: string
- format: date-time
- note:
- type:
- - string
- - 'null'
- completed:
- type: boolean
- createdAt:
- readOnly: true
- type:
- - string
- - 'null'
- format: date-time
- required:
- - vesselIri
- - startLocationIri
- - endLocationIri
- - startDate
- - endDate
- TripLocation:
- type: object
- description: ''
- deprecated: false
- properties:
- dbId:
- readOnly: true
- type:
- - integer
- - 'null'
- trip:
- readOnly: true
- type: string
- format: iri-reference
- example: 'https://example.com/'
- tripIri:
- type:
- - string
- - 'null'
- format: iri-reference
- example: 'https://example.com/'
- location:
- readOnly: true
- type: string
- format: iri-reference
- example: 'https://example.com/'
- locationIri:
- type:
- - string
- - 'null'
- format: iri-reference
- example: 'https://example.com/'
- arrivalDateTime:
- type:
- - string
- - 'null'
- format: date-time
- departureDateTime:
- type:
- - string
- - 'null'
- format: date-time
- createdAt:
- readOnly: true
- type:
- - string
- - 'null'
- format: date-time
- required:
- - tripIri
- - locationIri
- TripLocation.jsonld:
- type: object
- description: ''
- deprecated: false
- properties:
- '@context':
- readOnly: true
- oneOf:
- -
- type: string
- -
- type: object
- properties:
- '@vocab':
- type: string
- hydra:
- type: string
- enum: ['http://www.w3.org/ns/hydra/core#']
- required:
- - '@vocab'
- - hydra
- additionalProperties: true
- '@id':
- readOnly: true
- type: string
- '@type':
- readOnly: true
- type: string
- dbId:
- readOnly: true
- type:
- - integer
- - 'null'
- trip:
- readOnly: true
- $ref: '#/components/schemas/Trip.jsonld'
- tripIri:
- type:
- - string
- - 'null'
- format: iri-reference
- example: 'https://example.com/'
- location:
- readOnly: true
- $ref: '#/components/schemas/Location.jsonld'
- locationIri:
- type:
- - string
- - 'null'
- format: iri-reference
- example: 'https://example.com/'
- arrivalDateTime:
- type:
- - string
- - 'null'
- format: date-time
- departureDateTime:
- type:
- - string
- - 'null'
- format: date-time
- createdAt:
- readOnly: true
- type:
- - string
- - 'null'
- format: date-time
- required:
- - tripIri
- - locationIri
- User:
- type: object
- description: ''
- deprecated: false
- properties:
- dbId:
- readOnly: true
- type:
- - integer
- - 'null'
- email:
- format: email
- externalDocs:
- url: 'https://schema.org/email'
- type: string
- firstName:
- type: string
- referenceId:
- type: string
- lastName:
- type: string
- image:
- readOnly: true
- type: string
- format: iri-reference
- example: 'https://example.com/'
- imageIri:
- type:
- - string
- - 'null'
- format: iri-reference
- example: 'https://example.com/'
- imageUrl:
- readOnly: true
- type:
- - string
- - 'null'
- fullName:
- readOnly: true
- type:
- - string
- - 'null'
- password:
- writeOnly: true
- description: 'The plaintext password when being set or changed.'
- type:
- - string
- - 'null'
- isAdmin:
- type: boolean
- active:
- type: boolean
- isPilot:
- type: boolean
- roles:
- readOnly: true
- type: array
- items:
- type: string
- createdAt:
- readOnly: true
- type:
- - string
- - 'null'
- format: date-time
- required:
- - email
- - firstName
- - referenceId
- - lastName
- - isAdmin
- - active
- - isPilot
- User.jsonld:
- type: object
- description: ''
- deprecated: false
- properties:
- '@context':
- readOnly: true
- oneOf:
- -
- type: string
- -
- type: object
- properties:
- '@vocab':
- type: string
- hydra:
- type: string
- enum: ['http://www.w3.org/ns/hydra/core#']
- required:
- - '@vocab'
- - hydra
- additionalProperties: true
- '@id':
- readOnly: true
- type: string
- '@type':
- readOnly: true
- type: string
- dbId:
- readOnly: true
- type:
- - integer
- - 'null'
- email:
- format: email
- externalDocs:
- url: 'https://schema.org/email'
- type: string
- firstName:
- type: string
- referenceId:
- type: string
- lastName:
- type: string
- image:
- readOnly: true
- $ref: '#/components/schemas/MediaObject.jsonld'
- imageIri:
- type:
- - string
- - 'null'
- format: iri-reference
- example: 'https://example.com/'
- imageUrl:
- readOnly: true
- type:
- - string
- - 'null'
- fullName:
- readOnly: true
- type:
- - string
- - 'null'
- password:
- writeOnly: true
- description: 'The plaintext password when being set or changed.'
- type:
- - string
- - 'null'
- isAdmin:
- type: boolean
- active:
- type: boolean
- isPilot:
- type: boolean
- roles:
- readOnly: true
- type: array
- items:
- type: string
- createdAt:
- readOnly: true
- type:
- - string
- - 'null'
- format: date-time
- required:
- - email
- - firstName
- - referenceId
- - lastName
- - isAdmin
- - active
- - isPilot
- UserTrip:
- type: object
- description: ''
- deprecated: false
- properties:
- dbId:
- readOnly: true
- type:
- - integer
- - 'null'
- trip:
- readOnly: true
- type: string
- format: iri-reference
- example: 'https://example.com/'
- tripIri:
- type:
- - string
- - 'null'
- format: iri-reference
- example: 'https://example.com/'
- user:
- readOnly: true
- type: string
- format: iri-reference
- example: 'https://example.com/'
- userIri:
- type:
- - string
- - 'null'
- format: iri-reference
- example: 'https://example.com/'
- captainName:
- type:
- - string
- - 'null'
- completed:
- type: boolean
- approved:
- type: boolean
- signature:
- readOnly: true
- type: string
- format: iri-reference
- example: 'https://example.com/'
- signatureIri:
- type:
- - string
- - 'null'
- format: iri-reference
- example: 'https://example.com/'
- signatureUrl:
- readOnly: true
- type:
- - string
- - 'null'
- completedDate:
- type:
- - string
- - 'null'
- format: date-time
- createdAt:
- readOnly: true
- type:
- - string
- - 'null'
- format: date-time
- required:
- - tripIri
- - userIri
- - completed
- - approved
- UserTrip.jsonld:
- type: object
- description: ''
- deprecated: false
- properties:
- '@context':
- readOnly: true
- oneOf:
- -
- type: string
- -
- type: object
- properties:
- '@vocab':
- type: string
- hydra:
- type: string
- enum: ['http://www.w3.org/ns/hydra/core#']
- required:
- - '@vocab'
- - hydra
- additionalProperties: true
- '@id':
- readOnly: true
- type: string
- '@type':
- readOnly: true
- type: string
- dbId:
- readOnly: true
- type:
- - integer
- - 'null'
- trip:
- readOnly: true
- $ref: '#/components/schemas/Trip.jsonld'
- tripIri:
- type:
- - string
- - 'null'
- format: iri-reference
- example: 'https://example.com/'
- user:
- readOnly: true
- $ref: '#/components/schemas/User.jsonld'
- userIri:
- type:
- - string
- - 'null'
- format: iri-reference
- example: 'https://example.com/'
- captainName:
- type:
- - string
- - 'null'
- completed:
- type: boolean
- approved:
- type: boolean
- signature:
- readOnly: true
- $ref: '#/components/schemas/MediaObject.jsonld'
- signatureIri:
- type:
- - string
- - 'null'
- format: iri-reference
- example: 'https://example.com/'
- signatureUrl:
- readOnly: true
- type:
- - string
- - 'null'
- completedDate:
- type:
- - string
- - 'null'
- format: date-time
- createdAt:
- readOnly: true
- type:
- - string
- - 'null'
- format: date-time
- required:
- - tripIri
- - userIri
- - completed
- - approved
- UserTripEvent:
- type: object
- description: ''
- deprecated: false
- properties:
- dbId:
- readOnly: true
- type:
- - integer
- - 'null'
- userTrip:
- readOnly: true
- $ref: '#/components/schemas/UserTrip'
- userTripIri:
- type:
- - string
- - 'null'
- format: iri-reference
- example: 'https://example.com/'
- event:
- readOnly: true
- type: string
- format: iri-reference
- example: 'https://example.com/'
- eventIri:
- type:
- - string
- - 'null'
- format: iri-reference
- example: 'https://example.com/'
- location:
- readOnly: true
- type: string
- format: iri-reference
- example: 'https://example.com/'
- locationIri:
- type:
- - string
- - 'null'
- format: iri-reference
- example: 'https://example.com/'
- user:
- readOnly: true
- type: string
- format: iri-reference
- example: 'https://example.com/'
- date:
- type: string
- format: date-time
- note:
- type:
- - string
- - 'null'
- createdAt:
- readOnly: true
- type:
- - string
- - 'null'
- format: date-time
- required:
- - userTripIri
- - eventIri
- - locationIri
- - date
- UserTripEvent.jsonld:
- type: object
- description: ''
- deprecated: false
- properties:
- '@context':
- readOnly: true
- oneOf:
- -
- type: string
- -
- type: object
- properties:
- '@vocab':
- type: string
- hydra:
- type: string
- enum: ['http://www.w3.org/ns/hydra/core#']
- required:
- - '@vocab'
- - hydra
- additionalProperties: true
- '@id':
- readOnly: true
- type: string
- '@type':
- readOnly: true
- type: string
- dbId:
- readOnly: true
- type:
- - integer
- - 'null'
- userTrip:
- readOnly: true
- $ref: '#/components/schemas/UserTrip.jsonld'
- userTripIri:
- type:
- - string
- - 'null'
- format: iri-reference
- example: 'https://example.com/'
- event:
- readOnly: true
- $ref: '#/components/schemas/Event.jsonld'
- eventIri:
- type:
- - string
- - 'null'
- format: iri-reference
- example: 'https://example.com/'
- location:
- readOnly: true
- $ref: '#/components/schemas/Location.jsonld'
- locationIri:
- type:
- - string
- - 'null'
- format: iri-reference
- example: 'https://example.com/'
- user:
- readOnly: true
- $ref: '#/components/schemas/User.jsonld'
- date:
- type: string
- format: date-time
- note:
- type:
- - string
- - 'null'
- createdAt:
- readOnly: true
- type:
- - string
- - 'null'
- format: date-time
- required:
- - userTripIri
- - eventIri
- - locationIri
- - date
- UserZone:
- type: object
- description: ''
- deprecated: false
- properties:
- dbId:
- readOnly: true
- type:
- - integer
- - 'null'
- user:
- readOnly: true
- type: string
- format: iri-reference
- example: 'https://example.com/'
- userIri:
- type:
- - string
- - 'null'
- format: iri-reference
- example: 'https://example.com/'
- zone:
- readOnly: true
- type: string
- format: iri-reference
- example: 'https://example.com/'
- zoneIri:
- type:
- - string
- - 'null'
- format: iri-reference
- example: 'https://example.com/'
- UserZone.jsonld:
- type: object
- description: ''
- deprecated: false
- properties:
- '@context':
- readOnly: true
- oneOf:
- -
- type: string
- -
- type: object
- properties:
- '@vocab':
- type: string
- hydra:
- type: string
- enum: ['http://www.w3.org/ns/hydra/core#']
- required:
- - '@vocab'
- - hydra
- additionalProperties: true
- '@id':
- readOnly: true
- type: string
- '@type':
- readOnly: true
- type: string
- dbId:
- readOnly: true
- type:
- - integer
- - 'null'
- user:
- readOnly: true
- $ref: '#/components/schemas/User.jsonld'
- userIri:
- type:
- - string
- - 'null'
- format: iri-reference
- example: 'https://example.com/'
- zone:
- readOnly: true
- $ref: '#/components/schemas/Zone.jsonld'
- zoneIri:
- type:
- - string
- - 'null'
- format: iri-reference
- example: 'https://example.com/'
- Vessel:
- type: object
- description: ''
- deprecated: false
- properties:
- dbId:
- readOnly: true
- type:
- - integer
- - 'null'
- name:
- type: string
- code:
- type: string
- company:
- readOnly: true
- type: string
- format: iri-reference
- example: 'https://example.com/'
- companyIri:
- type:
- - string
- - 'null'
- format: iri-reference
- example: 'https://example.com/'
- length:
- type:
- - number
- - 'null'
- breadth:
- type:
- - number
- - 'null'
- draft:
- type:
- - number
- - 'null'
- grossTonnage:
- type:
- - number
- - 'null'
- imoNo:
- type:
- - string
- - 'null'
- callSign:
- type:
- - string
- - 'null'
- createdAt:
- readOnly: true
- type:
- - string
- - 'null'
- format: date-time
- required:
- - name
- - code
- - companyIri
- Vessel.jsonld:
- type: object
- description: ''
- deprecated: false
- properties:
- '@context':
- readOnly: true
- oneOf:
- -
- type: string
- -
- type: object
- properties:
- '@vocab':
- type: string
- hydra:
- type: string
- enum: ['http://www.w3.org/ns/hydra/core#']
- required:
- - '@vocab'
- - hydra
- additionalProperties: true
- '@id':
- readOnly: true
- type: string
- '@type':
- readOnly: true
- type: string
- dbId:
- readOnly: true
- type:
- - integer
- - 'null'
- name:
- type: string
- code:
- type: string
- company:
- readOnly: true
- $ref: '#/components/schemas/ShippingCompany.jsonld'
- companyIri:
- type:
- - string
- - 'null'
- format: iri-reference
- example: 'https://example.com/'
- length:
- type:
- - number
- - 'null'
- breadth:
- type:
- - number
- - 'null'
- draft:
- type:
- - number
- - 'null'
- grossTonnage:
- type:
- - number
- - 'null'
- imoNo:
- type:
- - string
- - 'null'
- callSign:
- type:
- - string
- - 'null'
- createdAt:
- readOnly: true
- type:
- - string
- - 'null'
- format: date-time
- required:
- - name
- - code
- - companyIri
- Zone:
- type: object
- description: ''
- deprecated: false
- properties:
- dbId:
- readOnly: true
- type:
- - integer
- - 'null'
- name:
- type: string
- createdAt:
- readOnly: true
- type:
- - string
- - 'null'
- format: date-time
- required:
- - name
- Zone.jsonld:
- type: object
- description: ''
- deprecated: false
- properties:
- '@context':
- readOnly: true
- oneOf:
- -
- type: string
- -
- type: object
- properties:
- '@vocab':
- type: string
- hydra:
- type: string
- enum: ['http://www.w3.org/ns/hydra/core#']
- required:
- - '@vocab'
- - hydra
- additionalProperties: true
- '@id':
- readOnly: true
- type: string
- '@type':
- readOnly: true
- type: string
- dbId:
- readOnly: true
- type:
- - integer
- - 'null'
- name:
- type: string
- createdAt:
- readOnly: true
- type:
- - string
- - 'null'
- format: date-time
- required:
- - name
- Credentials:
- type: object
- properties:
- email:
- type: string
- example: user@example.com
- password:
- type: string
- example: password123
- AuthResponse:
- type: object
- properties:
- '@id':
- type: string
- example: /api/users/1
- dbId:
- type: integer
- example: 1
- token:
- type: string
- example: JWT_TOKEN
- responses: { }
- parameters: { }
- examples: { }
- requestBodies: { }
- headers: { }
- securitySchemes:
- JWT:
- type: http
- scheme: bearer
- bearerFormat: JWT
- security:
- -
- JWT: []
- tags:
- -
- name: Event
- -
- name: Location
- -
- name: MediaObject
- -
- name: ShippingCompany
- -
- name: Trip
- -
- name: TripLocation
- -
- name: User
- -
- name: UserTrip
- -
- name: UserTripEvent
- -
- name: UserZone
- -
- name: Vessel
- -
- name: Zone
- webhooks: { }
|