x [API].[dbo].[spr_genUDOSampleId] failed to return proper response.

struct
BASE_URI https:/.../v1/517090/
DATA_ORG_ID 506764
ID 0
OC_ID 0
OWNER_ID 2
PARENT_ID 0
PARENT_RELATION_ID 0
QRYPROPERTIES [empty string]
RESPJSON {"parent_type":"corporate","parent_id":506764,"type":"session","id":56235,"sub_type":" ","href_user":"/v1/o/user/680290","name":"pauli created a key for owais","login":"","password":"","_user_shared_key_id":"ajaz.agha@cooperativecomputing.com","_user_shared_key":"HMS_CRYPTO_TEST_KEY","_user_name":"GENEVA A BAKEMON","_corporate_name":"Crossroads Hospice of OKC","href":""}
REST
component com.qbos.REST
METHODS
_ENCODEBYTEARRAY
function _encodeByteArray
Arguments:
Name Required Type Default
bytes Optional Any  
encoding Optional Any  
ReturnType: Any
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
_GETMACINSTANCE
function _getMacInstance
Arguments:
Name Required Type Default
algorithm Optional Any  
key Optional Any  
ReturnType: Any
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
_HASHINPUTWITHALGORITHMANDKEY
function _hashInputWithAlgorithmAndKey
Arguments:
Name Required Type Default
algorithm Optional Any  
key Optional Any  
input Optional Any  
ReturnType: Any
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
AUTHENTICATE
function AUTHENTICATE
Arguments:
Name Required Type Default
login_id Optional string [empty string]
password Optional string [empty string]
corporate_id Optional numeric 0
ReturnType: string
Roles:  
Access: public
Output: no
DisplayName:  
Hint:
Description:  
CREATEAUTHHASH
function createAuthHash
Arguments:
Name Required Type Default
key_id Required string  
key Required string  
http_method Required string  
uri Required string  
date_utc Required string  
hash_id Required string  
salt Required string  
payload Required string  
ReturnType: string
Roles:  
Access: private
Output: no
DisplayName:  
Hint:  
Description:  
GET
function GET
Arguments:
Name Required Type Default
uri Required string  
salt Optional string [runtime expression]
ReturnType: string
Roles:  
Access: public
Output: no
DisplayName:  
Hint:  
Description:  
GETAPIVERSION
function getApiVersion
Arguments:none
ReturnType: string
Roles:  
Access: private
Output: no
DisplayName:  
Hint:  
Description:  
GETBASEURI
function getBaseUri
Arguments:none
ReturnType: string
Roles:  
Access: private
Output: no
DisplayName:  
Hint:  
Description:  
GETBASICAUTHHASH
function getBasicAuthHash
Arguments:
Name Required Type Default
auth_hash Required string  
ReturnType: string
Roles:  
Access: private
Output: no
DisplayName:  
Hint:  
Description:  
GETHASHID
function getHashId
Arguments:none
ReturnType: string
Roles:  
Access: private
Output: no
DisplayName:  
Hint:  
Description:  
GETHOST
function getHost
Arguments:none
ReturnType: string
Roles:  
Access: private
Output: no
DisplayName:  
Hint:  
Description:  
GETKEY
function getKey
Arguments:none
ReturnType: string
Roles:  
Access: public
Output: no
DisplayName:  
Hint:  
Description:  
GETKEYID
function getKeyId
Arguments:none
ReturnType: string
Roles:  
Access: public
Output: no
DisplayName:  
Hint:  
Description:  
GETPAYLOAD
function getPayload
Arguments:
Name Required Type Default
resp Required any  
ReturnType: string
Roles:  
Access: private
Output: no
DisplayName:  
Hint: Returns one of these: a)an exception, b)resource as JSON or c) error JSON as {"title": "","status": "","detail": "", "type": "about:blank", "instance": ""}
Description:  
GETPORT
function getPort
Arguments:none
ReturnType: numeric
Roles:  
Access: private
Output: no
DisplayName:  
Hint:  
Description:  
GETPROTOCOL
function getProtocol
Arguments:none
ReturnType: string
Roles:  
Access: private
Output: no
DisplayName:  
Hint:  
Description:  
GETSALT
function getSalt
Arguments:none
ReturnType: string
Roles:  
Access: private
Output: no
DisplayName:  
Hint:  
Description:  
GETURL
function getUrl
Arguments:
Name Required Type Default
uri Required string  
ReturnType: string
Roles:  
Access: private
Output: no
DisplayName:  
Hint:  
Description:  
GETUTCDATE
function getUtcDate
Arguments:none
ReturnType: string
Roles:  
Access: private
Output: no
DisplayName:  
Hint:  
Description:  
HMACMD5
function hmacMd5
Arguments:
Name Required Type Default
key Optional Any  
input Optional Any  
encoding Optional Any  
ReturnType: Any
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
HMACSHA1
function hmacSha1
Arguments:
Name Required Type Default
key Optional Any  
input Optional Any  
encoding Optional Any  
ReturnType: Any
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
HMACSHA256
function hmacSha256
Arguments:
Name Required Type Default
key Optional Any  
input Optional Any  
encoding Optional Any  
ReturnType: Any
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
INIT
function init
Arguments:
Name Required Type Default
protocol Required string  
host Optional string [empty string]
domain Optional string [empty string]
ip Optional string [empty string]
port Optional numeric 8080
ReturnType: component
Roles:  
Access: public
Output: no
DisplayName:  
Hint:  
Description:  
ISINITED
function isInited
Arguments:none
ReturnType: boolean
Roles:  
Access: private
Output: no
DisplayName:  
Hint:  
Description:  
POST
function POST
Arguments:
Name Required Type Default
uri Required string  
payload Optional string  
salt Optional string [runtime expression]
ReturnType: string
Roles:  
Access: public
Output: no
DisplayName:  
Hint:  
Description:  
PUT
function PUT
Arguments:
Name Required Type Default
uri Required string  
payload Optional string  
salt Optional string [runtime expression]
ReturnType: string
Roles:  
Access: public
Output: no
DisplayName:  
Hint:  
Description:  
SETAPIKEYS
function setApiKeys
Arguments:
Name Required Type Default
key_id Required string  
key Required string  
ReturnType: component
Roles:  
Access: public
Output: no
DisplayName:  
Hint:  
Description:  
THROWERROR
function throwError
Arguments:
Name Required Type Default
resp Required any  
ReturnType: void
Roles:  
Access: private
Output: no
DisplayName:  
Hint:  
Description:  
RMSG 0,12059,0,0,0,506764
STORED_PROC_NAME_FOR_GET [empty string]
TYPE NVISITRATES
USR_ID 2
VENDOR_ORG_ID 517090
VIEW_NAME [api].[dbo].v_517090_NVISITRATES
X 0
Y 0
QBOS REST API documentation for NVISITRATES

