Category

GET /api/categories/category

Fields

Field Type Description Required
name/name YES

Request

Headers

Header Value
Accept
application/vnd.orderadmin\reports\api.v1+json
application/hal+json
application/json

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 200: OK

Headers

Header Value
Content-Type
application/vnd.orderadmin\reports\api.v1+json
application/hal+json
application/json
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

POST /api/categories/category

Fields

Field Type Description Required
name/name YES

Request

Headers

Header Value
Accept
application/vnd.orderadmin\reports\api.v1+json
application/hal+json
application/json
Content-Type
application/vnd.orderadmin\reports\api.v1+json
application/json
application/*+document

Body


                                            

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 201: Created
  • 400: Client Error
  • 422: Unprocessable Entity

Headers

Header Value
Content-Type
application/vnd.orderadmin\reports\api.v1+json
application/hal+json
application/json
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

GET /api/categories/category[/:category_id]

Fields

Field Type Description Required
name/name YES

Request

Headers

Header Value
Accept
application/vnd.orderadmin\reports\api.v1+json
application/hal+json
application/json

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 200: OK
  • 404: Not Found

Headers

Header Value
Content-Type
application/vnd.orderadmin\reports\api.v1+json
application/hal+json
application/json
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

PATCH /api/categories/category[/:category_id]

Fields

Field Type Description Required
name/name YES

Request

Headers

Header Value
Accept
application/vnd.orderadmin\reports\api.v1+json
application/hal+json
application/json
Content-Type
application/vnd.orderadmin\reports\api.v1+json
application/json
application/*+document

Body


                                            

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 200: OK
  • 404: Not Found
  • 400: Client Error
  • 422: Unprocessable Entity

Headers

Header Value
Content-Type
application/vnd.orderadmin\reports\api.v1+json
application/hal+json
application/json
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

PUT /api/categories/category[/:category_id]

Fields

Field Type Description Required
name/name YES

Request

Headers

Header Value
Accept
application/vnd.orderadmin\reports\api.v1+json
application/hal+json
application/json
Content-Type
application/vnd.orderadmin\reports\api.v1+json
application/json
application/*+document

Body


                                            

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 200: OK
  • 404: Not Found
  • 400: Client Error
  • 422: Unprocessable Entity

Headers

Header Value
Content-Type
application/vnd.orderadmin\reports\api.v1+json
application/hal+json
application/json
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

DELETE /api/categories/category[/:category_id]

Fields

Field Type Description Required
name/name YES

Request

Headers

Header Value
Accept
application/vnd.orderadmin\reports\api.v1+json
application/hal+json
application/json

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 204: No Content
  • 404: Not Found

Headers

Header Value
Content-Type
application/vnd.orderadmin\reports\api.v1+json
application/hal+json
application/json
Allow Comma-separated list of all HTTP methods allowed

Job

GET /api/reports/job

Fields

Field Type Description Required
reportType YES
state YES
data YES
result YES

Request

Headers

Header Value
Accept
application/vnd.orderadmin\reports\api.v1+json
application/hal+json
application/json

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 200: OK

Headers

Header Value
Content-Type
application/vnd.orderadmin\reports\api.v1+json
application/hal+json
application/json
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

POST /api/reports/job

Fields

Field Type Description Required
reportType YES
state YES
data YES
result YES

Request

Headers

Header Value
Accept
application/vnd.orderadmin\reports\api.v1+json
application/hal+json
application/json
Content-Type
application/vnd.orderadmin\reports\api.v1+json
application/json

Body


                                            

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 201: Created
  • 400: Client Error
  • 422: Unprocessable Entity

Headers

Header Value
Content-Type
application/vnd.orderadmin\reports\api.v1+json
application/hal+json
application/json
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

GET /api/reports/job[/:job_id]

Fields

Field Type Description Required
reportType YES
state YES
data YES
result YES

Request

Headers

Header Value
Accept
application/vnd.orderadmin\reports\api.v1+json
application/hal+json
application/json

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 200: OK
  • 404: Not Found

Headers

Header Value
Content-Type
application/vnd.orderadmin\reports\api.v1+json
application/hal+json
application/json
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

PATCH /api/reports/job[/:job_id]

Fields

Field Type Description Required
reportType YES
state YES
data YES
result YES

Request

Headers

Header Value
Accept
application/vnd.orderadmin\reports\api.v1+json
application/hal+json
application/json
Content-Type
application/vnd.orderadmin\reports\api.v1+json
application/json

Body


                                            

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 200: OK
  • 404: Not Found
  • 400: Client Error
  • 422: Unprocessable Entity

Headers

Header Value
Content-Type
application/vnd.orderadmin\reports\api.v1+json
application/hal+json
application/json
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

PUT /api/reports/job[/:job_id]

Fields

Field Type Description Required
reportType YES
state YES
data YES
result YES

Request

Headers

Header Value
Accept
application/vnd.orderadmin\reports\api.v1+json
application/hal+json
application/json
Content-Type
application/vnd.orderadmin\reports\api.v1+json
application/json

Body


                                            

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 200: OK
  • 404: Not Found
  • 400: Client Error
  • 422: Unprocessable Entity

Headers

Header Value
Content-Type
application/vnd.orderadmin\reports\api.v1+json
application/hal+json
application/json
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

DELETE /api/reports/job[/:job_id]

Fields

Field Type Description Required
reportType YES
state YES
data YES
result YES

Request

Headers

Header Value
Accept
application/vnd.orderadmin\reports\api.v1+json
application/hal+json
application/json

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 204: No Content
  • 404: Not Found

Headers

Header Value
Content-Type
application/vnd.orderadmin\reports\api.v1+json
application/hal+json
application/json
Allow Comma-separated list of all HTTP methods allowed

ReportType

GET /api/reports/report-type

Fields

Field Type Description Required
name/name YES

Request

Headers

Header Value
Accept
application/vnd.orderadmin\reports\api.v1+json
application/hal+json
application/json

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 200: OK

Headers

Header Value
Content-Type
application/vnd.orderadmin\reports\api.v1+json
application/hal+json
application/json
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

POST /api/reports/report-type

Fields

Field Type Description Required
name/name YES

Request

Headers

Header Value
Accept
application/vnd.orderadmin\reports\api.v1+json
application/hal+json
application/json
Content-Type
application/vnd.orderadmin\reports\api.v1+json
application/json

Body


                                            

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 201: Created
  • 400: Client Error
  • 422: Unprocessable Entity

Headers

Header Value
Content-Type
application/vnd.orderadmin\reports\api.v1+json
application/hal+json
application/json
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

GET /api/reports/report-type[/:report_type_id]

Fields

Field Type Description Required
name/name YES

Request

Headers

Header Value
Accept
application/vnd.orderadmin\reports\api.v1+json
application/hal+json
application/json

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 200: OK
  • 404: Not Found

Headers

Header Value
Content-Type
application/vnd.orderadmin\reports\api.v1+json
application/hal+json
application/json
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

PATCH /api/reports/report-type[/:report_type_id]

Fields

Field Type Description Required
name/name YES

Request

Headers

Header Value
Accept
application/vnd.orderadmin\reports\api.v1+json
application/hal+json
application/json
Content-Type
application/vnd.orderadmin\reports\api.v1+json
application/json

Body


                                            

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 200: OK
  • 404: Not Found
  • 400: Client Error
  • 422: Unprocessable Entity

Headers

Header Value
Content-Type
application/vnd.orderadmin\reports\api.v1+json
application/hal+json
application/json
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

PUT /api/reports/report-type[/:report_type_id]

Fields

Field Type Description Required
name/name YES

Request

Headers

Header Value
Accept
application/vnd.orderadmin\reports\api.v1+json
application/hal+json
application/json
Content-Type
application/vnd.orderadmin\reports\api.v1+json
application/json

Body


                                            

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 200: OK
  • 404: Not Found
  • 400: Client Error
  • 422: Unprocessable Entity

Headers

Header Value
Content-Type
application/vnd.orderadmin\reports\api.v1+json
application/hal+json
application/json
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

DELETE /api/reports/report-type[/:report_type_id]

Fields

Field Type Description Required
name/name YES

Request

Headers

Header Value
Accept
application/vnd.orderadmin\reports\api.v1+json
application/hal+json
application/json

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 204: No Content
  • 404: Not Found

Headers

Header Value
Content-Type
application/vnd.orderadmin\reports\api.v1+json
application/hal+json
application/json
Allow Comma-separated list of all HTTP methods allowed

Report

GET /api/reports/report

Request

Headers

Header Value
Accept
application/vnd.orderadmin\reports\api.v1+json
application/hal+json
application/json
text/html
application/*+document
application/pdf
application/xls
Authorization HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details)

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 200: OK
  • 401: Unauthorized
  • 403: Forbidden

Headers

Header Value
Content-Type
application/vnd.orderadmin\reports\api.v1+json
application/hal+json
application/json
text/html
application/*+document
application/pdf
application/xls
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

POST /api/reports/report

Request

Headers

Header Value
Accept
application/vnd.orderadmin\reports\api.v1+json
application/hal+json
application/json
text/html
application/*+document
application/pdf
application/xls
Content-Type
application/vnd.orderadmin\reports\api.v1+json
application/json
application/*+document
application/pdf
application/xls
Authorization HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details)

Body


                                            

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 201: Created
  • 401: Unauthorized
  • 403: Forbidden

Headers

Header Value
Content-Type
application/vnd.orderadmin\reports\api.v1+json
application/hal+json
application/json
text/html
application/*+document
application/pdf
application/xls
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

GET /api/reports/report[/:report_id]

Request

Headers

Header Value
Accept
application/vnd.orderadmin\reports\api.v1+json
application/hal+json
application/json
text/html
application/*+document
application/pdf
application/xls
Authorization HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details)

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 200: OK
  • 404: Not Found
  • 401: Unauthorized
  • 403: Forbidden

Headers

Header Value
Content-Type
application/vnd.orderadmin\reports\api.v1+json
application/hal+json
application/json
text/html
application/*+document
application/pdf
application/xls
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

PATCH /api/reports/report[/:report_id]

Request

Headers

Header Value
Accept
application/vnd.orderadmin\reports\api.v1+json
application/hal+json
application/json
text/html
application/*+document
application/pdf
application/xls
Content-Type
application/vnd.orderadmin\reports\api.v1+json
application/json
application/*+document
application/pdf
application/xls
Authorization HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details)

Body


                                            

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 200: OK
  • 404: Not Found
  • 401: Unauthorized
  • 403: Forbidden

Headers

Header Value
Content-Type
application/vnd.orderadmin\reports\api.v1+json
application/hal+json
application/json
text/html
application/*+document
application/pdf
application/xls
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

PUT /api/reports/report[/:report_id]

Request

Headers

Header Value
Accept
application/vnd.orderadmin\reports\api.v1+json
application/hal+json
application/json
text/html
application/*+document
application/pdf
application/xls
Content-Type
application/vnd.orderadmin\reports\api.v1+json
application/json
application/*+document
application/pdf
application/xls
Authorization HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details)

Body


                                            

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 200: OK
  • 404: Not Found
  • 401: Unauthorized
  • 403: Forbidden

Headers

Header Value
Content-Type
application/vnd.orderadmin\reports\api.v1+json
application/hal+json
application/json
text/html
application/*+document
application/pdf
application/xls
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

DELETE /api/reports/report[/:report_id]

Request

Headers

Header Value
Accept
application/vnd.orderadmin\reports\api.v1+json
application/hal+json
application/json
text/html
application/*+document
application/pdf
application/xls
Authorization HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details)

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 204: No Content
  • 404: Not Found
  • 401: Unauthorized
  • 403: Forbidden

Headers

Header Value
Content-Type
application/vnd.orderadmin\reports\api.v1+json
application/hal+json
application/json
text/html
application/*+document
application/pdf
application/xls
Allow Comma-separated list of all HTTP methods allowed

Statistic

GET /api/statistics[/:module][/:report][/:actions]

Request

Headers

Header Value
Accept
application/vnd.application\api.v1+json
application/json

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 200: OK

Headers

Header Value
Content-Type
application/vnd.application\api.v1+json
application/json
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

GET /api/statistics[/:module][/:report][/:actions]

Request

Headers

Header Value
Accept
application/vnd.application\api.v1+json
application/json

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 200: OK
  • 404: Not Found

Headers

Header Value
Content-Type
application/vnd.application\api.v1+json
application/json
Allow Comma-separated list of all HTTP methods allowed

Body