| Requires any of the roles: | bookingsupplier-administrator-write, superadmin |
| POST | /tags | Create a new tag | Creates a new tag for the company. |
|---|
import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*
@ApiResponse(Description="Returned if there is a validation error on the input parameters", StatusCode=400)
// @ApiResponse(Description="Returned if the current user is not allowed to perform the action", StatusCode=401)
@ValidateRequest(Validator="IsAuthenticated")
open class CreateTag : 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 name.
*/
@ApiMember(Description="The tag name.", IsRequired=true)
open var Name:String? = null
/**
* The scope this tag applies to. 0 = Booking, 1 = Customer.
*/
@ApiMember(Description="The scope this tag applies to. 0 = Booking, 1 = Customer.", IsRequired=true)
open var Scope:TagScope? = null
/**
* The display color for the tag, e.g. '#FF5733' or 'red'.
*/
@ApiMember(Description="The display color for the tag, e.g. '#FF5733' or 'red'.")
open var Color:String? = null
/**
* The sort order for the tag.
*/
@ApiMember(Description="The sort order for the tag.")
open var SortOrder:Int? = null
}
enum class TagScope
{
Booking,
Customer,
}
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
}
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 /tags HTTP/1.1
Host: api.bookmore.com
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
CompanyId: 00000000-0000-0000-0000-000000000000,
Name: String,
Scope: Booking,
Color: String,
SortOrder: 0
}
HTTP/1.1 200 OK
Content-Type: text/jsv
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
}
}
}