API Services

Overview

Welcome to the API Services tab, where you will find comprehensive documentation for services that facilitate seamless integration and link retrieval within the Prismm API. These services are designed to enhance your occasion by providing direct access to crucial information related to occasions and floorplans.

Getting Occasions List

This API endpoint allows you to get a list of occasions for a specified year within the Prismm platform.

Endpoint

GET https://prod.prismm.com/prismm-api/occasions

Input

To get a list of occasions, include the following query parameters.

Query Parameters

• userID* (required): ObjectID representing the authenticated user. This ID is obtained when the user connects their account to the Prismm platform.
• offset (optional): Specifies the number of occasions to skip before beginning to return results.
• limit (optional): Sets the number of occasions to return. Default is 10, with a maximum of 25.
• year (optional): Numeric year to filter occasions. If not provided, only future events will be displayed.

Example Request

GET https://prod.prismm.com/prismm-api/occasions?year=2024&userID=60d21b4667d0d8992e610c85

Request Headers

Set the following header for the request:

• Content-type: application/json

Response Example

Upon successful execution, the API will return a JSON response with the list of occasions for the specified year or future events if the year is not provided.

{
  "IsError": 0,
  "ErrorCode": 0,
  "ErrorMessage": "",
  "OccasionsList": [
    {
      "id": 277865,
      "name": "Alex's Wedding",
      "type": "Wedding",
      "createdBy": {
        "name": "Alex Johnson",
        "email": "alex@mail.com"
      },
      "date": "2023-05-02T00:00:00.000Z"
    }
  ]
}

Getting Single Occasion

This API endpoint allows you to retrieve detailed information about a single occasion on the Prismm platform.

Endpoint

GET https://prod.prismm.com/prismm-api/occasions/{occasionId}

Input

To retrieve a specific occasion, include the following path and query parameters:

Path Parameters

• occasionId* (required): The unique ID of the occasion you want to retrieve.

Query Parameters

• userID* (required): ObjectID representing the authenticated user. This ID is obtained when the user connects their account to the Prismm platform.
• editing (optional): Boolean value to indicate if the link for editing of occasion should be included. Default is false.

Example Request

GET https://prod.prismm.com/prismm-api/occasions/277865?userID=60d21b4667d0d8992e610c85

Request Headers

Include the following header in the request:

• Content-type: application/json

Response Example

Upon successful execution, the API will return a JSON response with the details of the specified occasion.

{
  "Occasion": {
    "id": 277865,
    "name": "Alex's Wedding",
    "type": "Wedding",
    "createdBy": {
      "name": "Alex Johnson",
      "email": "alex@mail.com"
    },
    "link": "https://ops.prismm.com?CT2=8726272923424249", // will be included only on editing=true
    "date": "2023-05-02T00:00:00.000Z"
  },
  "IsError": 0,
  "ErrorCode": 0,
  "ErrorMessage": ""
}

Getting Floorplans for a Single Occasion

This API endpoint retrieves a list of floorplans associated with a specified occasion on the Prismm platform.

Endpoint

GET https://prod.prismm.com/prismm-api/occasions/{occasionId}/floorplans

Input

To retrieve floorplans for a specific occasion, include the following path and query parameters:

Path Parameters

• occasionId* (required): The unique ID of the occasion for which you want to retrieve floorplans.

Query Parameters

• userID* (required): ObjectID representing the authenticated user. This ID is obtained when the user connects their account to the Prismm platform.

Example Request

GET https://prod.prismm.com/prismm-api/occasions/277865/floorplans?userID=60d21b4667d0d8992e610c85

Request Headers

Include the following header in the request:

• Content-type: application/json

Response Example

Upon successful execution, the API will return a JSON response with the list of floorplans associated with the specified occasion.

