Antel API

CheckPrincipals

The following routes are available for this service:
POST	/principal/check

using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using WebService.ServiceModel;
using WebService.ServiceModel.Base;

namespace WebService.ServiceModel
{
    public partial class AuthRuleData
    {
        public virtual double FromValue { get; set; }
        public virtual double ToValue { get; set; }
        public virtual bool Allow { get; set; }
        public virtual bool DelayedAuth { get; set; }
        public virtual bool AuthRequired { get; set; }
        public virtual string Channel { get; set; }
        public virtual string Region { get; set; }
    }

    public partial class CheckPrincipals
        : ApiServiceRequest
    {
        public CheckPrincipals()
        {
            Principals = new List<PrincipalAppSync>{};
        }

        public virtual List<PrincipalAppSync> Principals { get; set; }
    }

    public partial class CheckPrincipalsResponse
        : ApiServiceResponse
    {
        public CheckPrincipalsResponse()
        {
            PrincipalsToUpdate = new List<int>{};
            PrincipalAppSyncData = new List<PrincipalAppSync>{};
            AuthRules = new List<PrincipalAuthRuleData>{};
        }

        public virtual List<int> PrincipalsToUpdate { get; set; }
        public virtual List<PrincipalAppSync> PrincipalAppSyncData { get; set; }
        public virtual List<PrincipalAuthRuleData> AuthRules { get; set; }
    }

    public partial class PrincipalAppSync
    {
        public virtual int PrincipalId { get; set; }
        public virtual string LastUpdated { get; set; }
    }

    public partial class PrincipalAuthRuleData
    {
        public PrincipalAuthRuleData()
        {
            ValueAuthRules = new List<AuthRuleData>{};
            UnitAuthRules = new List<AuthRuleData>{};
        }

        public virtual int PrincipalId { get; set; }
        public virtual List<AuthRuleData> ValueAuthRules { get; set; }
        public virtual List<AuthRuleData> UnitAuthRules { get; set; }
    }

}

namespace WebService.ServiceModel.Base
{
    public partial class ApiServiceRequest
        : IServiceRequest, IHasApiKey, IHasDeviceInfo
    {
        ///<summary>
        ///The API Key required for authentication
        ///</summary>
        [ApiMember(DataType="string", Description="The API Key required for authentication", IsRequired=true)]
        public virtual string ApiKey { get; set; }

        ///<summary>
        ///Latitude of the user making this request
        ///</summary>
        [ApiMember(DataType="double", Description="Latitude of the user making this request")]
        public virtual double Latitude { get; set; }

        ///<summary>
        ///Longitude of the user making this request
        ///</summary>
        [ApiMember(DataType="double", Description="Longitude of the user making this request")]
        public virtual double Longitude { get; set; }
    }

    public partial class ApiServiceResponse
        : IServiceResponse
    {
        ///<summary>
        ///Information about the response.
        ///</summary>
        [ApiMember(Description="Information about the response.", IsRequired=true)]
        public virtual string Description { get; set; }

        ///<summary>
        ///Heading or summary of the response.
        ///</summary>
        [ApiMember(Description="Heading or summary of the response.", IsRequired=true)]
        public virtual string Heading { get; set; }

        ///<summary>
        ///Did the intended operation for this response complete successfully?
        ///</summary>
        [ApiMember(DataType="boolean", Description="Did the intended operation for this response complete successfully?", IsRequired=true)]
        public virtual bool WasSuccessful { get; set; }

        public virtual ResponseStatus ResponseStatus { get; set; }
    }

}

C# CheckPrincipals DTOs

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

HTTP + OTHER

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: text/jsonl
Content-Type: text/jsonl
Content-Length: length

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

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