Antel API

<back to all web services

CheckPrincipals

Requires Authentication
The following routes are available for this service:
POST/principal/check
"use strict";
export class ApiServiceRequest {
    /** @param {{apiKey?:string,latitude?:number,longitude?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description The API Key required for authentication */
    apiKey;
    /**
     * @type {number}
     * @description Latitude of the user making this request */
    latitude;
    /**
     * @type {number}
     * @description Longitude of the user making this request */
    longitude;
}
export class ApiServiceResponse {
    /** @param {{description?:string,heading?:string,wasSuccessful?:boolean,responseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description Information about the response. */
    description;
    /**
     * @type {string}
     * @description Heading or summary of the response. */
    heading;
    /**
     * @type {boolean}
     * @description Did the intended operation for this response complete successfully? */
    wasSuccessful;
    /** @type {ResponseStatus} */
    responseStatus;
}
export class PrincipalAppSync {
    /** @param {{principalId?:number,lastUpdated?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    principalId;
    /** @type {string} */
    lastUpdated;
}
export class AuthRuleData {
    /** @param {{fromValue?:number,toValue?:number,allow?:boolean,delayedAuth?:boolean,authRequired?:boolean,channel?:string,region?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    fromValue;
    /** @type {number} */
    toValue;
    /** @type {boolean} */
    allow;
    /** @type {boolean} */
    delayedAuth;
    /** @type {boolean} */
    authRequired;
    /** @type {string} */
    channel;
    /** @type {string} */
    region;
}
export class PrincipalAuthRuleData {
    /** @param {{principalId?:number,valueAuthRules?:AuthRuleData[],unitAuthRules?:AuthRuleData[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    principalId;
    /** @type {AuthRuleData[]} */
    valueAuthRules;
    /** @type {AuthRuleData[]} */
    unitAuthRules;
}
export class CheckPrincipalsResponse extends ApiServiceResponse {
    /** @param {{principalsToUpdate?:number[],principalAppSyncData?:PrincipalAppSync[],authRules?:PrincipalAuthRuleData[],description?:string,heading?:string,wasSuccessful?:boolean,responseStatus?:ResponseStatus}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {number[]} */
    principalsToUpdate;
    /** @type {PrincipalAppSync[]} */
    principalAppSyncData;
    /** @type {PrincipalAuthRuleData[]} */
    authRules;
}
export class CheckPrincipals extends ApiServiceRequest {
    /** @param {{principals?:PrincipalAppSync[],apiKey?:string,latitude?:number,longitude?:number}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {PrincipalAppSync[]} */
    principals;
}

JavaScript CheckPrincipals DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

POST /principal/check HTTP/1.1 
Host: antel.api.dev.86degrees.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"principals":[{"principalId":0,"lastUpdated":"String"}],"apiKey":"String","latitude":0,"longitude":0}

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"principalsToUpdate":[0],"principalAppSyncData":[{"principalId":0,"lastUpdated":"String"}],"authRules":[{"principalId":0,"valueAuthRules":[{}],"unitAuthRules":[{}]}],"description":"String","heading":"String","wasSuccessful":false,"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}