BokaMera.API.Host

<back to all web services

DeleteReference

Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, superadmin, SuperAdminVisma
The following routes are available for this service:
DELETE/references/{CompanyId}/{Id}Delete a referenceDelete a reference
import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*


@ValidateRequest(Validator="IsAuthenticated")
open class DeleteReference : 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

    /**
    * Id of the reference
    */
    @ApiMember(Description="Id of the reference", IsRequired=true, ParameterType="path")
    open var Id:UUID? = null
}

open class ReferenceQueryResponse
{
    open var CompanyId:UUID? = null
    open var Id:UUID? = null
    open var OwnerId:UUID? = null
    open var ReferenceType:String? = null
    open var ReferenceTypeId:Int? = null
    open var ExternalData:String? = null
    open var Updated:Date? = null
    open var Created:Date? = null
    open var CreatedBy:String? = null
    open var UpdatedBy:String? = null
    open var ResponseStatus:ResponseStatus? = null
}

Kotlin DeleteReference 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.

DELETE /references/{CompanyId}/{Id} HTTP/1.1 
Host: api.bokamera.se 
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"ReferenceType":"String","ReferenceTypeId":0,"ExternalData":"String","CreatedBy":"String","UpdatedBy":"String","ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}