GrowthZone REST API API Reference

undefined

API Endpoint
https://app.memberzone.org
Request Content-Types: application/json
Response Content-Types: application/json
Schemes: https
Version: v1.0

Paths

Returns a list of all vendors.

GET /api/vendors

Returns a list of all vendors.

The list of vendors.

401 Unauthorized

The user is not authorized to access this operation.

Response Example (200 OK)
[
  {
    "VendorId": "integer",
    "Name": "string",
    "WebsiteUrl": "string",
    "Actions": "string"
  }
]

Save a Vendor.

POST /api/vendors

Saves a new Vendor with the model information provided.

The vendor to save.

Request Example
{
  "VendorId": "integer",
  "Name": "string",
  "WebsiteUrl": "string"
}

The vendor model that was saved.

Response Example (200 OK)
{
  "VendorId": "integer",
  "Name": "string",
  "WebsiteUrl": "string",
  "Actions": "string"
}

Return a vendor

GET /api/vendors/{vendorid}

Returns a vendor by it's ID.

vendorid: integer
in path

The ID of the vendor return.

The vendor model.

401 Unauthorized

The user is not authorized to access this operation.

Response Example (200 OK)
{
  "VendorId": "integer",
  "Name": "string",
  "WebsiteUrl": "string"
}

Delete a Vendor.

DELETE /api/vendors/{vendorid}

Delete a Vendor.

vendorid: integer
in path

The ID of the vendor to delete.

200 OK

The ID of the vendor that was deleted.

401 Unauthorized

The user is not authorized to access this operation.

Check the duplication vendors based on the name.

POST /api/vendors/duplicatecheck

Check the duplication vendors based on the name.

The model that contains the information to test for duplicates.

Request Example
{
  "VendorId": "integer",
  "Name": "string",
  "WebsiteUrl": "string"
}

The list of potential duplicates.

Response Example (200 OK)
[
  {
    "Id": "integer",
    "Name": "string",
    "Description": "string"
  }
]

Search for a vendor name.

GET /api/vendors/search

Returns a list of vendors that match the search text.

this[]: string
in query

(no description)

length: string
in query

(no description)

The vendor model.

401 Unauthorized

The user is not authorized to access this operation.

Response Example (200 OK)
[
  {
    "VendorId": "integer",
    "Name": "string",
    "WebsiteUrl": "string",
    "Actions": "string"
  }
]

Schema Definitions

VendorCollectionItemModel: object

VendorId: integer
Name: string
WebsiteUrl: string
Actions: string
Example
{
  "VendorId": "integer",
  "Name": "string",
  "WebsiteUrl": "string",
  "Actions": "string"
}

AddEditVendorViewModel: object

VendorId: integer
Name: string
WebsiteUrl: string
Example
{
  "VendorId": "integer",
  "Name": "string",
  "WebsiteUrl": "string"
}

IHttpActionResult: object

Example
"object"

PotentialDuplicateEntry: object

Id: integer
Name: string
Description: string
Example
{
  "Id": "integer",
  "Name": "string",
  "Description": "string"
}