{
  "IsError": 0,
  "ErrorCode": 0,
  "ErrorMessage": "",
  "FloorPlans": [
    {
      "id": 1,
      "name": "Main Hall",
      "hallId": 100,
      "isShared": true,
      "img": {
        "asset_id": "a1b2c3d4e5f6g7h8i9j0",
        "public_id": "2dsnapshots/277865/main_hall",
        "format": "jpg",
        "version": 1726665708,
        "resource_type": "image",
        "type": "upload",
        "created_at": "2024-09-18T13:21:48Z",
        "bytes": 42798,
        "width": 1293,
        "height": 803,
        "folder": "2dsnapshots/277865",
        "access_mode": "public",
        "url": "http://allseated-res.cloudinary.com/image/upload/v1726665708/2dsnapshots/277865/main_hall.jpg",
        "secure_url": "https://allseated-res.cloudinary.com/image/upload/v1726665708/2dsnapshots/277865/main_hall.jpg",
        "next_cursor": "592807a60f919b4798d15b7c36c1fdfad7214b6cd979bf87ac90b35ad6cab92e",
        "derived": [],
        "rate_limit_allowed": 5000,
        "rate_limit_reset_at": "2024-11-04T05:00:00.000Z",
        "rate_limit_remaining": 4999
      }
    },
    {
      "id": 2,
      "name": "Conference Room",
      "hallId": 101,
      "isShared": false,
      "img": {
        "asset_id": "b2c3d4e5f6g7h8i9j0k1",
        "public_id": "2dsnapshots/277865/conference_room",
        "format": "jpg",
        "version": 1725871194,
        "resource_type": "image",
        "type": "upload",
        "created_at": "2024-09-09T08:39:54Z",
        "bytes": 13780,
        "width": 1485,
        "height": 783,
        "folder": "2dsnapshots/277865",
        "access_mode": "public",
        "url": "http://allseated-res.cloudinary.com/image/upload/v1725871194/2dsnapshots/277865/conference_room.jpg",
        "secure_url": "https://allseated-res.cloudinary.com/image/upload/v1725871194/2dsnapshots/277865/conference_room.jpg",
        "next_cursor": "e7e338795035488fa4cfdab84e3ba07972b2df7db49cd70f0c5d067bde2d6b75",
        "derived": [],
        "rate_limit_allowed": 5000,
        "rate_limit_reset_at": "2024-11-04T05:00:00.000Z",
        "rate_limit_remaining": 4999
      }
    }
  ]
}

Getting a Shareable Link

This API endpoint allows you to get a shareable link for an occasion within the Prismm platform.

Endpoint

GET http://prod.prismm.com/prismm-api/shareable-link

Input

The input for getting a shareable link should be provided as query parameters.

Query Parameters

• userID: ObjectID representing the authenticated user.
• occasion-id: Numeric ID of the occasion.

Example Request

GET http://prod.prismm.com/prismm-api/shareable-link?userID=60d21b4667d0d8992e610c85&occasion-id=456

Request Headers

Set the following header for the request:

• Content-type: application/json

Response Example

Upon successful execution, the API will return a JSON response with the following structure:

{
  "IsError": 0,
  "ErrorCode": 0,
  "ErrorMessage": "",
  "Link": "https://venue.prismm.com/?extluid=2eae40c9-7a87-4898-9375-50b287e08b7e"
}

• Link: The shareable link for the specified occasion.

Note: In case of errors, an appropriate error message and code will be provided in the response. Refer to error code documentation for troubleshooting.

Creating a New Occasion

This API endpoint allows you to create a new occasion within the Prismm platform.

Endpoint

POST http://prod.prismm.com/prismm-api/newOccasion

Input

The input for creating a new occasion should be provided in JSON format.

Request Payload

{
  "user": "User Token",
  "name": "Occasion Name",
  "date": "Occasion Date",
  "type": "Occasion Type",
  "guests": "Number of Guests"
}

• user: User token representing the authenticated user.
• name: Name of the occasion.
• date: Date of the occasion.
• type: Type of the occasion (choose the respective number from the available occasion types listed below).
• guests: Number of guests expected.

Available Occasion Types

• Wedding = 1
• Corporate = 2
• Not-for-Profit = 3
• Bar/Bat Mitzvah = 4
• Dinner Party = 5
• Other = 6

Example JSON Data

{
  "user": "7FE70488-E501-43FE-8896-87305EFD9070",
  "name": "my Wedding",
  "date": "22-10-2016",
  "type": "1",
  "guests": 400
}

Request Headers

Set the following header for the request:

• Content-type: application/json

Response Example

Upon successful execution, the API will return a JSON response with the following structure:

{
  "ERRORSTRING": "",
  "ERRORCODE": 0,
  "OccasionId": "7542"
}

• ERRORSTRING: An empty string indicating no error.
• ERRORCODE: An error code; 0 denotes no error.
• OccasionId: The unique identifier assigned to the newly created occasion.

