BokaMera.API.Host

<back to all web services

WebhookCreateAgreement

The following routes are available for this service:
POST/webhooks/termsWebhook from prismic

export class WebhookAgreements
{
    public id: string;
    public label: string;
    public documents: string[];

    public constructor(init?: Partial<WebhookAgreements>) { (Object as any).assign(this, init); }
}

export class Releases
{
    public deletion: WebhookAgreements[];

    public constructor(init?: Partial<Releases>) { (Object as any).assign(this, init); }
}

// @ApiResponse(Description="Returned if there is a validation error on the input parameters", StatusCode=400)
// @ApiResponse(Description="Returned if the current user is not allowed to perform the action", StatusCode=401)
export class WebhookCreateAgreement
{
    public releases: Releases;
    public documents: string[];
    public secret: string;

    public constructor(init?: Partial<WebhookCreateAgreement>) { (Object as any).assign(this, init); }
}

TypeScript WebhookCreateAgreement 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 /webhooks/terms HTTP/1.1 
Host: api.bokamera.se 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<WebhookCreateAgreement xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <documents xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </documents>
  <releases>
    <deletion>
      <WebhookAgreements>
        <documents xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:string>String</d5p1:string>
        </documents>
        <id>String</id>
        <label>String</label>
      </WebhookAgreements>
    </deletion>
  </releases>
  <secret>String</secret>
</WebhookCreateAgreement>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<z:anyType xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns:z="http://schemas.microsoft.com/2003/10/Serialization/" />