BokaMera.API.Host

<back to all web services

ResourceTypeAvailableResourcesQuery

Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, superadmin, bookingsupplier-administrator-read
The following routes are available for this service:
GET/bookings/{Id}/resources/availableFind available resources.

export class AvailableResourceResponse
{
    /** @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 description */
    // @ApiMember(Description="The resource description")
    public Description: string;

    /** @description The resource color in scheduler in hexadecimal color code. Example: #00b0f0 for blue. */
    // @ApiMember(Description="The resource color in scheduler in hexadecimal color code. Example: #00b0f0 for blue.")
    public Color: string;

    /** @description The image url of the resource */
    // @ApiMember(Description="The image url of the resource")
    public ImageUrl: string;

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

export class ResourceTypeAvailableResourcesQueryResponse
{
    /** @description The resourcetype id */
    // @ApiMember(Description="The resourcetype id")
    public Id: number;

    /** @description The available resources */
    // @ApiMember(Description="The available resources")
    public Resources: AvailableResourceResponse[];

    public constructor(init?: Partial<ResourceTypeAvailableResourcesQueryResponse>) { (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 ResourceTypeAvailableResourcesQuery implements ICompany
{
    /** @description Enter the company and id you want to see the information for a resourcetype, if blank company id and you are an admin, your company id will be used. If blank id, all resources will be shown  */
    // @ApiMember(Description="Enter the company and id you want to see the information for a resourcetype, if blank company id and you are an admin, your company id will be used. If blank id, all resources will be shown ", ParameterType="query")
    public CompanyId?: string;

    /** @description Enter the id for the booking. */
    // @ApiMember(Description="Enter the id for the booking.", IsRequired=true, ParameterType="path")
    public Id: number;

    /** @description Enter the id for a resourcetype. */
    // @ApiMember(Description="Enter the id for a resourcetype.", IsRequired=true)
    public ResourceTypeId: number;

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

TypeScript ResourceTypeAvailableResourcesQuery DTOs

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

HTTP + JSV

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

GET /bookings/{Id}/resources/available HTTP/1.1 
Host: api.bokamera.se 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Id: 0,
	Resources: 
	[
		{
			Id: 0,
			Name: String,
			Description: String,
			Color: String
		}
	]
}