BokaMera.API.Host

<back to all web services

WebhookSettingsRequest

Requires Authentication
The following routes are available for this service:
GET/webhook/settingsGet webhook feature settings.Get webhook feature settings.
import Foundation
import ServiceStack

public class WebhookSettingsRequest : 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.", IsRequired=true, ParameterType="query")
    public var companyId:String?

    required public init(){}
}

public class WebhookSettingsResponse : Codable
{
    public var enabled:Bool
    public var message:String
    public var companyId:String

    required public init(){}
}


Swift WebhookSettingsRequest 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.

GET /webhook/settings HTTP/1.1 
Host: api.bokamera.se 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<WebhookSettingsResponse 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>
  <Enabled>false</Enabled>
  <Message>String</Message>
</WebhookSettingsResponse>