Schemas-Business

UpdateBusinessResponseDto

success
boolean
required

Success Value

Example:
true
buiseness
object
required

Business Response

id
string
required

Business Id

Example:
63771dcac1116f0e21de8e12
name
string
required

Business Name

Example:
Microsoft
phone
string

phone number

email
string

email

Example:
abc@microsoft.com
website
string

website

Example:
microsoft.com
address
string

address

city
string

city

description
string

description

state
string

state

postalCode
string

postal code

country
string

country

Example:
united states
updatedBy
object

updated By

locationId
string
required

locaitonId

createdBy
object

Created By

createdAt
string<date-time>

Creation Time

updatedAt
string<date-time>

Last updation time

Example 
{
  "success": true,
  "buiseness": {
    "id": "63771dcac1116f0e21de8e12",
    "name": "Microsoft",
    "phone": "string",
    "email": "abc@microsoft.com",
    "website": "microsoft.com",
    "address": "string",
    "city": "string",
    "description": "string",
    "state": "string",
    "postalCode": "string",
    "country": "united states",
    "updatedBy": {},
    "locationId": "string",
    "createdBy": {},
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z"
  }
}

BadRequestDTO

statusCode
number
Example:
400
message
string
Example:
Bad Request
Example 
 {
  "statusCode": 400,
  "message": "Bad Request"
}

UnauthorizedDTO

statusCode
number
Example:
401
message
string
Example:
Invalid token: access token is invalid
error
string
Example:
Unauthorized
Example 
{
  "statusCode": 401,
  "message": "Invalid token: access token is invalid",
  "error": "Unauthorized"
}

BusinessDto

id
string
required

Business Id

Example:
63771dcac1116f0e21de8e12
name
string
required

Business Name

Example:
Microsoft
phone
string

phone number

email
string

email

Example:
abc@microsoft.com
website
string

website

Example:
microsoft.com
address
string

address

city
string

city

description
string

description

state
string

state

postalCode
string

postal code

country
string

country

Example:
united states
updatedBy
object

updated By

locationId
string
required

locaitonId

createdBy
object

Created By

createdAt
string<date-time>

Creation Time

updatedAt
string<date-time>

Last updation time

Example 
{
  "id": "63771dcac1116f0e21de8e12",
  "name": "Microsoft",
  "phone": "string",
  "email": "abc@microsoft.com",
  "website": "microsoft.com",
  "address": "string",
  "city": "string",
  "description": "string",
  "state": "string",
  "postalCode": "string",
  "country": "united states",
  "updatedBy": {},
  "locationId": "string",
  "createdBy": {},
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z"
}

GetBusinessByLocationResponseDto

businesses
array[object]
required

Business Response

id
string
required

Business Id

Example:
63771dcac1116f0e21de8e12
name
string
required

Business Name

Example:
Microsoft
phone
string

phone number

email
string

email

Example:
abc@microsoft.com
website
string

website

Example:
microsoft.com
address
string

address

city
string

city

description
string

description

state
string

state

postalCode
string

postal code

country
string

country

Example:
united states
updatedBy
object

updated By

locationId
string
required

locaitonId

createdBy
object

Created By

createdAt
string<date-time>

Creation Time

updatedAt
string<date-time>

Last updation time

Example 
{
  "businesses": [
    {
      "id": "63771dcac1116f0e21de8e12",
      "name": "Microsoft",
      "phone": "string",
      "email": "abc@microsoft.com",
      "website": "microsoft.com",
      "address": "string",
      "city": "string",
      "description": "string",
      "state": "string",
      "postalCode": "string",
      "country": "united states",
      "updatedBy": {},
      "locationId": "string",
      "createdBy": {},
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z"
    }
  ]
}

CreateBusinessDto

