BokaMera.API.Host

<back to all web services

DeleteTag

Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, superadmin
The following routes are available for this service:
DELETE/tags/{Id}Deactivate a tagDeactivates a tag (soft delete). The tag is not removed from the database.
import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*


@ApiResponse(Description="Returned if the tag was not found", StatusCode=404)
// @ApiResponse(Description="Returned if the current user is not allowed to perform the action", StatusCode=401)
@ValidateRequest(Validator="IsAuthenticated")
open class DeleteTag : 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.")
    override var CompanyId:UUID? = null

    /**
    * The tag id.
    */
    @ApiMember(Description="The tag id.", IsRequired=true, ParameterType="path")
    open var Id:Int? = null
}

open class TagResponse
{
    open var Id:Int? = null
    open var CompanyId:UUID? = null
    open var Name:String? = null
    open var Scope:Int? = null
    open var Color:String? = null
    open var SortOrder:Int? = null
    open var Active:Boolean? = null
    open var CreatedDate:Date? = null
    open var ResponseStatus:ResponseStatus? = null
}

Kotlin DeleteTag DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

DELETE /tags/{Id} HTTP/1.1 
Host: api.bookmore.com 
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"Id":0,"Name":"String","Scope":0,"Color":"String","SortOrder":0,"Active":false,"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}