BokaMera.API.Host

<back to all web services

AccessyCodelockCallback

The following routes are available for this service:
POST/codelock/accessy/callback
"use strict";
/** @typedef {'Unknown'|'MEMBERSHIP_CREATED'|'MEMBERSHIP_REMOVED'} */
export var AccessyEvent;
(function (AccessyEvent) {
    AccessyEvent["Unknown"] = "Unknown"
    AccessyEvent["MEMBERSHIP_CREATED"] = "MEMBERSHIP_CREATED"
    AccessyEvent["MEMBERSHIP_REMOVED"] = "MEMBERSHIP_REMOVED"
})(AccessyEvent || (AccessyEvent = {}));
export class AccessyCodelockCallback {
    /** @param {{EventType?:AccessyEvent,InvitationId?:string,UserId?:string,OrganizationId?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {AccessyEvent} */
    EventType;
    /** @type {string} */
    InvitationId;
    /** @type {string} */
    UserId;
    /** @type {string} */
    OrganizationId;
}
/** @typedef {number} */
export var CacheControl;
(function (CacheControl) {
    CacheControl[CacheControl["None"] = 0] = "None"
    CacheControl[CacheControl["Public"] = 1] = "Public"
    CacheControl[CacheControl["Private"] = 2] = "Private"
    CacheControl[CacheControl["MustRevalidate"] = 4] = "MustRevalidate"
    CacheControl[CacheControl["NoCache"] = 8] = "NoCache"
    CacheControl[CacheControl["NoStore"] = 16] = "NoStore"
    CacheControl[CacheControl["NoTransform"] = 32] = "NoTransform"
    CacheControl[CacheControl["ProxyRevalidate"] = 64] = "ProxyRevalidate"
})(CacheControl || (CacheControl = {}));
/** @typedef {number} */
export var RequestAttributes;
(function (RequestAttributes) {
    RequestAttributes[RequestAttributes["None"] = 0] = "None"
    RequestAttributes[RequestAttributes["Localhost"] = 1] = "Localhost"
    RequestAttributes[RequestAttributes["LocalSubnet"] = 2] = "LocalSubnet"
    RequestAttributes[RequestAttributes["External"] = 4] = "External"
    RequestAttributes[RequestAttributes["Secure"] = 8] = "Secure"
    RequestAttributes[RequestAttributes["InSecure"] = 16] = "InSecure"
    RequestAttributes[RequestAttributes["AnySecurityMode"] = 24] = "AnySecurityMode"
    RequestAttributes[RequestAttributes["HttpHead"] = 32] = "HttpHead"
    RequestAttributes[RequestAttributes["HttpGet"] = 64] = "HttpGet"
    RequestAttributes[RequestAttributes["HttpPost"] = 128] = "HttpPost"
    RequestAttributes[RequestAttributes["HttpPut"] = 256] = "HttpPut"
    RequestAttributes[RequestAttributes["HttpDelete"] = 512] = "HttpDelete"
    RequestAttributes[RequestAttributes["HttpPatch"] = 1024] = "HttpPatch"
    RequestAttributes[RequestAttributes["HttpOptions"] = 2048] = "HttpOptions"
    RequestAttributes[RequestAttributes["HttpOther"] = 4096] = "HttpOther"
    RequestAttributes[RequestAttributes["AnyHttpMethod"] = 8160] = "AnyHttpMethod"
    RequestAttributes[RequestAttributes["OneWay"] = 8192] = "OneWay"
    RequestAttributes[RequestAttributes["Reply"] = 16384] = "Reply"
    RequestAttributes[RequestAttributes["AnyCallStyle"] = 24576] = "AnyCallStyle"
    RequestAttributes[RequestAttributes["Soap11"] = 32768] = "Soap11"
    RequestAttributes[RequestAttributes["Soap12"] = 65536] = "Soap12"
    RequestAttributes[RequestAttributes["Xml"] = 131072] = "Xml"
    RequestAttributes[RequestAttributes["Json"] = 262144] = "Json"
    RequestAttributes[RequestAttributes["Jsv"] = 524288] = "Jsv"
    RequestAttributes[RequestAttributes["ProtoBuf"] = 1048576] = "ProtoBuf"
    RequestAttributes[RequestAttributes["Csv"] = 2097152] = "Csv"
    RequestAttributes[RequestAttributes["Html"] = 4194304] = "Html"
    RequestAttributes[RequestAttributes["Jsonl"] = 8388608] = "Jsonl"
    RequestAttributes[RequestAttributes["MsgPack"] = 16777216] = "MsgPack"
    RequestAttributes[RequestAttributes["FormatOther"] = 33554432] = "FormatOther"
    RequestAttributes[RequestAttributes["AnyFormat"] = 67076096] = "AnyFormat"
    RequestAttributes[RequestAttributes["Http"] = 67108864] = "Http"
    RequestAttributes[RequestAttributes["MessageQueue"] = 134217728] = "MessageQueue"
    RequestAttributes[RequestAttributes["Tcp"] = 268435456] = "Tcp"
    RequestAttributes[RequestAttributes["Grpc"] = 536870912] = "Grpc"
    RequestAttributes[RequestAttributes["EndpointOther"] = 1073741824] = "EndpointOther"
    RequestAttributes[RequestAttributes["AnyEndpoint"] = 2080374784] = "AnyEndpoint"
    RequestAttributes[RequestAttributes["InProcess"] = -2147483648] = "InProcess"
    RequestAttributes[RequestAttributes["InternalNetworkAccess"] = -2147483645] = "InternalNetworkAccess"
    RequestAttributes[RequestAttributes["AnyNetworkAccessType"] = -2147483641] = "AnyNetworkAccessType"
    RequestAttributes[RequestAttributes["Any"] = -1] = "Any"
})(RequestAttributes || (RequestAttributes = {}));
export class HttpResult {
    /** @param {{ResponseText?:string,ResponseStream?:string,FileInfo?:FileInfo,VirtualFile?:IVirtualFile,ContentType?:string,Headers?:{ [index: string]: string; },Cookies?:Cookie[],ETag?:string,Age?:string,MaxAge?:string,Expires?:string,LastModified?:string,CacheControl?:CacheControl,ResultScope?:Func<IDisposable>,AllowsPartialResponse?:boolean,Options?:{ [index: string]: string; },Status?:number,StatusCode?:HttpStatusCode,StatusDescription?:string,Response?:Object,ResponseFilter?:IContentTypeWriter,RequestContext?:IRequest,View?:string,Template?:string,PaddingLength?:number,IsPartialRequest?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    ResponseText;
    /** @type {string} */
    ResponseStream;
    /** @type {FileInfo} */
    FileInfo;
    /** @type {IVirtualFile} */
    VirtualFile;
    /** @type {string} */
    ContentType;
    /** @type {{ [index: string]: string; }} */
    Headers;
    /** @type {Cookie[]} */
    Cookies;
    /** @type {string} */
    ETag;
    /** @type {?string} */
    Age;
    /** @type {?string} */
    MaxAge;
    /** @type {?string} */
    Expires;
    /** @type {?string} */
    LastModified;
    /** @type {CacheControl} */
    CacheControl;
    /** @type {Func<IDisposable>} */
    ResultScope;
    /** @type {boolean} */
    AllowsPartialResponse;
    /** @type {{ [index: string]: string; }} */
    Options;
    /** @type {number} */
    Status;
    /** @type {HttpStatusCode} */
    StatusCode;
    /** @type {string} */
    StatusDescription;
    /** @type {Object} */
    Response;
    /** @type {IContentTypeWriter} */
    ResponseFilter;
    /** @type {IRequest} */
    RequestContext;
    /** @type {string} */
    View;
    /** @type {string} */
    Template;
    /** @type {number} */
    PaddingLength;
    /** @type {boolean} */
    IsPartialRequest;
}

JavaScript AccessyCodelockCallback DTOs

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

HTTP + JSV

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

POST /codelock/accessy/callback HTTP/1.1 
Host: api.bokamera.se 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	EventType: Unknown
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	
}