BokaMera.API.Host

<back to all web services

CreateResourceType

Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, superadmin
The following routes are available for this service:
POST/resourcetypesAdd a new resourcetypeAdd a new resourcetype to the company of the currently logged in user, only administrators are allowed to add resourcetypes.
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using BokaMera.API.ServiceModel.Dtos;

namespace BokaMera.API.ServiceModel.Dtos
{
    public partial class AddResourceTypeResource
    {
        ///<summary>
        ///The resource id
        ///</summary>
        [ApiMember(Description="The resource id")]
        public virtual int Id { get; set; }

        ///<summary>
        ///The priority of the resource. If no priority is set it will take random resource when booking a time.
        ///</summary>
        [ApiMember(Description="The priority of the resource. If no priority is set it will take random resource when booking a time.")]
        public virtual int Priority { get; set; }
    }

    [ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)]
    [ApiResponse(Description="You have too low privilegies to call this service", StatusCode=403)]
    [ValidateRequest("IsAuthenticated")]
    public partial class CreateResourceType
        : ICompany
    {
        public CreateResourceType()
        {
            Resources = new List<AddResourceTypeResource>{};
        }

        ///<summary>
        ///The company id, if empty will use the company id for the user you are logged in with.
        ///</summary>
        [ApiMember(Description="The company id, if empty will use the company id for the user you are logged in with.")]
        public virtual Guid? CompanyId { get; set; }

        ///<summary>
        ///The resourcetype name
        ///</summary>
        [ApiMember(Description="The resourcetype name")]
        public virtual string Name { get; set; }

        ///<summary>
        ///The resources to be included
        ///</summary>
        [ApiMember(Description="The resources to be included")]
        public virtual List<AddResourceTypeResource> Resources { get; set; }

        ///<summary>
        ///The resourcetype description
        ///</summary>
        [ApiMember(Description="The resourcetype description")]
        public virtual string Description { get; set; }

        ///<summary>
        ///If resourcetype is active or not
        ///</summary>
        [ApiMember(Description="If resourcetype is active or not")]
        public virtual bool Active { get; set; }
    }

    public partial class ResourceTypeQueryResponse
    {
        public ResourceTypeQueryResponse()
        {
            Resources = new List<ResourceTypeResource>{};
        }

        ///<summary>
        ///The resourcetype id
        ///</summary>
        [ApiMember(Description="The resourcetype id")]
        public virtual int Id { get; set; }

        ///<summary>
        ///The resourcetype name
        ///</summary>
        [ApiMember(Description="The resourcetype name")]
        public virtual string Name { get; set; }

        ///<summary>
        ///The resourcetype description
        ///</summary>
        [ApiMember(Description="The resourcetype description")]
        public virtual string Description { get; set; }

        ///<summary>
        ///The resources in the resourcetype. Only shows active resources if not admin.
        ///</summary>
        [ApiMember(Description="The resources in the resourcetype. Only shows active resources if not admin.")]
        public virtual List<ResourceTypeResource> Resources { get; set; }

        ///<summary>
        ///If resourcetype is active or not
        ///</summary>
        [ApiMember(Description="If resourcetype is active or not")]
        public virtual bool Active { get; set; }

        ///<summary>
        ///Then date when the resource was created
        ///</summary>
        [ApiMember(Description="Then date when the resource was created")]
        public virtual DateTime Created { get; set; }

        ///<summary>
        ///Then date when the resource was updated
        ///</summary>
        [ApiMember(Description="Then date when the resource was updated")]
        public virtual DateTime Updated { get; set; }
    }

    public partial class ResourceTypeResource
    {
        ///<summary>
        ///The resource id
        ///</summary>
        [ApiMember(Description="The resource id")]
        public virtual int Id { get; set; }

        ///<summary>
        ///The resource name
        ///</summary>
        [ApiMember(Description="The resource name")]
        public virtual string Name { get; set; }

        ///<summary>
        ///The resource status
        ///</summary>
        [ApiMember(Description="The resource status")]
        public virtual bool Active { get; set; }

        ///<summary>
        ///The resource description
        ///</summary>
        [ApiMember(Description="The resource description")]
        public virtual string Description { get; set; }

        ///<summary>
        ///The resource email
        ///</summary>
        [ApiMember(Description="The resource email")]
        public virtual string Email { get; set; }

        ///<summary>
        ///The resource phone
        ///</summary>
        [ApiMember(Description="The resource phone")]
        public virtual string Phone { get; set; }

        ///<summary>
        ///The resource color
        ///</summary>
        [ApiMember(Description="The resource color")]
        public virtual string Color { get; set; }

        ///<summary>
        ///The resource image
        ///</summary>
        [ApiMember(Description="The resource image")]
        public virtual Uri ImageUrl { get; set; }

        ///<summary>
        ///The priority of the resource
        ///</summary>
        [ApiMember(Description="The priority of the resource")]
        public virtual int Priority { get; set; }

        ///<summary>
        ///If the resource want to receive email notifications
        ///</summary>
        [ApiMember(Description="If the resource want to receive email notifications")]
        public virtual bool EmailNotification { get; set; }

        ///<summary>
        ///If the resource want to receive sms notifications
        ///</summary>
        [ApiMember(Description="If the resource want to receive sms notifications")]
        public virtual bool SMSNotification { get; set; }

        ///<summary>
        ///If the resource want to receive email reminders
        ///</summary>
        [ApiMember(Description="If the resource want to receive email reminders")]
        public virtual bool EmailReminder { get; set; }

        ///<summary>
        ///If the resource want to receive sms reminders
        ///</summary>
        [ApiMember(Description="If the resource want to receive sms reminders")]
        public virtual bool SMSReminder { get; set; }
    }

}

C# CreateResourceType DTOs

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

HTTP + XML

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

POST /resourcetypes HTTP/1.1 
Host: api.bokamera.se 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<CreateResourceType xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <Active>false</Active>
  <CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
  <Description>String</Description>
  <Name>String</Name>
  <Resources>
    <AddResourceTypeResource>
      <Id>0</Id>
      <Priority>0</Priority>
    </AddResourceTypeResource>
  </Resources>
</CreateResourceType>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ResourceTypeQueryResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <Active>false</Active>
  <Created>0001-01-01T00:00:00</Created>
  <Description>String</Description>
  <Id>0</Id>
  <Name>String</Name>
  <Resources>
    <ResourceTypeResource>
      <Active>false</Active>
      <Color>String</Color>
      <Description>String</Description>
      <Email>String</Email>
      <EmailNotification>false</EmailNotification>
      <EmailReminder>false</EmailReminder>
      <Id>0</Id>
      <ImageUrl i:nil="true" />
      <Name>String</Name>
      <Phone>String</Phone>
      <Priority>0</Priority>
      <SMSNotification>false</SMSNotification>
      <SMSReminder>false</SMSReminder>
    </ResourceTypeResource>
  </Resources>
  <Updated>0001-01-01T00:00:00</Updated>
</ResourceTypeQueryResponse>