Site Survey

Retrieves Site Survey

get

This endpoint retrieves the site survey record for a specified merchant, identified by their merchant Id/Number provided as a route parameter. The response returns all the relevant details of the site survey, such as site description, agreement accepted status, and other information within the response body.

Path parameters

merchantNumberstringRequired

Merchant number used to get Site Survey details

Header parameters

exchangeIdstringOptional

Correlation Id for the request

Responses

200

Returns a Site Survey successfully.

application/json

204

No content.

400

Bad Request: If merchant number is null or empty.

application/json

403

Forbidden: The user does not have the necessary permissions to access this resource.

application/json

404

Not Found: Site Survey not found.

application/json

500

Internal Server Error: This could be due to system errors. Please contact support for assistance

application/json

get

HTTPcURLJavaScriptPython

GET /api/demographics/v1/SiteSurveys/{merchantNumber} HTTP/1.1
Host: localhost:5000
Accept: */*

{
  "siteTypeID": 3,
  "otherSiteTypeDescription": "Mobile Kiosk",
  "siteSurveyConductedInPerson": true,
  "merchantAcquisitionTypeID": 2,
  "validIDVerified": true,
  "inventoryMatchesProductSold": false,
  "inventoryMatchesProductSoldComments": "The inventory contains outdated models not listed in the product catalog.",
  "agreementAccepted": true,
  "selfSignUpApplication": false
}

Updates Site Survey

put

This endpoint is used to update an existing site survey record for a specific merchant, identified by their merchant number. The request requires the merchantNumber to be supplied as a route parameter and the updated site survey details to be passed in the request body. The site survey details should include all necessary information such as the survey's unique identifier (SiteSurveyID), agreement acceptance status, site description, and any additional metadata required to ensure accurate record updates.

Path parameters

merchantNumberstringRequired

Merchant number used to update Site Survey.

Header parameters

exchangeIdstringOptional

Correlation Id for the request

Body

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

siteTypeIDinteger · int32 · min: 1 · max: 4Required

Site values are from 1 to 4, representing different site types i.e Other = 1, BrickAndMortar = 2, Tradeshow = 3, Residence.

Example: 3

otherSiteTypeDescriptionstring | nullableOptional

A description of the site type, used when SiteTypeID is 1 or "Other".

Example: Mobile Kiosk

siteSurveyConductedInPersonbooleanRequired

Indicates whether the site survey was conducted in person.

Example: true

merchantAcquisitionTypeIDinteger · int32 | nullableOptional

The type of merchant acquisition. Valid values are from 1 to 3, representing acquisition methods.

Example: 2

validIDVerifiedbooleanRequired

Indicates whether a valid ID has been verified.

Example: true

inventoryMatchesProductSoldbooleanRequired

Indicates whether the inventory matches the products being sold.

Example: false

inventoryMatchesProductSoldCommentsstring | nullableOptional

Additional comments if the inventory does not match the products being sold.

Example: The inventory contains outdated models not listed in the product catalog.

agreementAcceptedbooleanRequired

Indicates whether the agreement has been accepted by the merchant.

Example: true

selfSignUpApplicationbooleanOptional

Indicates whether the application was submitted via self-sign-up.

Example: false

Responses

200

Saves a Site Survey successfully.

application/json

400

Bad request: If merchant number is null or empty, or data is invalid.

application/json

403

Forbidden: The user does not have the necessary permissions to access this resource.

application/json

404

Not Found: Resource not found exception.

application/json

500

Internal Server Error: This could be due to system errors. Please contact support for assistance

application/json

put

HTTPcURLJavaScriptPython

PUT /api/demographics/v1/SiteSurveys/{merchantNumber} HTTP/1.1
Host: localhost:5000
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 351

{
  "siteTypeID": 3,
  "otherSiteTypeDescription": "Mobile Kiosk",
  "siteSurveyConductedInPerson": true,
  "merchantAcquisitionTypeID": 2,
  "validIDVerified": true,
  "inventoryMatchesProductSold": false,
  "inventoryMatchesProductSoldComments": "The inventory contains outdated models not listed in the product catalog.",
  "agreementAccepted": true,
  "selfSignUpApplication": false
}

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

{
  "siteTypeID": 3,
  "otherSiteTypeDescription": "Mobile Kiosk",
  "siteSurveyConductedInPerson": true,
  "merchantAcquisitionTypeID": 2,
  "validIDVerified": true,
  "inventoryMatchesProductSold": false,
  "inventoryMatchesProductSoldComments": "The inventory contains outdated models not listed in the product catalog.",
  "agreementAccepted": true,
  "selfSignUpApplication": false
}