x QBOS REST API documentation for COUNTYCODES

QBOS REST API documentation (COUNTYCODES)

(return to Main Document)

Introduction

The COUNTYCODES API allows client applications to maintain COUNTYCODES 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}/...

COUNTYCODES 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 5807 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.
State nvarchar 2 Yes NULL This property is populated by a Type 2 Value List.
Click here for the appropriate API and sample of value options for this column.
County nvarchar 30 Yes NULL
Is_Rural_CBSA bit Yes Yes NULL This property is populated by a Type 1 Value List.
Click here for the appropriate API and sample of value options for this column.
SSA_Code nvarchar 30 Yes NULL
CBSA_Code nvarchar 30 Yes NULL
Is_Rural_County bit Yes Yes NULL This property is populated by a Type 1 Value List.
Click here for the appropriate API and sample of value options for this column.
Effective_Date datetime Yes NULL
Expiration_Date datetime Yes NULL

Read COUNTYCODES by id:

GET https:/.../v1/517090/COUNTYCODES/{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/COUNTYCODES/2
Unauthorized request.

Read COUNTYCODES by parent id:

GET https:/.../v1/517090/{parent_relation_id}/{parent_id}/links/COUNTYCODES[?{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/506764/links/COUNTYCODES
Unauthorized request.

Read COUNTYCODES by filter:

GET https:/.../v1/517090/COUNTYCODES[?{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/COUNTYCODES?id=2
Unauthorized request.

Create COUNTYCODES:

POST https:/.../v1/517090/COUNTYCODES

Request data [See properties]:

Response codes:

Update COUNTYCODES:

PUT https:/.../v1/517090/COUNTYCODES/{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 COUNTYCODES:

DELETE https:/.../v1/517090/COUNTYCODES/{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 COUNTYCODES:

POST https:/.../v1/517090/{relation_id}/{link_to_id}/links/COUNTYCODES/{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 COUNTYCODES:

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


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

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

Response codes:

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