QBOS REST API documentation (NVISITRATES)

(return to Main Document)

Introduction

The NVISITRATES API allows client applications to maintain NVISITRATES data record sets.

Audience

This developer's guide is intended for software developers needing a technical reference for using the QBOS REST API. The information you find in this guide is written by software engineering, and is authoritative on how the API behaves.

Additional resources, information about this guide

Occasionally, we make a mistake in this documentation, or unknowingly break a feature that you depend on. If this has happened to you, we apologize! You can help us fix the issue by contacting us at: pkajaani@qbos.com. We appreciate your help.

Getting Started

To place any request in a QBOS API application from a third party application you need to first authenticate your user account and set/calculate values for the following request headers: x-qbos-id, x-qbos-nonce, x-qbos-date-utc, x-qbos-hash-version, x-qbos-auth

See details in Authentication Documentation.

Custom resource vs. standard resource URI format

Custom resource (a.k.a applet) URI contains the resource vendor id in place of "/o/" in the standard object URI. Compare: .../v1/o/...with .../v1/{vendor_id}/...

NVISITRATES properties

Properties prefixed with '_' (underscore) are read-only properties. i.e. POST and PUT processing will ignore these properties.

Name Type Max
Length		 Numeric Required
For POST		 Filterable Default Description
_client_Id bigint Yes NULL This is the Data Org Id.
_owner_Id bigint Yes Yes NULL This is the user id of the record owner. Defaults to the creatorOpid.
_creator_Opid bigint Yes Yes NULL This is the user id of the original record submitter.
_create_Date datetime No {timestamp}   Not enterable upon Insert. System sets this date upon record creation.
status_id int Yes Yes NULL The status id of the record. Taken from the Life Cycle statuses in ADS.
_status_Change_Date datetime No NULL Not enterable. System sets this date whenever the statusid is changed.

