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 Foundation
import ServiceStack

// @ValidateRequest(Validator="IsAuthenticated")
public class DeleteReference : ICompany, Codable
{
    /**
    * 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.")
    public var companyId:String?

    /**
    * Id of the reference
    */
    // @ApiMember(Description="Id of the reference", IsRequired=true, ParameterType="path")
    public var id:String

    required public init(){}
}

public class ReferenceQueryResponse : Codable
{
    public var companyId:String
    public var id:String
    public var ownerId:String
    public var referenceType:String
    public var referenceTypeId:Int
    public var externalData:String
    public var updated:Date
    public var created:Date
    public var createdBy:String
    public var updatedBy:String
    public var responseStatus:ResponseStatus

    required public init(){}
}


Swift DeleteReference DTOs

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

HTTP + OTHER

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/jsonl
HTTP/1.1 200 OK
Content-Type: text/jsonl
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"}}}