ORYX Web Service API Help

Introduction

Help pages do explain all available APIs' Request Information (URI Parameters, Body Parameters) and Response Information (Status, Pagination Information and Returned Objects).

Images

API	Description
GET api/ResizeImage	Get any image which is already existing on server with an appropriate width and height by keeping image dimensions aspect ratio. This API is public and need no Authorization The resized image will be returned as an attachment within the response. All images must be in png format only except customer image must be jpg.
GET api/ResizeFlag	Get any already existing country/nationality flag image with an appropriate width and height by keeping image dimensions aspect ratio. This API is public and need no Authorization The resized image will be returned as an attachment within the response. All images are in png format.
POST api/UploadImage	Upload any image related to CUSTOMERS table in jpg format. The image must be attached to the request body.

API

Description

GET api/ResizeImage

Get any image which is already existing on server with an appropriate width and height by keeping image dimensions aspect ratio.

This API is public and need no Authorization

The resized image will be returned as an attachment within the response.

All images must be in png format only except customer image must be jpg.

GET api/ResizeFlag

Get any already existing country/nationality flag image with an appropriate width and height by keeping image dimensions aspect ratio.

This API is public and need no Authorization

The resized image will be returned as an attachment within the response.

All images are in png format.

POST api/UploadImage

Upload any image related to CUSTOMERS table in jpg format. The image must be attached to the request body.

ORDERS

API	Description
GET Api/ORDERS/SUMMARY	Get order summary
GET Api/ORDERS/DETAILED	Get order details
GET Api/ORDERS/DELIVERY	Get order delivery info details
PUT Api/ORDERS/DELIVERY/BARCODE	Update livestock delivery SlaughterHouse barcode
PUT Api/ORDERS/DELIVERY/STATUS	Update order status
POST api/ORDERS/CART	Transfer Cart products to order
GET api/ORDERS	Get ORDERS list according to passed filters, sortings and paganation info

CUSTOMERS

API	Description
PUT api/CUSTOMERS/LAST_NOTIFY_DELETE	Sets customer's LAST_NOTIFY_DELETE value to current time to avoid getting older alerts
POST api/CUSTOMERS/VERIFY_OTP	Verify OTP Code with the one sent as SMS to mobile number. Token expire period is 10 minutes.
POST api/CUSTOMERS/SEND_OTP	Resend OTP Code as an SMS to CUSTOMER's mobile number and returns the token at the Token Guid object
POST api/CUSTOMERS/RESET_PASSWORD	Forget/Reset Password. A random 6 digit password will be generated and sent to user's email. User's password will also be set to its new value by web service at this point.
GET api/CUSTOMERS	Get CUSTOMERS list according to passed filters, sortings and paganation info
PUT api/CUSTOMERS/{id}	Update a single CUSTOMERS record
POST api/CUSTOMERS	Insert a single record into CUSTOMERS

Account

API	Description
POST api/LOGIN	Login a user into the system

ALERTS

API	Description
GET api/ALERTS	No documentation available.

ORDER_SECONDARY_PARTS

API	Description
GET api/ORDER_SECONDARY_PARTS	Get ORDER_SECONDARY_PARTS list according to passed filters, sortings and paganation info

DURATION_PERIODS

API	Description
GET api/DURATION_PERIODS	Get DURATION_PERIODS list according to passed filters, sortings and paganation info

EMIRATES

API	Description
GET api/EMIRATES	Get EMIRATES list according to passed filters, sortings and paganation info

HomeScreen

API	Description
GET api/HomeScreen	Get Home Screen info

PACKAGING_METHODS

API	Description
GET api/PACKAGING_METHODS	Get PACKAGING_METHODS list according to passed filters, sortings and paganation info

DELIVERY_METHODS

API	Description
GET api/DELIVERY_METHODS	Get DELIVERY_METHODS list according to passed filters, sortings and paganation info

RESET_PASSWORD

API	Description
POST api/RESET_PASSWORD	Forget/Reset Password. A random 6 digit password will be generated and sent to user's email. User's password will also be set to its new value by web service at this point.

LS_SECONDARY_PARTS

API	Description
GET api/LS_SECONDARY_PARTS	Get LS_SECONDARY_PARTS list according to passed filters, sortings and paganation info

DEVICES

API	Description
GET api/DEVICES	Get DEVICES list according to passed filters, sortings and paganation info
POST api/DEVICES	Insert a single record into DEVICES

LS_AGES

