AIM Web Services

<back to all web services

GetCoursesRequest

GetCourses
Requires active-e Tee-Sheet Service

The following routes are available for this service:
GET/api/GetCourses
BaseRequest Parameters:
NameParameterData TypeRequiredDescription
ApiKeyheaderstringYesThis is your AIM API Key provided by Tri-Tech
OAuthTokenheaderstringNo
GetCoursesResponse Parameters:
NameParameterData TypeRequiredDescription
CoursesformList<CourseGeneric>No
BaseResponse Parameters:
NameParameterData TypeRequiredDescription
StatusbodyBaseResponseResultNo
BaseResponseResult Parameters:
NameParameterData TypeRequiredDescription
StatusCodebodystringNo
LoginbodystringNo
ErrorCodebodystringNo
ErrorDisplayTextbodystringNo
ErrorMessagebodystringNo
DomainNamebodystringNo
IpAddressbodystringNo
CourseGeneric Parameters:
NameParameterData TypeRequiredDescription
CourseformstringNo
CourseTopicformstringNo
LocationformstringNo
Has18HolesformboolNo
OnlineBufferformintNo

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

HTTP + XML

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

GET /api/GetCourses HTTP/1.1 
Host: active-ewebservice.biz 
Accept: application/xml

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

<GetCoursesResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AIM.WebService">
  <Status>
    <DomainName>String</DomainName>
    <ErrorCode>String</ErrorCode>
    <ErrorDisplayText>String</ErrorDisplayText>
    <ErrorMessage>String</ErrorMessage>
    <IpAddress>String</IpAddress>
    <Login>String</Login>
    <StatusCode>String</StatusCode>
  </Status>
  <Courses xmlns:d2p1="http://schemas.datacontract.org/2004/07/AIM">
    <d2p1:CourseGeneric>
      <d2p1:Course>String</d2p1:Course>
      <d2p1:CourseTopic>String</d2p1:CourseTopic>
      <d2p1:Has18Holes>false</d2p1:Has18Holes>
      <d2p1:Location>String</d2p1:Location>
      <d2p1:OnlineBuffer>0</d2p1:OnlineBuffer>
    </d2p1:CourseGeneric>
  </Courses>
</GetCoursesResponse>