Feel free to use the generated OccasionId for further interactions with this specific occasion in the system.

Note: In case of errors, the ERRORCODE and ERRORSTRING fields will provide information about the encountered issue. Refer to error code documentation for troubleshooting.

Search For Your Venue

The venue search service allows you to search for venues based on a provided text string.

Search Venue Request

URL

POST http://prod.prismm.com/prismm-api/searchVenues

Input

The data should be passed as a JSON string with a POST method.

Request Payload

{
    "user": "User Token",
    "searchstring": "Search String"
}

• user: User token representing the authenticated user.
• searchstring: Text string used for searching venues.

Example JSON Data

{
    "user": "7FE70488-E501-43FE-8896-87305EFD9070",
    "searchstring": "DJ max"
}

Request Headers

Set the following header for the request:

• Content-type: application/json

Search Venue Response

The response provides information about the search results.

Response Structure

{
    "ERRORSTRING": "",
    "ERRORCODE": 0,
    "VenuesArray": '[{"Country":"Israel","City":"Arad","Address":"Zik 29","State":"","Id":161,"IsAllowInvite":0,"Name":"Venue 1"}]'
}

• ERRORSTRING: The error message (empty string if no error).
• ERRORCODE: The error code (0 if no error).
• VenuesArray: An array of venues matching the search criteria.

Response Example

{
    "ERRORSTRING": "",
    "ERRORCODE": 0,
    "VenuesArray": '[{"Country":"Israel","City":"Arad","Address":"Zik 29","State":"","Id":161,"IsAllowInvite":0,"Name":"Venue 1"}]'
}

Note: If there are multiple venues in the VenuesArray, iterate through the array to access individual venue details.

Feel free to use the venue information from the response for further interactions with the selected venues in the system.

Setting Your Venue

To assign a venue to a created occasion, use the "Setting Your Venue" service. Follow the steps below to successfully update the venue for a specific occasion.

Update Venue Request

The request should be made to the following endpoint:

URL: http://prod.prismm.com/prismm-api/updateVenue

Method: POST

Request Body:

{
  "user": "{user-token}",
  "occasionid": 132212,
  "venueid": 12333,
  "isinvitevenue": 1
}

• user: The user token obtained during the login process.
• occasionid: The unique identifier of the occasion you want to update.
• venueid: The unique identifier of the venue you want to assign to the occasion.
• isinvitevenue: A flag (1 or 0) indicating whether the venue is an invite venue.

Request Headers:

• "Content-type": "application/json"

Update Venue Response

Upon a successful update, the API will respond with a JSON object containing the following information:

• IsError: Indicates whether an error occurred. 0 means no error, while other values may represent different error scenarios.
• ErrorCode: Numeric error code. 0 indicates no error, while specific codes represent different error scenarios.
• ErrorMessage: A string providing additional information about the outcome of the request.

Example Response:

{
  "IsError": 0,
  "ErrorCode": 0,
  "ErrorMessage": "string"
}

Ensure that you have the necessary permissions and the correct occasion and venue identifiers before making the request. Use the obtained user token from the login service in the Authorization header for secure access to Prismm API services.

Get Occasion Link

This service provides you with a unique link to access details about your occasion in Prismm.

Get Link Request

URL

POST https://prod.prismm.com/prismm-api/getOccasionLink

Input

The data should be passed as a JSON string with a POST method.

Request Payload

{
    "user": "User Token",
    "oid": "Occasion Id"
}

• user: User token representing the authenticated user.
• oid: Occasion Id for which you want to retrieve the link.

Example JSON Data

{
    "user": "7FE70488-E501-43FE-8896-87305EFD9070",
    "oid": "1485"
}

Request Headers

Set the following header for the request:

• Content-type: application/json

Get Link Response

The response provides a direct link to the occasion details.

Response Structure

{
    "Link": "https://prod.prismm.com/AllSeatedWeb.cfm?CT=A17A70FF-E986-44F4-B894-83A9E5C4CF40_2798",
    "ERRORSTRING": "",
    "ERRORCODE": 0
}

• Link: Direct link to the occasion details.
• ERRORSTRING: The error message (empty string if no error).
• ERRORCODE: The error code (0 if no error).

Response Example

{
    "Link": "https://prod.prismm.com/AllSeatedWeb.cfm?CT=A17A70FF-E986-44F4-B894-83A9E5C4CF40_2798",
    "ERRORSTRING": "",
    "ERRORCODE": 0
}

