BokaMera.API.Host

<back to all web services

AddSupportCaseAttachment

Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, superadmin
The following routes are available for this service:
POST/support/cases/{Id}/attachmentsAdd a new support case commentAdd a new support case attachment as image to the support case with the prvoided id for the currently logged in user, only administrators are allowed to add support cases.
import 'package:servicestack/servicestack.dart';

class SupportCaseAttachmentResponse implements IConvertible
{
    /**
    * The attachment id
    */
    // @ApiMember(Description="The attachment id")
    int? Id;

    /**
    * The attachment file url
    */
    // @ApiMember(Description="The attachment file url")
    String? FileUrl;

    SupportCaseAttachmentResponse({this.Id,this.FileUrl});
    SupportCaseAttachmentResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Id = json['Id'];
        FileUrl = json['FileUrl'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'Id': Id,
        'FileUrl': FileUrl
    };

    getTypeName() => "SupportCaseAttachmentResponse";
    TypeContext? context = _ctx;
}

// @ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
// @ApiResponse(Description="You have too low privilegies to call this service", StatusCode=403)
// @ValidateRequest(Validator="IsAuthenticated")
class AddSupportCaseAttachment implements ISupportCase, IConvertible
{
    /**
    * Enter the company id, if blank company id and you are an admin, your company id will be used.
    */
    // @ApiMember(Description="Enter the company id, if blank company id and you are an admin, your company id will be used.", IsRequired=true)
    String? CompanyId;

    /**
    * The support case id
    */
    // @ApiMember(Description="The support case id", ParameterType="path")
    int? Id;

    /**
    * The case attachment url. Only images are allowed to attach.
    */
    // @ApiMember(Description="The case attachment url. Only images are allowed to attach.")
    String? FileUrl;

    AddSupportCaseAttachment({this.CompanyId,this.Id,this.FileUrl});
    AddSupportCaseAttachment.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        CompanyId = json['CompanyId'];
        Id = json['Id'];
        FileUrl = json['FileUrl'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'CompanyId': CompanyId,
        'Id': Id,
        'FileUrl': FileUrl
    };

    getTypeName() => "AddSupportCaseAttachment";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'api.bokamera.se', types: <String, TypeInfo> {
    'SupportCaseAttachmentResponse': TypeInfo(TypeOf.Class, create:() => SupportCaseAttachmentResponse()),
    'AddSupportCaseAttachment': TypeInfo(TypeOf.Class, create:() => AddSupportCaseAttachment()),
});

Dart AddSupportCaseAttachment DTOs

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

HTTP + XML

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

POST /support/cases/{Id}/attachments HTTP/1.1 
Host: api.bokamera.se 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<AddSupportCaseAttachment xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
  <FileUrl>String</FileUrl>
  <Id>0</Id>
</AddSupportCaseAttachment>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<SupportCaseAttachmentResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <FileUrl>String</FileUrl>
  <Id>0</Id>
</SupportCaseAttachmentResponse>