Back to top

WURCSFramework API

Welcome to WURCSFramework API!

Release Notes

The future date represents the release schedule.

Update August 1, 2021

  • Initial release of WURCSFramework API.

Support

Please contact the server administrator with any questions or problems, support@glycosmos.org.

WURCSFramework

WURCSFramework related APIs.

Important Info

These depend on WURCSFramework v1.0.1.

WURCS Validator API 1.0.1

Get the result of validation from a WURCS string.

WURCS Validator
GET/wurcsframework/wurcsvalidator/1.0.1/{wurcs}

Example URI

GET /wurcsframework/wurcsvalidator/1.0.1/WURCS%3D2.0%2F3%2C5%2C4%2F%5Ba2122h-1b_1-5_2%2ANCC%2F3%3DO%5D%5Ba1122h-1b_1-5%5D%5Ba1122h-1a_1-5%5D%2F1-1-2-3-3%2Fa4-b1_b4-c1_c3-d1_c6-e1
URI Parameters
HideShow
wurcs
string (required) Example: WURCS%3D2.0%2F3%2C5%2C4%2F%5Ba2122h-1b_1-5_2%2ANCC%2F3%3DO%5D%5Ba1122h-1b_1-5%5D%5Ba1122h-1a_1-5%5D%2F1-1-2-3-3%2Fa4-b1_b4-c1_c3-d1_c6-e1

URL-encoded WURCS string

Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "m_sInputString": "WURCS=2.0/3,5,4/[a2122h-1b_1-5_2*NCC/3=O][a1122h-1b_1-5][a1122h-1a_1-5]/1-1-2-3-3/a4-b1_b4-c1_c3-d1_c6-e1",
  "m_sStandardString": "WURCS=2.0/3,5,4/[a2122h-1b_1-5_2*NCC/3=O][a1122h-1b_1-5][a1122h-1a_1-5]/1-1-2-3-3/a4-b1_b4-c1_c3-d1_c6-e1",
  "m_mapTypeToReports": {
    "WARNING": [],
    "ERROR": []
  }
}

WURCS Validator
POST/wurcsframework/wurcsvalidator/1.0.1

Example URI

POST /wurcsframework/wurcsvalidator/1.0.1
Request  with body
HideShow
Headers
Content-Type: application/json
Body
{
  "wurcs": "WURCS=2.0/3,5,4/[a2122h-1b_1-5_2*NCC/3=O][a1122h-1b_1-5][a1122h-1a_1-5]/1-1-2-3-3/a4-b1_b4-c1_c3-d1_c6-e1"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "wurcs": {
      "type": "string",
      "description": "WURCS string"
    }
  },
  "required": [
    "wurcs"
  ]
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "m_sInputString": "WURCS=2.0/3,5,4/[a2122h-1b_1-5_2*NCC/3=O][a1122h-1b_1-5][a1122h-1a_1-5]/1-1-2-3-3/a4-b1_b4-c1_c3-d1_c6-e1",
  "m_sStandardString": "WURCS=2.0/3,5,4/[a2122h-1b_1-5_2*NCC/3=O][a1122h-1b_1-5][a1122h-1a_1-5]/1-1-2-3-3/a4-b1_b4-c1_c3-d1_c6-e1",
  "m_mapTypeToReports": {
    "WARNING": [],
    "ERROR": []
  }
}

WURCS to Mass API 1.0.1

Calculate the mass from the WURCS string.

Calculate Mass
GET/wurcsframework/wurcs2mass/1.0.1/{wurcs}

Example URI

GET /wurcsframework/wurcs2mass/1.0.1/WURCS%3D2.0%2F3%2C5%2C4%2F%5Ba2122h-1b_1-5_2%2ANCC%2F3%3DO%5D%5Ba1122h-1b_1-5%5D%5Ba1122h-1a_1-5%5D%2F1-1-2-3-3%2Fa4-b1_b4-c1_c3-d1_c6-e1
URI Parameters
HideShow
wurcs
string (required) Example: WURCS%3D2.0%2F3%2C5%2C4%2F%5Ba2122h-1b_1-5_2%2ANCC%2F3%3DO%5D%5Ba1122h-1b_1-5%5D%5Ba1122h-1a_1-5%5D%2F1-1-2-3-3%2Fa4-b1_b4-c1_c3-d1_c6-e1

URL-encoded WURCS string

Response  200
HideShow
Headers
Content-Type: text/plain
Body
910.32778

Calculate Mass
POST/wurcsframework/wurcs2mass/1.0.1

Example URI

POST /wurcsframework/wurcs2mass/1.0.1
Request  with body
HideShow
Headers
Content-Type: application/json
Body
{
  "wurcs": "WURCS=2.0/3,5,4/[a2122h-1b_1-5_2*NCC/3=O][a1122h-1b_1-5][a1122h-1a_1-5]/1-1-2-3-3/a4-b1_b4-c1_c3-d1_c6-e1"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "wurcs": {
      "type": "string",
      "description": "WURCS string"
    }
  },
  "required": [
    "wurcs"
  ]
}
Response  200
HideShow
Headers
Content-Type: text/plain
Body
910.32778

Generated by aglio on 10 Jun 2021