@lap v0.3
# Machine-readable API spec. Each @endpoint block is one API call.
@api Qualtrics API
@base https://fra1.qualtrics.com/API/v3
@version 0.2
@auth ApiKey X-API-TOKEN in header
@endpoints 8
@toc survey-definitions(1), distributions(3), directories(1), eventsubscriptions(3)

@group survey-definitions
@endpoint GET /survey-definitions/{SurveyId}
@required {SurveyId: any}
@returns(200)

@endgroup

@group distributions
@endpoint GET /distributions
@required {surveyId: any}
@returns(200)

@endpoint POST /distributions
@required {Distribution link generation options: map}
@returns(200)

@endpoint GET /distributions/{DistributionId}/links
@required {surveyId: any, DistributionId: any}
@returns(200)

@endgroup

@group directories
@endpoint POST /directories/{DirectoryId}/mailinglists/{MailingListId}/contacts
@required {DirectoryId: any, MailingListId: any, Contact data: map}
@returns(200)

@endgroup

@group eventsubscriptions
@endpoint POST /eventsubscriptions/
@required {WebHookData: map}
@returns(200)

@endpoint DELETE /eventsubscriptions/
@required {WebHookData: map}
@returns(200)

@endpoint GET /eventsubscriptions/{SubscriptionId}
@required {SubscriptionId: any}
@returns(200)

@endgroup

@end
