POST/v2/sharesCreate a share

Create a share

header	Authorization	Authentication token (bearer token or API key).
{ "organizationId" : Number, "startDate" : Local date (ISO 8601, e.g. "2022-06-23"), "startTime" : Local time (ISO 8601, e.g. "13:53:02"), "endDate" : Local date (ISO 8601, e.g. "2022-06-23"), "endTime" : Local time (ISO 8601, e.g. "13:53:02"), "schedule" : [{ "dayOfWeek" : "Monday" / "Tuesday" / "Wednesday" / "Thursday" / "Friday" / "Saturday" / "Sunday", "period" : { "startTime" : Local time (ISO 8601, e.g. "13:53:02"), "endTime" : Local time (ISO 8601, e.g. "13:53:02") }, "recurrence" : "Daily" / "Weekly" / "BiWeekly" }], "permissions" : { "administrate" : Boolean, "remoteActivate" : Boolean, "assignKeyfob" : Boolean }, "source" : { "deviceId" : Number, "deviceGroupId" : Number }, "receiver" : { "userId" : Number, "userGroupId" : Number }, "personalSettings" : { "notifications" : Boolean } }

Response

status	200	All ok
status	401	Invalid authentication token
status	403	Insufficient rights
status	404	share not found
{ "shareId" : Number, "token" : String, UUID 4 formatted (e.g. "a426e157-8a5c-456a-8865-bec6394867ab") }

Example: Create a share

POST/v2/shares

header	Authorization	Bearer 293891d1-9278-4468-b322-6887e5e39164
{ "organizationId": 1, "schedule": [{ "dayOfWeek": "Monday", "recurrence": "Weekly" }], "permissions": { "administrate": false, "remoteActivate": true, "assignKeyfob": true }, "source": { "deviceId": 1 }, "receiver": { "userId": 2 }, "personalSettings": { "notifications": true } }

Response

status	200
header	Access-Control-Expose-Headers	authorization, content-type
header	Access-Control-Allow-Headers	authorization, content-type
header	Access-Control-Allow-Methods	GET, POST, DELETE, OPTIONS, PUT
header	Access-Control-Allow-Origin	*
header	Strict-Transport-Security	max-age=31536000; includeSubDomains
header	X-Frame-Options	SAMEORIGIN
header	X-Content-Type-Options	nosniff
header	X-XSS-Protection	1; mode=block
header	Content-Security-Policy	default-src 'none'; frame-ancestors 'none'; base-uri 'none'; form-action 'none'
header	Referrer-Policy	no-referrer
header	Feature-Policy	self
header	Permissions-policy	interest-cohort=()
{ "shareId": 3 }

Example: Create a share with invalid User Id

POST/v2/shares

header	Authorization	Bearer 2f41dafc-e24e-47af-a80b-f644fba8b137
{ "organizationId": 1, "schedule": [{ "dayOfWeek": "Monday", "recurrence": "Weekly" }], "permissions": { "administrate": true, "remoteActivate": true, "assignKeyfob": true }, "source": { "deviceId": 1 }, "receiver": { "userId": -1 }, "personalSettings": { "notifications": true } }

Response

status	400
header	Access-Control-Expose-Headers	authorization, content-type
header	Access-Control-Allow-Headers	authorization, content-type
header	Access-Control-Allow-Methods	GET, POST, DELETE, OPTIONS, PUT
header	Access-Control-Allow-Origin	*
header	Strict-Transport-Security	max-age=31536000; includeSubDomains
header	X-Frame-Options	SAMEORIGIN
header	X-Content-Type-Options	nosniff
header	X-XSS-Protection	1; mode=block
header	Content-Security-Policy	default-src 'none'; frame-ancestors 'none'; base-uri 'none'; form-action 'none'
header	Referrer-Policy	no-referrer
header	Feature-Policy	self
header	Permissions-policy	interest-cohort=()
{ "message": "Invalid input", "code": "invalidInputErrorError", "errorMessage": "Invalid input", "errorCode": "invalidInputErrorError" }