Note: You can use the provided link to directly access and view details related to the specified occasion in Prismm.

Feel free to incorporate the link into your application or share it with relevant stakeholders for seamless access to occasion details.

Adding Floorplans

Add floorplans to a specific occasion with the "Add Floorplans" endpoint. Follow the steps below to successfully obtain a link for the newly added floorplan.

Add Floorplans Request

Make a request to the following endpoint to add floorplans to an occasion:

Endpoint: http://prod.prismm.com/prismm-api/getNewFpLink

Method: POST

Request Body:

{
  "oid": 12333,
  "user": "{user-token}",
  "ceid": "custom_floor_id",
  "hallid": 1212
}

• oid: The unique identifier of the occasion for which you are adding floorplans.
• user: The user token obtained during the login process.
• ceid: Custom floor ID associated with the floorplan.
• hallid: The unique identifier of the hall where the floorplan is located.

Request Headers:

• "Content-type": "application/json"

Add Floorplans Response

Upon a successful request, the API will respond with a JSON object containing the following information:

{
  "link": "string",
  "IsError": 0,
  "ErrorCode": 0,
  "ErrorMessage": "string"
}

• link: Direct link to view the newly added floorplan.
• IsError: Indicates whether an error occurred. 0 means no error, while other values may represent different error scenarios.
• ErrorCode: Numeric error code. 0 indicates no error, while specific codes represent different error scenarios.
• ErrorMessage: A string providing additional information about the outcome of the request.

Ensure that you have the necessary permissions and the correct occasion and floorplan identifiers before making the request. Use the obtained user token from the login service in the Authorization header for secure access to Prismm API services.

Get Open Floorplan Link

This service provides you with a direct link to view the floorplan associated with a specific occasion in Prismm.

Get Link Request

URL

POST https://prod.prismm.com/prismm-api/getOpenFpLink

Input

The data is passed as a JSON string with a POST method.

Request Payload

{
    "user": "User Token",
    "oid": "Occasion Id",
    "ceid": "CaterEase Floorplan Id"
}

• user: User token representing the authenticated user.
• oid: Occasion Id for which you want to retrieve the floorplan link.
• ceid: CaterEase Floorplan Id associated with the occasion.

Example JSON Data

{
    "user": "7FE70488-E501-43FE-8896-87305EFD9070",
    "oid": "1485",
    "ceid": "1234"
}

Request Headers

Set the following header for the request:

• Content-type: application/json

Get Link Response

The response provides a direct link to the occasion floorplan.

Response Structure

{
    "Link": "https://prod.prismm.com/AllSeatedWeb.cfm?CT=A17A70FF-E986-44F4-B894-83A9E5C4CF40_2798_1234",
    "ERRORSTRING": "",
    "ERRORCODE": 0
}

• Link: Direct link to the occasion floorplan.
• ERRORSTRING: The error message (empty string if no error).
• ERRORCODE: The error code (0 if no error).

Example Response

{
    "Link": "https://prod.prismm.com/AllSeatedWeb.cfm?CT=A17A70FF-E986-44F4-B894-83A9E5C4CF40_2798_1234",
    "ERRORSTRING": "",
    "ERRORCODE": 0
}

Note: Use the provided link to directly access and view the floorplan associated with the specified occasion in Prismm.

This service facilitates convenient access to floorplan details, allowing users to visualize and plan the occasion layout effectively.

Get The Venue Halls

Retrieve information about the halls within a specific venue using the "Get The Venue Halls" service. Follow the steps below to make a successful request.

Read Venue Halls

Make a request to the following endpoint to get information about the halls within a specific venue:

Endpoint: https://prod.prismm.com/prismm-api/readVenueHalls

Method: POST

Request Body:

{
  "user": "{user-token}",
  "venueid": 12333
}

• user: The user token obtained during the login process.
• venueid: The unique identifier of the venue for which you want to retrieve hall information.

Request Headers:

• "Content-type": "application/json"

Read Venue Halls Response

Upon a successful request, the API will respond with a JSON object containing the following information:

{
  "user": "{user-token}",
  "venueid": 12333
}

Handle the response accordingly to extract information about the venue halls.

Ensure that you have the necessary permissions and the correct venue identifier before making the request. Use the obtained user token from the login service in the Authorization header for secure access to Prismm API services.