API	Description
GET api/LS_AGES	Get LS_AGES list according to passed filters, sortings and paganation info

Values

API	Description
GET api/Values	No documentation available.
GET api/Values/{id}	No documentation available.
POST api/Values	No documentation available.
PUT api/Values/{id}	No documentation available.
DELETE api/Values/{id}	No documentation available.

SLAUGHTERHOUSES

API	Description
GET api/SLAUGHTERHOUSES	Get SLAUGHTERHOUSES list according to passed filters, sortings and paganation info

LS_CLASSES

API	Description
GET api/LS_CLASSES	Get LS_CLASSES list according to passed filters, sortings and paganation info

COUNTRIES

API	Description
GET api/COUNTRIES	Get COUNTRIES list according to passed filters, sortings and paganation info

PROMOS

API	Description
GET api/PROMOS	Get PROMOS list according to passed filters, sortings and paganation info

LS_CATEGORIES

API	Description
GET api/LS_CATEGORIES	Get LS_CATEGORIES list according to passed filters, sortings and paganation info

CUSTOMER_ADDRESSES

API	Description
GET api/CUSTOMER_ADDRESSES	Get CUSTOMER_ADDRESSES list according to passed filters, sortings and paganation info
PUT api/CUSTOMER_ADDRESSES/{id}	Update a single CUSTOMER_ADDRESSES record
POST api/CUSTOMER_ADDRESSES	Insert a single record into CUSTOMER_ADDRESSES
DELETE api/CUSTOMER_ADDRESSES/{id}	Deletes a single CUSTOMER_ADDRESSES record according to passed ADDRESS_ID value

ORDER_STATUS

API	Description
GET api/ORDER_STATUS	Get ORDER_STATUS list according to passed filters, sortings and paganation info

SOCIALS

API	Description
GET api/SOCIALS	Get SOCIALS list according to passed filters, sortings and paganation info

ORDER_PRODUCTS

API	Description
GET api/ORDER_PRODUCTS	Get ORDER_PRODUCTS list according to passed filters, sortings and paganation info

LS_WEIGHTS

API	Description
GET api/LS_WEIGHTS	Get LS_WEIGHTS list according to passed filters, sortings and paganation info

SLICING_METHODS

API	Description
GET api/SLICING_METHODS	Get SLICING_METHODS list according to passed filters, sortings and paganation info

SLICING_INFO

API	Description
GET api/SLICING_INFO	Get SLICING_INFO list according to passed filters, sortings and paganation info

DELIVERY_PRICES

API	Description
GET api/DELIVERY_PRICES	Get DELIVERY_PRICES list according to passed filters, sortings and paganation info

CUSTOMER_CARTS

API	Description
GET api/CUSTOMER_CARTS	Get current customer's cart items list
PUT api/CUSTOMER_CARTS	Update a single cart item's quantity that belongs to current customer
POST api/CUSTOMER_CARTS	Add a single cart item into current customer's cart
DELETE api/CUSTOMER_CARTS/{id}	Deletes a single CUSTOMER_CARTS record according to passed CART_ID value

SLICING_CUTTINGS

API	Description
GET api/SLICING_CUTTINGS	Get SLICING_CUTTINGS list according to passed filters, sortings and paganation info

FEEDBACKS

API	Description
POST api/FEEDBACKS	Insert a single record into FEEDBACKS

NotifyMobiles

API	Description
POST api/NotifyMobiles	Sends a push notification to users. Notificaton will be sent to mobiles with the following payload: iOS => {"aps":{"alert":"[message]","title":"[message]" , "NotificationType": [recordType], "RecordId": [recordId], "badge":1, "content-available": 1, "sound": "default"}} Android => {"alert":"[message]","title":"[message]" , "NotificationType": [recordType], "RecordId": [recordId], "badge":1, "content-available": 1, "sound": "default"}

API

Description

POST api/NotifyMobiles

Sends a push notification to users. Notificaton will be sent to mobiles with the following payload:
iOS => {"aps":{"alert":"[message]","title":"[message]" , "NotificationType": [recordType], "RecordId": [recordId], "badge":1, "content-available": 1, "sound": "default"}}

Android => {"alert":"[message]","title":"[message]" , "NotificationType": [recordType], "RecordId": [recordId], "badge":1, "content-available": 1, "sound": "default"}

LIVESTOCKS

API	Description
GET api/LIVESTOCKS	Get LIVESTOCKS list according to passed filters, sortings and paganation info