Antel API

<back to all web services

CheckPrincipals

export class ApiServiceRequest implements IServiceRequest, IHasApiKey, IHasDeviceInfo
{
    /** @description The API Key required for authentication */
    // @ApiMember(DataType="string", Description="The API Key required for authentication", IsRequired=true)
    public apiKey: string;

    /** @description Latitude of the user making this request */
    // @ApiMember(DataType="double", Description="Latitude of the user making this request")
    public latitude: number;

    /** @description Longitude of the user making this request */
    // @ApiMember(DataType="double", Description="Longitude of the user making this request")
    public longitude: number;

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

export class ApiServiceResponse implements IServiceResponse
{
    /** @description Information about the response. */
    // @ApiMember(Description="Information about the response.", IsRequired=true)
    public description: string;

    /** @description Heading or summary of the response. */
    // @ApiMember(Description="Heading or summary of the response.", IsRequired=true)
    public heading: string;

    /** @description Did the intended operation for this response complete successfully? */
    // @ApiMember(DataType="boolean", Description="Did the intended operation for this response complete successfully?", IsRequired=true)
    public wasSuccessful: boolean;

    public responseStatus: ResponseStatus;

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

export class PrincipalAppSync
{
    public principalId: number;
    public lastUpdated: string;

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

export class AuthRuleData
{
    public fromValue: number;
    public toValue: number;
    public allow: boolean;
    public delayedAuth: boolean;
    public authRequired: boolean;
    public channel: string;
    public region: string;

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

export class PrincipalAuthRuleData
{
    public principalId: number;
    public valueAuthRules: AuthRuleData[];
    public unitAuthRules: AuthRuleData[];

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

export class CheckPrincipalsResponse extends ApiServiceResponse
{
    public principalsToUpdate: number[];
    public principalAppSyncData: PrincipalAppSync[];
    public authRules: PrincipalAuthRuleData[];

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

export class CheckPrincipals extends ApiServiceRequest
{
    public principals: PrincipalAppSync[];

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

TypeScript CheckPrincipals DTOs

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

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

HTTP/1.1 200 OK
Content-Type: text/csv
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"}}}