name
string
required
Example:
Microsoft
locationId
string
required
Example:
5DP4iH6HLkQsiKESj6rh
phone
string
Example:
+18832327657
email
string
Example:
john@deo.com
website
string
Example:
www.xyz.com
address
string
Example:
street adress
city
string
Example:
new york
postalCode
string
Example:
12312312
state
string
Example:
new york
country
string
Example:
us
description
string
Example:
business description
Example 
 {
  "name": "Microsoft",
  "locationId": "5DP4iH6HLkQsiKESj6rh",
  "phone": "+18832327657",
  "email": "john@deo.com",
  "website": "www.xyz.com",
  "address": "street adress",
  "city": "new york",
  "postalCode": "12312312",
  "state": "new york",
  "country": "us",
  "description": "business description"
}

UpdateBusinessResponseDto

success
boolean
required

Success Value

Example:
true
buiseness
object
required

Business Response

id
string
required

Business Id

Example:
63771dcac1116f0e21de8e12
name
string
required

Business Name

Example:
Microsoft
phone
string

phone number

email
string

email

Example:
abc@microsoft.com
website
string

website

Example:
microsoft.com
address
string

address

city
string

city

description
string

description

state
string

state

postalCode
string

postal code

country
string

country

Example:
united states
updatedBy
object

updated By

locationId
string
required

locaitonId

createdBy
object

Created By

createdAt
string<date-time>

Creation Time

updatedAt
string<date-time>

Last updation time

Example 
 {
  "success": true,
  "buiseness": {
    "id": "63771dcac1116f0e21de8e12",
    "name": "Microsoft",
    "phone": "string",
    "email": "abc@microsoft.com",
    "website": "microsoft.com",
    "address": "string",
    "city": "string",
    "description": "string",
    "state": "string",
    "postalCode": "string",
    "country": "united states",
    "updatedBy": {},
    "locationId": "string",
    "createdBy": {},
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z"
  }
}

UnprocessableDTO

statusCode
number
Example:
422
message
array[string]
Example:
["Unprocessable Entity"]
error
string
Example:
Unprocessable Entity
Example 
{
  "statusCode": 422,
  "message": [
    "Unprocessable Entity"
  ],
  "error": "Unprocessable Entity"
}

UpdateBusinessDto

name
string
Example:
Microsoft
phone
string
Example:
+18832327657
email
string
Example:
john@deo.com
postalCode
string
Example:
12312312
website
string
Example:
www.xyz.com
address
string
Example:
street adress
state
string
Example:
new york
city
string
Example:
new york
country
string
Example:
us
description
string
Example:
business description
Example 
{
  "name": "Microsoft",
  "phone": "+18832327657",
  "email": "john@deo.com",
  "postalCode": "12312312",
  "website": "www.xyz.com",
  "address": "street adress",
  "state": "new york",
  "city": "new york",
  "country": "us",
  "description": "business description"
}

DeleteBusinessResponseDto

success
boolean
required

Success value

Example:
true
Example 
{
  "success": true
}

GetBusinessByIdResponseDto

business
object
required

Business Response

id
string
required

Business Id

Example:
63771dcac1116f0e21de8e12
name
string
required

Business Name

Example:
Microsoft
phone
string

phone number

email
string

email

Example:
abc@microsoft.com
website
string

website

Example:
microsoft.com
address
string

address

city
string

city

description
string

description

state
string

state

postalCode
string

postal code

country
string

country

Example:
united states
updatedBy
object

updated By

locationId
string
required

locaitonId

createdBy
object

Created By

createdAt
string<date-time>

Creation Time

updatedAt
string<date-time>

Last updation time

Example 
{
  "business": {
    "id": "63771dcac1116f0e21de8e12",
    "name": "Microsoft",
    "phone": "string",
    "email": "abc@microsoft.com",
    "website": "microsoft.com",
    "address": "string",
    "city": "string",
    "description": "string",
    "state": "string",
    "postalCode": "string",
    "country": "united states",
    "updatedBy": {},
    "locationId": "string",
    "createdBy": {},
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z"
  }
}