NVISITRATES Relationships

Parent and Child relations to NVISITRATES.

Note that the only Required status on relationships that affect a POST of an object are on the parent relations. A Required status on a child relation is only meaningful when POSTing the child object.

Linking during POST: a custom object record can be linked to a parent or child record (custom or standard) during POST by including (in the payload) the realtion id paired with the parent or child object record being linked to. For example: { "REl_2848" : 1832 }      Multiple links may be created in the same POST.

Relation Id Cardinality
(Parent-to-Child)		 Required
For POST		 Links Up To Is Unary?*
n/a 2147482647   Corporate
Parent Relations
↑
NVISITRATES
↓
Child Relations
Relation Id Cardinality
(Parent-to-Child)		 Required
**on POST of child		 Links Down To  
REL_2848 1-Many Yes** Interdisciplinary_Group  
REL_3216 1-Many Yes** Medication_PU_Dosage  
 



Read NVISITRATES by id:

GET https:/.../v1/517090/NVISITRATES/{id}

Response codes:

  • 200 - OK
  • 404 - Not found or user does not have permission to access resources of this type.
  • 400 - Client error
  • 500 - Server error

Response data: GET https:/.../v1/517090/NVISITRATES/0
Unauthorized request.

Read NVISITRATES by parent id:

GET https:/.../v1/517090/{parent_relation_id}/{parent_id}/links/NVISITRATES[?{filter}]

Response codes:

  • 400 - Client error
  • 500 - Server error
  • 404 - Not found or user does not have permission to access resources of this type.
  • 200 - OK

Response data: GET https:/.../v1/517090/0/{parent_id}/links/NVISITRATES
Unauthorized request.

Read NVISITRATES by filter:

GET https:/.../v1/517090/NVISITRATES[?{filter}]

Response codes:

  • 200 - OK
  • 400 - Client error
  • 404 - Not found or user does not have permission to access resources of this type.
  • 500 - Server error

Response data: GET https:/.../v1/517090/NVISITRATES?id=0
Unauthorized request.

Create NVISITRATES:

POST https:/.../v1/517090/NVISITRATES

Request data [See properties]:

Response codes:

Update NVISITRATES:

PUT https:/.../v1/517090/NVISITRATES/{id}

Request data [See properties]:

Response codes:

  • 200 - OK Content returned [See response data]
  • 204 - OK No content
  • 400 - Client error
  • 404 - Not found
  • 500 - Server error

Delete NVISITRATES:

DELETE https:/.../v1/517090/NVISITRATES/{id}

The "id" in JSON payload is required to match the {id} in the URI to ensure that deletion requests are intended and safe

Response codes:

  • 204 - OK
  • 400 - Client error
  • 404 - Not found
  • 500 - Server error

Create Link for NVISITRATES:

POST https:/.../v1/517090/{relation_id}/{link_to_id}/links/NVISITRATES/{id}


{relation_id} can indicate either a parent or a child relation.

Response codes:

  • 204 - OK
  • 400 - Client error
  • 404 - Not found
  • 500 - Server error

Delete Link for NVISITRATES:

DELETE https:/.../v1/517090/{parent_relation_id}/{parent_id}/links/NVISITRATES/{id}


Deleting a link from NVISITRATES down to a child object must be explicitly indicated by negating the relation id:

DELETE https:/.../v1/517090/{-child_relation_id}/{child_id}/links/NVISITRATES/{id}

Response codes:

  • 204 - OK
  • 400 - Client error
  • 404 - Not found
  • 500 - Server error