BokaMera.API.Host

<back to all web services

RemoveResource

Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, superadmin
The following routes are available for this service:
DELETE/resourcetypes/{Id}/removeresourceRemove resource(s) from resourcetypeRemove resource(s) from resourcetype for the currently logged in user, only administrators are allowed to remove resources to resourcetypes.
RemoveResource Parameters:
NameParameterData TypeRequiredDescription
CompanyIdqueryGuid?NoThe company id, if empty will use the company id for the user you are logged in with.
IdpathintYesThe ResourceType id
ResourcesqueryList<RemoveResourceTypeResource>YesThe resources to be removed
RemoveResourceTypeResource Parameters:
NameParameterData TypeRequiredDescription
IdformintNoThe resource id
ResourceTypeQueryResponse Parameters:
NameParameterData TypeRequiredDescription
IdformintNoThe resourcetype id
NameformstringYesThe resourcetype name
DescriptionformstringYesThe resourcetype description
ResourcesformList<ResourceTypeResource>YesThe resources in the resourcetype. Only shows active resources if not admin.
ActiveformboolNoIf resourcetype is active or not
CreatedformDateTimeNoThe date when the resource was created
UpdatedformDateTimeNoThe date when the resource was updated
ResourceTypeResource Parameters:
NameParameterData TypeRequiredDescription
IdformintNoThe resource id
NameformstringYesThe resource name
ActiveformboolNoThe resource status
DescriptionformstringYesThe resource description
EmailformstringYesThe resource email
PhoneformstringYesThe resource phone
ColorformstringYesThe resource color
ImageUrlformUriYesThe resource image
PriorityformintNoThe priority of the resource
EmailNotificationformboolNoIf the resource wants to receive Email notifications
SMSNotificationformboolNoIf the resource wants to receive SMS notifications
EmailReminderformboolNoIf the resource wants to receive Email reminders
SMSReminderformboolNoIf the resource wants to receive SMS reminders

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

DELETE /resourcetypes/{Id}/removeresource HTTP/1.1 
Host: api.bokamera.se 
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"Id":0,"Name":"String","Description":"String","Resources":[{"Id":0,"Name":"String","Active":false,"Description":"String","Email":"String","Phone":"String","Color":"String","Priority":0,"EmailNotification":false,"SMSNotification":false,"EmailReminder":false,"SMSReminder":false}],"Active":false}