Antel API

<back to all web services

GetPrincipleAuthLetters

Requires Authentication
The following routes are available for this service:
GET/principal/authletters
ApiServiceRequest Parameters:
NameParameterData TypeRequiredDescription
ApiKeyformstringYesThe API Key required for authentication
LatitudeformdoubleNoLatitude of the user making this request
LongitudeformdoubleNoLongitude of the user making this request
GetPrincipleAuthLettersResponse Parameters:
NameParameterData TypeRequiredDescription
AuthLettersformList<PrincipleAuthLetterData>No
ApiServiceResponse Parameters:
NameParameterData TypeRequiredDescription
DescriptionformstringYesInformation about the response.
HeadingformstringYesHeading or summary of the response.
WasSuccessfulformbooleanYesDid the intended operation for this response complete successfully?
ResponseStatusformResponseStatusNo
PrincipleAuthLetterData Parameters:
NameParameterData TypeRequiredDescription
LogoformstringNo
AuthLetterformstringNo
PrincipleNameformstringNo
FileNameformstringNo

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

HTTP + CSV

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