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

Images

GET /api/images/file/{fileid}

fileid: integer
in path

(no description)

200 OK

OK

Images

GET /api/images/image/{imageid}

imageid: integer
in path

(no description)

200 OK

OK

Images

POST /api/images/image/{imageid}

AddEditImageModel

undefined

imageid: integer
in path

(no description)

Request Example
{
  "ImageId": "integer",
  "FileId": "integer",
  "ImageUsageId": "string",
  "SourceType": "string",
  "SourceId": "integer",
  "Url": "string",
  "CropX": "integer",
  "CropY": "integer",
  "CropHeight": "string",
  "CropWidth": "string",
  "ForceAspect": "string",
  "Caption": "string",
  "ShortDescription": "string"
}
200 OK
ImageModel

OK

Response Example (200 OK) 
{
  "ImageId": "integer",
  "FileId": "integer",
  "SourceType": "string",
  "SourceId": "integer",
  "Url": "string",
  "CropX": "integer",
  "CropY": "integer",
  "CropHeight": "string",
  "CropWidth": "string",
  "Height": "string",
  "Width": "string",
  "Caption": "string",
  "ForceAspect": "string",
  "ShortDescription": "string",
  "Name": "string"
}
Images

DELETE /api/images/image/{imageid}

imageid: integer
in path

(no description)

200 OK

OK

Images

POST /api/images/upload

200 OK

OK

Images

This is mainly just used by the client image uploader - at least so far

POST /api/images/upload/{foldertype}/{objectid}

This is mainly just used by the client image uploader - at least so far

foldertype: string
in path

(no description)

objectid: string
in path

(no description)

200 OK
ImageModel

OK

Response Example (200 OK) 
{
  "ImageId": "integer",
  "FileId": "integer",
  "SourceType": "string",
  "SourceId": "integer",
  "Url": "string",
  "CropX": "integer",
  "CropY": "integer",
  "CropHeight": "string",
  "CropWidth": "string",
  "Height": "string",
  "Width": "string",
  "Caption": "string",
  "ForceAspect": "string",
  "ShortDescription": "string",
  "Name": "string"
}
Images

GET /api/images/usage/{imageusageid}

imageusageid: string
in path

(no description)

secondary: string
in query

(no description)

200 OK
ImageUsageModel

OK

Response Example (200 OK) 
{
  "MaxWidth": "string",
  "MaxHeight": "string",
  "AspectRatio": "string"
}

Schema Definitions

ImageUsageModel: object

MaxWidth: string
MaxHeight: string
AspectRatio: string
Example
{
  "MaxWidth": "string",
  "MaxHeight": "string",
  "AspectRatio": "string"
}

IHttpActionResult: object

Example
"object"

ImageModel: object

ImageId: integer
FileId: integer
SourceType: string
SourceId: integer
Url: string
CropX: integer
CropY: integer
CropHeight: string
CropWidth: string
Height: string
Width: string
Caption: string
ForceAspect: string
ShortDescription: string
Name: string
Example
{
  "ImageId": "integer",
  "FileId": "integer",
  "SourceType": "string",
  "SourceId": "integer",
  "Url": "string",
  "CropX": "integer",
  "CropY": "integer",
  "CropHeight": "string",
  "CropWidth": "string",
  "Height": "string",
  "Width": "string",
  "Caption": "string",
  "ForceAspect": "string",
  "ShortDescription": "string",
  "Name": "string"
}

AddEditImageModel: object

ImageId: integer
FileId: integer
ImageUsageId: string
SourceType: string
SourceId: integer
Url: string
CropX: integer
CropY: integer
CropHeight: string
CropWidth: string
ForceAspect: string
Caption: string
ShortDescription: string
Example
{
  "ImageId": "integer",
  "FileId": "integer",
  "ImageUsageId": "string",
  "SourceType": "string",
  "SourceId": "integer",
  "Url": "string",
  "CropX": "integer",
  "CropY": "integer",
  "CropHeight": "string",
  "CropWidth": "string",
  "ForceAspect": "string",
  "Caption": "string",
  "ShortDescription": "string"
}
Documentation by Spectacle