Requires any of the roles: | bookingsupplier-administrator-write, superadmin |
POST | /resourcetypes | Add a new resourcetype | Add a new resourcetype to the company of the currently logged in user, only administrators are allowed to add resourcetypes. |
---|
import java.math.*
import java.util.*
import net.servicestack.client.*
@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(Validator="IsAuthenticated")
open class CreateResourceType : ICompany
{
/**
* The company id, if empty will use the company id for the user you are logged in with.
*/
@ApiMember(Description="The company id, if empty will use the company id for the user you are logged in with.")
var CompanyId:UUID? = null
/**
* The resourcetype name
*/
@ApiMember(Description="The resourcetype name")
var Name:String? = null
/**
* The resources to be included
*/
@ApiMember(Description="The resources to be included")
var Resources:ArrayList<AddResourceTypeResource> = ArrayList<AddResourceTypeResource>()
/**
* The resourcetype description
*/
@ApiMember(Description="The resourcetype description")
var Description:String? = null
/**
* If resourcetype is active or not
*/
@ApiMember(Description="If resourcetype is active or not")
var Active:Boolean? = null
}
open class AddResourceTypeResource
{
/**
* The resource id
*/
@ApiMember(Description="The resource id")
var Id:Int? = null
/**
* The priority of the resource. If no priority is set it will take random resource when booking a time.
*/
@ApiMember(Description="The priority of the resource. If no priority is set it will take random resource when booking a time.")
var Priority:Int? = null
}
open class ResourceTypeQueryResponse
{
/**
* The resourcetype id
*/
@ApiMember(Description="The resourcetype id")
var Id:Int? = null
/**
* The resourcetype name
*/
@ApiMember(Description="The resourcetype name")
var Name:String? = null
/**
* The resourcetype description
*/
@ApiMember(Description="The resourcetype description")
var Description:String? = null
/**
* The resources in the resourcetype. Only shows active resources if not admin.
*/
@ApiMember(Description="The resources in the resourcetype. Only shows active resources if not admin.")
var Resources:ArrayList<ResourceTypeResource> = ArrayList<ResourceTypeResource>()
/**
* If resourcetype is active or not
*/
@ApiMember(Description="If resourcetype is active or not")
var Active:Boolean? = null
/**
* Then date when the resource was created
*/
@ApiMember(Description="Then date when the resource was created")
var Created:Date? = null
/**
* Then date when the resource was updated
*/
@ApiMember(Description="Then date when the resource was updated")
var Updated:Date? = null
}
open class ResourceTypeResource
{
/**
* The resource id
*/
@ApiMember(Description="The resource id")
var Id:Int? = null
/**
* The resource name
*/
@ApiMember(Description="The resource name")
var Name:String? = null
/**
* The resource status
*/
@ApiMember(Description="The resource status")
var Active:Boolean? = null
/**
* The resource description
*/
@ApiMember(Description="The resource description")
var Description:String? = null
/**
* The resource email
*/
@ApiMember(Description="The resource email")
var Email:String? = null
/**
* The resource phone
*/
@ApiMember(Description="The resource phone")
var Phone:String? = null
/**
* The resource color
*/
@ApiMember(Description="The resource color")
var Color:String? = null
/**
* The resource image
*/
@ApiMember(Description="The resource image")
var ImageUrl:Uri? = null
/**
* The priority of the resource
*/
@ApiMember(Description="The priority of the resource")
var Priority:Int? = null
/**
* If the resource want to receive email notifications
*/
@ApiMember(Description="If the resource want to receive email notifications")
var EmailNotification:Boolean? = null
/**
* If the resource want to receive sms notifications
*/
@ApiMember(Description="If the resource want to receive sms notifications")
var SMSNotification:Boolean? = null
/**
* If the resource want to receive email reminders
*/
@ApiMember(Description="If the resource want to receive email reminders")
var EmailReminder:Boolean? = null
/**
* If the resource want to receive sms reminders
*/
@ApiMember(Description="If the resource want to receive sms reminders")
var SMSReminder:Boolean? = null
}
Kotlin CreateResourceType DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=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: testapi.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>