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. |
---|
export class ResourceTypeResource
{
/** @description The resource id */
// @ApiMember(Description="The resource id")
public Id: number;
/** @description The resource name */
// @ApiMember(Description="The resource name")
public Name: string;
/** @description The resource status */
// @ApiMember(Description="The resource status")
public Active: boolean;
/** @description The resource description */
// @ApiMember(Description="The resource description")
public Description: string;
/** @description The resource email */
// @ApiMember(Description="The resource email")
public Email: string;
/** @description The resource phone */
// @ApiMember(Description="The resource phone")
public Phone: string;
/** @description The resource color */
// @ApiMember(Description="The resource color")
public Color: string;
/** @description The resource image */
// @ApiMember(Description="The resource image")
public ImageUrl: string;
/** @description The priority of the resource */
// @ApiMember(Description="The priority of the resource")
public Priority: number;
/** @description If the resource want to receive email notifications */
// @ApiMember(Description="If the resource want to receive email notifications")
public EmailNotification: boolean;
/** @description If the resource want to receive sms notifications */
// @ApiMember(Description="If the resource want to receive sms notifications")
public SMSNotification: boolean;
/** @description If the resource want to receive email reminders */
// @ApiMember(Description="If the resource want to receive email reminders")
public EmailReminder: boolean;
/** @description If the resource want to receive sms reminders */
// @ApiMember(Description="If the resource want to receive sms reminders")
public SMSReminder: boolean;
public constructor(init?: Partial<ResourceTypeResource>) { (Object as any).assign(this, init); }
}
export class ResourceTypeQueryResponse
{
/** @description The resourcetype id */
// @ApiMember(Description="The resourcetype id")
public Id: number;
/** @description The resourcetype name */
// @ApiMember(Description="The resourcetype name")
public Name: string;
/** @description The resourcetype description */
// @ApiMember(Description="The resourcetype description")
public Description: string;
/** @description 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.")
public Resources: ResourceTypeResource[];
/** @description If resourcetype is active or not */
// @ApiMember(Description="If resourcetype is active or not")
public Active: boolean;
/** @description Then date when the resource was created */
// @ApiMember(Description="Then date when the resource was created")
public Created: string;
/** @description Then date when the resource was updated */
// @ApiMember(Description="Then date when the resource was updated")
public Updated: string;
public constructor(init?: Partial<ResourceTypeQueryResponse>) { (Object as any).assign(this, init); }
}
export class AddResourceTypeResource
{
/** @description The resource id */
// @ApiMember(Description="The resource id")
public Id: number;
/** @description 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.")
public Priority: number;
public constructor(init?: Partial<AddResourceTypeResource>) { (Object as any).assign(this, init); }
}
// @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")
export class CreateResourceType implements ICompany
{
/** @description 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.")
public CompanyId?: string;
/** @description The resourcetype name */
// @ApiMember(Description="The resourcetype name")
public Name: string;
/** @description The resources to be included */
// @ApiMember(Description="The resources to be included")
public Resources: AddResourceTypeResource[];
/** @description The resourcetype description */
// @ApiMember(Description="The resourcetype description")
public Description: string;
/** @description If resourcetype is active or not */
// @ApiMember(Description="If resourcetype is active or not")
public Active: boolean;
public constructor(init?: Partial<CreateResourceType>) { (Object as any).assign(this, init); }
}
TypeScript CreateResourceType DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
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: text/jsv
Content-Type: text/jsv
Content-Length: length
{
CompanyId: 00000000-0000-0000-0000-000000000000,
Name: String,
Resources:
[
{
Id: 0,
Priority: 0
}
],
Description: String,
Active: False
}
HTTP/1.1 200 OK Content-Type: text/jsv 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 }