swagger: '2.0' ################################################################################ # API Information # ################################################################################ info: version: "v1" title: REST API for WordPress Astound Integration description: API endpoints for integration with the SalesForce Portal host: ultherapy-wpprod.m3rzd3v.com basePath: /wp-json ################################################################################ # Paths # ################################################################################ paths: /events/get: get: summary: Get all published events, filtered by input consumes: - application/json produces: - application/json parameters: - in: header name: brandID type: string description: The brandID whose events should be returned. Allowed values are "Cellfina" & "Ultherapy" currently. If no value is passed, events will not be filtered by this parameter. required: false - in: header name: accountID type: string description: The Account ID of whose events should be returned required: false responses: 200: description: All relevant events returned schema: $ref: '#/definitions/Event' /events/get/{id}: get: summary: Get a specific event consumes: - application/json produces: - application/json parameters: - in: path name: id type: string description: The id of the specific event to be returned. required: true responses: 200: description: The specific event to be returned schema: $ref: '#/definitions/Event' /events/create: post: summary: Create a new event in the Wordpress wite consumes: - application/json produces: - application/json parameters: - in: body name: data description: post data body required: true schema: $ref: '#/definitions/Event' responses: 200: description: Will return the url of the event after it has been created. /events/update: put: summary: Update an existing event in the Wordpress system consumes: - application/json produces: - application/json parameters: - in: body name: data description: post data body required: true schema: $ref: '#/definitions/Event' responses: 200: description: Will return the url of the event after it has been created. /templates/get: get: summary: gets all landing pages, filtered by parameters consumes: - application/json produces: - application/json parameters: - in: header name: brandId type: string description: The brand whose landing pages should be returned required: false - in: header name: type type: string description: The type of template that should be returned required: false responses: 200: description: All relevant landing pages returned schema: $ref: '#/definitions/LandingPage' /templates/get/{id}: get: summary: Get a specific landing page consumes: - application/json produces: - application/json parameters: - in: path name: id type: string description: The id of the specific landing page to be returned. required: true responses: 200: description: The specific event to be returned schema: $ref: '#/definitions/LandingPage' /landingpages/get: get: summary: gets all landing pages, filtered by parameters consumes: - application/json produces: - application/json parameters: - in: header name: brand type: string description: The brand whose landing pages should be returned required: false - in: header name: sap_id type: string description: The SAP ID of whose landing pages should be returned required: false responses: 200: description: All relevant landing pages returned schema: $ref: '#/definitions/LandingPage' /landingpages/get/{id}: get: summary: Get a specific landing page consumes: - application/json produces: - application/json parameters: - in: path name: id type: string description: The id of the specific landing page to be returned. required: true responses: 200: description: The specific event to be returned schema: $ref: '#/definitions/LandingPage' /landingpages/config: get: summary: Get the possible layouts for landing pages consumes: - application/json produces: - application/json parameters: - in: header name: brand type: string description: The brand whose event templates should be returned required: false responses: 200: description: All relevant event templates returned schema: $ref: '#/definitions/Template' /landingpages/create: post: summary: Create a new landing page in the Wordpress site consumes: - application/json produces: - application/json parameters: - in: body name: data description: post data body required: true schema: $ref: '#/definitions/LandingPage' responses: 200: description: Will return the url of the landing page after it has been created. /landingpages/update: put: summary: Update an existing landing page in the Wordpress system consumes: - application/json produces: - application/json parameters: - in: body name: data description: post data body required: true schema: $ref: '#/definitions/LandingPage' responses: 200: description: Will return the url of the landing page after it has been created. definitions: Event: type: object properties: id: type: string description: The guid of the event accountID: type: string description: The account ID of the user (required) template: type: string description: The template used to display the event (required) status: type: string description: The status of the event. Valid options are "Publish", "Cancelled", "Draft". Default is publish brandID: type: string description: The brand associated with the event (required) practiceName: type: string description: The name of the practice practiceLogo: type: string description: The logo of the practice practiceWebsite: type: string description: The website for the practice practiceAddress1: type: string description: The street address of the practice practiceAddress2: type: string description: The street address2 of the practice (e.g. apartment/suite number) practiceCity: type: string description: The city where the practice is located practiceState: type: string description: The state where the practice is located practicePostalCode: type: string description: The postal_code where the practice is located practicePhoneNumber: type: string description: The phone number of the practice eventTitle: type: string description: The title of the event (required) eventStartDate: type: string description: The start date of the event, formatted in unixtime (required) eventEndDate: type: string description: The end date of the event, formatted in unixtime (required) eventTimezone: type: string description: Timezone for which the event will take place eventDetails: type: string description: Description of the event eventLocationName: type: string description: The name of the location where the event will be held at (e.g. if the event is held at a hotel or similar venue, the name of the hotel/venue) eventAddress1: type: string description: The street address of the location eventAddress2: type: string description: The street address2 of the location (e.g. apartment/suite number) eventCity: type: string description: The city where the event will take place eventState: type: string description: The state where the event will take place eventPostalCode: type: string description: The postal_code where the event will take place eventWebsite: type: string description: The website for the event practiceName: type: string description: The name of the practice holding the event (required) practiceLogo: type: string description: A base64 encoding of file contents practiceWebsite: type: string description: The website of the practice holding the event rsvpPhoneNumber: type: string description: The phone number of the contact person for the event rsvpEmailAddress: type: string description: The email address of the contact person for the event promotionalOpportunity: type: string description: The promotional opportunity that will happen at the event promotionalOpportunity2: type: string description: The second paragraph of the promotional opportunity section promotionalOpportunity3: type: string description: The third paragraph of the promotional opportunity section eventAttendance: type: string description: The number of people expected to attend the event vanityUrl: type: string description: The unique url that links directly to the event Template: type: object properties: id: type: string description: The guid of the template name: type: string description: The name of the template description: type: string description: The description of the template templateImage: type: string description: The url of the representative image for the template templateWidgetSmall: type: string description: the url of the 100x100 widget for the template templateWidgetMedium: type: string description: the url of the 250x250 widget for the template templateWidgetLarge: type: string description: the url of the 500x500 widget for the template LandingPage: type: object properties: id: type: string description: The guid of the landing page brandID: type: string description: The brand associated with the landing page template: type: string description: The template which will display the landing page accountID: type: string description: The Account ID of the user who created the landing page contactName: type: string description: The name of the contact practiceName: type: string description: The name of the practice for the landing page physicianName: type: string description: The name of the physician for the landing page practiceAddress1: type: string description: The street address of the practice practiceAddress2: type: string description: The street address2 of the practice (e.g. apartment/suite number) practiceCity: type: string description: The city where the practice is located practiceState: type: string description: The state where the practice will take place practicePostalCode: type: string description: The postal_code of the practice will take place practiceLogo: type: string description: A base64 encoding of file contents practiceWebsite: type: string description: A well formatted URL, including http:// of the practice's website practicePhone: type: string description: The phone number of the practice promotionalOpportunity: type: string description: The promotional opportunity of the practice facebookUrl: type: string description: The facebook url of the practice. example - http://www.facebook.com/test-page vanityUrl: type: string description: a custom url for users to set