Antel API

<back to all web services

GetPrincipleAuthLetters

Requires Authentication
The following routes are available for this service:
GET/principal/authletters
import java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    public static class GetPrincipleAuthLetters extends ApiServiceRequest
    {
        
    }

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

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

        /**
        * Longitude of the user making this request
        */
        @ApiMember(DataType="double", Description="Longitude of the user making this request")
        public Double longitude = null;
        
        public String getApiKey() { return apiKey; }
        public ApiServiceRequest setApiKey(String value) { this.apiKey = value; return this; }
        public Double getLatitude() { return latitude; }
        public ApiServiceRequest setLatitude(Double value) { this.latitude = value; return this; }
        public Double getLongitude() { return longitude; }
        public ApiServiceRequest setLongitude(Double value) { this.longitude = value; return this; }
    }

    public static class GetPrincipleAuthLettersResponse extends ApiServiceResponse
    {
        public ArrayList<PrincipleAuthLetterData> authLetters = null;
        
        public ArrayList<PrincipleAuthLetterData> getAuthLetters() { return authLetters; }
        public GetPrincipleAuthLettersResponse setAuthLetters(ArrayList<PrincipleAuthLetterData> value) { this.authLetters = value; return this; }
    }

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

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

        /**
        * 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 Boolean wasSuccessful = null;

        public ResponseStatus responseStatus = null;
        
        public String getDescription() { return description; }
        public ApiServiceResponse setDescription(String value) { this.description = value; return this; }
        public String getHeading() { return heading; }
        public ApiServiceResponse setHeading(String value) { this.heading = value; return this; }
        public Boolean isWasSuccessful() { return wasSuccessful; }
        public ApiServiceResponse setWasSuccessful(Boolean value) { this.wasSuccessful = value; return this; }
        public ResponseStatus getResponseStatus() { return responseStatus; }
        public ApiServiceResponse setResponseStatus(ResponseStatus value) { this.responseStatus = value; return this; }
    }

    public static class PrincipleAuthLetterData
    {
        public String logo = null;
        public String authLetter = null;
        public String principleName = null;
        public String fileName = null;
        
        public String getLogo() { return logo; }
        public PrincipleAuthLetterData setLogo(String value) { this.logo = value; return this; }
        public String getAuthLetter() { return authLetter; }
        public PrincipleAuthLetterData setAuthLetter(String value) { this.authLetter = value; return this; }
        public String getPrincipleName() { return principleName; }
        public PrincipleAuthLetterData setPrincipleName(String value) { this.principleName = value; return this; }
        public String getFileName() { return fileName; }
        public PrincipleAuthLetterData setFileName(String value) { this.fileName = value; return this; }
    }

}

Java GetPrincipleAuthLetters 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.

GET /principal/authletters HTTP/1.1 
Host: antel.api.dev.86degrees.com 
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"authLetters":[{"logo":"String","authLetter":"String","principleName":"String","fileName":"String"}],"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"}}}