BokaMera.API.Host

<back to all web services

UpdateResourceType

Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, superadmin
The following routes are available for this service:
PUT/resourcetypes/{Id}Update existing resourcetypeUpdates an existing resourcetype if you are authorized to do so.

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 UpdateResourceTypeResource
{
    /** @description The resource id */
    // @ApiMember(Description="The resource id")
    public Id: number;

    /** @description The priority of the resource */
    // @ApiMember(Description="The priority of the resource")
    public Priority: number;

    public constructor(init?: Partial<UpdateResourceTypeResource>) { (Object as any).assign(this, init); }
}

// @ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
// @ValidateRequest(Validator="IsAuthenticated")
export class UpdateResourceType 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 Id of the resourcetype */
    // @ApiMember(Description="Id of the resourcetype", IsRequired=true, ParameterType="path")
    public Id: number;

    /** @description The resources to be added */
    // @ApiMember(Description="The resources to be added")
    public Resources: UpdateResourceTypeResource[];

    /** @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 If resourcetype is active or not */
    // @ApiMember(Description="If resourcetype is active or not")
    public Active: boolean;

    public constructor(init?: Partial<UpdateResourceType>) { (Object as any).assign(this, init); }
}

TypeScript UpdateResourceType DTOs

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.

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

{"CompanyId":"00000000-0000-0000-0000-000000000000","Id":0,"Resources":[{"Id":0,"Priority":0}],"Name":"String","Description":"String","Active":false}
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}