| Requires any of the roles: | bookingsupplier-administrator-write, superadmin |
| POST | /customers/{CustomerId}/tags | Add tags to a customer | Attaches one or more tags to an existing customer. |
|---|
import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*
@ApiResponse(Description="Returned if a tag does not belong to this company or has the wrong scope", StatusCode=400)
// @ApiResponse(Description="Returned if the customer 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 AddTagsToCustomer : 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 customer id.
*/
@ApiMember(Description="The customer id.", IsRequired=true, ParameterType="path")
open var CustomerId:UUID? = null
/**
* The ids of the tags to attach.
*/
@ApiMember(Description="The ids of the tags to attach.", IsRequired=true)
open var TagIds:ArrayList<Int> = ArrayList<Int>()
}
open class CustomerQueryResponse
{
open var Id:UUID? = null
open var Firstname:String? = null
open var Lastname:String? = null
open var Email:String? = null
open var Phone:String? = null
open var ImageUrl:String? = null
open var PersonalIdentityNumber:String? = null
open var CustomFields:ArrayList<CustomFieldConfigData> = ArrayList<CustomFieldConfigData>()
open var CustomFieldValues:ArrayList<CustomFieldDataResponse> = ArrayList<CustomFieldDataResponse>()
open var Comments:ArrayList<CustomerCommentsResponse> = ArrayList<CustomerCommentsResponse>()
open var AccessKeys:ArrayList<UserAccessKeys> = ArrayList<UserAccessKeys>()
open var Updated:Date? = null
open var Created:Date? = null
open var ResponseStatus:Object? = null
open var SubscribedToNewsletter:Boolean? = null
open var InvoiceAddress:InvoiceAddressResponse? = null
open var Tags:ArrayList<TagResponse> = ArrayList<TagResponse>()
}
open class CustomFieldConfigData
{
/**
* Custom field id
*/
@ApiMember(Description="Custom field id")
open var Id:Int? = null
/**
* Configuration name. Example: 'Number of persons'.
*/
@ApiMember(Description="Configuration name. Example: 'Number of persons'.")
open var Name:String? = null
/**
* Custom field description. Example: 'For how many persons is this booking?'
*/
@ApiMember(Description="Custom field description. Example: 'For how many persons is this booking?'")
open var Description:String? = null
/**
* Field width. Example: 20 for 20px
*/
@ApiMember(Description="Field width. Example: 20 for 20px")
open var Width:Int? = null
/**
* Data field of custom field. Valid values are: TextBox, ... Example: 'TextBox'
*/
@ApiMember(Description="Data field of custom field. Valid values are: TextBox, ... Example: 'TextBox'")
open var DataType:String? = null
/**
* Default value of the field. Example: '3'
*/
@ApiMember(Description="Default value of the field. Example: '3'")
open var DefaultValue:String? = null
/**
* Determines if the field is required to have a value or not
*/
@ApiMember(Description="Determines if the field is required to have a value or not")
open var IsMandatory:Boolean? = null
/**
* Error message shown to the user if the field data is required but not entered
*/
@ApiMember(Description="Error message shown to the user if the field data is required but not entered")
open var MandatoryErrorMessage:String? = null
/**
* Max lenght of the field
*/
@ApiMember(Description="Max lenght of the field")
open var MaxLength:Int? = null
/**
* If the field should have multiple lines
*/
@ApiMember(Description="If the field should have multiple lines")
open var MultipleLineText:Boolean? = null
/**
* Regular expression used for validation of the field
*/
@ApiMember(Description="Regular expression used for validation of the field")
open var RegEx:String? = null
/**
* Error message shown if the regular expression validation failed
*/
@ApiMember(Description="Error message shown if the regular expression validation failed")
open var RegExErrorMessage:String? = null
/**
* The values to select from if Datatype is DropDown for this custom field
*/
@ApiMember(Description="The values to select from if Datatype is DropDown for this custom field")
open var Values:ArrayList<CustomFieldValueResponse> = ArrayList<CustomFieldValueResponse>()
}
open class CustomFieldValueResponse
{
open var Value:String? = null
}
open class CustomFieldDataResponse
{
open var Id:Int? = null
open var Column:String? = null
open var Name:String? = null
open var Description:String? = null
open var Value:String? = null
/**
* Data field of custom field. Valid values are: TextBox, ... Example: 'TextBox'
*/
@ApiMember(Description="Data field of custom field. Valid values are: TextBox, ... Example: 'TextBox'")
open var DataType:String? = null
}
open class CustomerCommentsResponse
{
open var Id:Int? = null
open var CustomerId:UUID? = null
open var Comments:String? = null
open var Updated:Date? = null
open var Created:Date? = null
open var ImageUrl:Uri? = null
}
open class UserAccessKeys : BaseModel()
{
@Required()
open var CompanyId:UUID? = null
@Required()
open var AccessKeyTypeId:Int? = null
@Required()
open var Value:String? = null
@Required()
open var CustomerId:UUID? = null
open var Description:String? = null
@Required()
open var Id:UUID? = null
}
open class BaseModel
{
}
open class InvoiceAddressResponse
{
open var InvoiceAddressId:UUID? = null
open var UserId:UUID? = null
open var CorporateIdentityNumber:String? = null
open var InvoiceAddress1:String? = null
open var InvoiceAddress2:String? = null
open var InvoiceCity:String? = null
open var InvoicePostalCode:String? = null
open var InvoiceCountryCode:String? = 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
}
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 /customers/{CustomerId}/tags HTTP/1.1
Host: api.bookmore.com
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
CompanyId: 00000000-0000-0000-0000-000000000000,
TagIds:
[
0
]
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
Firstname: String,
Lastname: String,
Email: String,
Phone: String,
ImageUrl: String,
PersonalIdentityNumber: String,
CustomFields:
[
{
"Id": 0,
"Name": "String",
"Description": "String",
"Width": 0,
"DataType": "String",
"DefaultValue": "String",
"IsMandatory": false,
"MandatoryErrorMessage": "String",
"MaxLength": 0,
"MultipleLineText": false,
"RegEx": "String",
"RegExErrorMessage": "String",
"Values":
[
{
"Value": "String"
}
]
}
],
CustomFieldValues:
[
{
Id: 0,
Column: String,
Name: String,
Description: String,
Value: String,
DataType: String
}
],
Comments:
[
{
Id: 0,
Comments: String
}
],
AccessKeys:
[
{
AccessKeyTypeId: 0,
Value: String,
Description: String
}
],
ResponseStatus: {},
SubscribedToNewsletter: False,
InvoiceAddress:
{
UserId: 00000000-0000-0000-0000-000000000000,
CorporateIdentityNumber: String,
InvoiceAddress1: String,
InvoiceAddress2: String,
InvoiceCity: String,
InvoicePostalCode: String,
InvoiceCountryCode: String
},
Tags:
[
{
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
}
}
}
]
}