Templates API

Get classification code details by classification group version guid and classification code version guid.

Request

Request URL

https://api.cobuilder.com/templates-management/api/v2/classifications/{classificationVersionGuid}/classification-codes/{classificationCodeVersionGuid}[?culture]

Request parameters

classificationVersionGuid

string

Classification group version guid.
classificationCodeVersionGuid

string

Parent classification code version guid.
culture (optional)

string

Culture for translation.

Request body

Responses

200 OK

Returns detailed information about classification code and its children codes.

Representations

{
  "allOf": [
    {
      "allOf": [
        {
          "allOf": [
            {
              "allOf": [
                {
                  "type": "object",
                  "description": "Concept summary.",
                  "properties": {
                    "guid": {
                      "type": "string",
                      "description": "Gets or sets concept guid."
                    },
                    "versionGuid": {
                      "type": "string",
                      "description": "Gets or sets version guid."
                    },
                    "defaultName": {
                      "type": "string",
                      "description": "Gets or sets preferred full name in International English."
                    },
                    "name": {
                      "type": "string",
                      "description": "Gets or sets preferred full name in passed culture."
                    }
                  }
                },
                {
                  "type": "object",
                  "properties": {
                    "defaultTechnicalDefinition": {
                      "type": "string"
                    },
                    "technicalDefinition": {
                      "type": "string"
                    }
                  }
                }
              ]
            },
            {
              "type": "object",
              "required": [
                "createdOn"
              ],
              "properties": {
                "createdOn": {
                  "type": "string",
                  "format": "date-time"
                },
                "createdBy": {
                  "type": "string"
                },
                "changedOn": {
                  "type": "string",
                  "format": "date-time"
                }
              }
            }
          ]
        },
        {
          "type": "object",
          "required": [
            "hasCodes"
          ],
          "properties": {
            "classNumber": {
              "type": "string"
            },
            "hasCodes": {
              "type": "boolean"
            }
          }
        }
      ]
    },
    {
      "type": "object",
      "properties": {
        "codes": {
          "type": "array",
          "items": {
            "allOf": [
              {
                "allOf": [
                  {
                    "type": "object",
                    "description": "Concept summary.",
                    "properties": {
                      "guid": {
                        "type": "string",
                        "description": "Gets or sets concept guid."
                      },
                      "versionGuid": {
                        "type": "string",
                        "description": "Gets or sets version guid."
                      },
                      "defaultName": {
                        "type": "string",
                        "description": "Gets or sets preferred full name in International English."
                      },
                      "name": {
                        "type": "string",
                        "description": "Gets or sets preferred full name in passed culture."
                      }
                    }
                  },
                  {
                    "type": "object",
                    "properties": {
                      "defaultTechnicalDefinition": {
                        "type": "string"
                      },
                      "technicalDefinition": {
                        "type": "string"
                      }
                    }
                  }
                ]
              },
              {
                "type": "object",
                "required": [
                  "hasCodes"
                ],
                "properties": {
                  "classNumber": {
                    "type": "string"
                  },
                  "hasCodes": {
                    "type": "boolean"
                  }
                }
              }
            ]
          }
        }
      }
    }
  ]
}

Sample
Schema

{
  "guid": "string",
  "versionGuid": "string",
  "defaultName": "string",
  "name": "string",
  "defaultTechnicalDefinition": "string",
  "technicalDefinition": "string",
  "createdOn": "string",
  "createdBy": "string",
  "changedOn": "string",
  "classNumber": "string",
  "hasCodes": true,
  "codes": [
    {
      "guid": "string",
      "versionGuid": "string",
      "defaultName": "string",
      "name": "string",
      "defaultTechnicalDefinition": "string",
      "technicalDefinition": "string",
      "classNumber": "string",
      "hasCodes": true
    }
  ]
}

{
  "allOf": [
    {
      "allOf": [
        {
          "allOf": [
            {
              "allOf": [
                {
                  "type": "object",
                  "description": "Concept summary.",
                  "properties": {
                    "guid": {
                      "type": "string",
                      "description": "Gets or sets concept guid."
                    },
                    "versionGuid": {
                      "type": "string",
                      "description": "Gets or sets version guid."
                    },
                    "defaultName": {
                      "type": "string",
                      "description": "Gets or sets preferred full name in International English."
                    },
                    "name": {
                      "type": "string",
                      "description": "Gets or sets preferred full name in passed culture."
                    }
                  }
                },
                {
                  "type": "object",
                  "properties": {
                    "defaultTechnicalDefinition": {
                      "type": "string"
                    },
                    "technicalDefinition": {
                      "type": "string"
                    }
                  }
                }
              ]
            },
            {
              "type": "object",
              "required": [
                "createdOn"
              ],
              "properties": {
                "createdOn": {
                  "type": "string",
                  "format": "date-time"
                },
                "createdBy": {
                  "type": "string"
                },
                "changedOn": {
                  "type": "string",
                  "format": "date-time"
                }
              }
            }
          ]
        },
        {
          "type": "object",
          "required": [
            "hasCodes"
          ],
          "properties": {
            "classNumber": {
              "type": "string"
            },
            "hasCodes": {
              "type": "boolean"
            }
          }
        }
      ]
    },
    {
      "type": "object",
      "properties": {
        "codes": {
          "type": "array",
          "items": {
            "allOf": [
              {
                "allOf": [
                  {
                    "type": "object",
                    "description": "Concept summary.",
                    "properties": {
                      "guid": {
                        "type": "string",
                        "description": "Gets or sets concept guid."
                      },
                      "versionGuid": {
                        "type": "string",
                        "description": "Gets or sets version guid."
                      },
                      "defaultName": {
                        "type": "string",
                        "description": "Gets or sets preferred full name in International English."
                      },
                      "name": {
                        "type": "string",
                        "description": "Gets or sets preferred full name in passed culture."
                      }
                    }
                  },
                  {
                    "type": "object",
                    "properties": {
                      "defaultTechnicalDefinition": {
                        "type": "string"
                      },
                      "technicalDefinition": {
                        "type": "string"
                      }
                    }
                  }
                ]
              },
              {
                "type": "object",
                "required": [
                  "hasCodes"
                ],
                "properties": {
                  "classNumber": {
                    "type": "string"
                  },
                  "hasCodes": {
                    "type": "boolean"
                  }
                }
              }
            ]
          }
        }
      }
    }
  ]
}

Sample
Schema

{
  "guid": "string",
  "versionGuid": "string",
  "defaultName": "string",
  "name": "string",
  "defaultTechnicalDefinition": "string",
  "technicalDefinition": "string",
  "createdOn": "string",
  "createdBy": "string",
  "changedOn": "string",
  "classNumber": "string",
  "hasCodes": true,
  "codes": [
    {
      "guid": "string",
      "versionGuid": "string",
      "defaultName": "string",
      "name": "string",
      "defaultTechnicalDefinition": "string",
      "technicalDefinition": "string",
      "classNumber": "string",
      "hasCodes": true
    }
  ]
}

{
  "allOf": [
    {
      "allOf": [
        {
          "allOf": [
            {
              "allOf": [
                {
                  "type": "object",
                  "description": "Concept summary.",
                  "properties": {
                    "guid": {
                      "type": "string",
                      "description": "Gets or sets concept guid."
                    },
                    "versionGuid": {
                      "type": "string",
                      "description": "Gets or sets version guid."
                    },
                    "defaultName": {
                      "type": "string",
                      "description": "Gets or sets preferred full name in International English."
                    },
                    "name": {
                      "type": "string",
                      "description": "Gets or sets preferred full name in passed culture."
                    }
                  }
                },
                {
                  "type": "object",
                  "properties": {
                    "defaultTechnicalDefinition": {
                      "type": "string"
                    },
                    "technicalDefinition": {
                      "type": "string"
                    }
                  }
                }
              ]
            },
            {
              "type": "object",
              "required": [
                "createdOn"
              ],
              "properties": {
                "createdOn": {
                  "type": "string",
                  "format": "date-time"
                },
                "createdBy": {
                  "type": "string"
                },
                "changedOn": {
                  "type": "string",
                  "format": "date-time"
                }
              }
            }
          ]
        },
        {
          "type": "object",
          "required": [
            "hasCodes"
          ],
          "properties": {
            "classNumber": {
              "type": "string"
            },
            "hasCodes": {
              "type": "boolean"
            }
          }
        }
      ]
    },
    {
      "type": "object",
      "properties": {
        "codes": {
          "type": "array",
          "items": {
            "allOf": [
              {
                "allOf": [
                  {
                    "type": "object",
                    "description": "Concept summary.",
                    "properties": {
                      "guid": {
                        "type": "string",
                        "description": "Gets or sets concept guid."
                      },
                      "versionGuid": {
                        "type": "string",
                        "description": "Gets or sets version guid."
                      },
                      "defaultName": {
                        "type": "string",
                        "description": "Gets or sets preferred full name in International English."
                      },
                      "name": {
                        "type": "string",
                        "description": "Gets or sets preferred full name in passed culture."
                      }
                    }
                  },
                  {
                    "type": "object",
                    "properties": {
                      "defaultTechnicalDefinition": {
                        "type": "string"
                      },
                      "technicalDefinition": {
                        "type": "string"
                      }
                    }
                  }
                ]
              },
              {
                "type": "object",
                "required": [
                  "hasCodes"
                ],
                "properties": {
                  "classNumber": {
                    "type": "string"
                  },
                  "hasCodes": {
                    "type": "boolean"
                  }
                }
              }
            ]
          }
        }
      }
    }
  ]
}

400 Bad Request

Representations

{
  "type": "object",
  "additionalProperties": {},
  "properties": {
    "type": {
      "type": "string"
    },
    "title": {
      "type": "string"
    },
    "status": {
      "type": "integer",
      "format": "int32"
    },
    "detail": {
      "type": "string"
    },
    "instance": {
      "type": "string"
    }
  }
}

Sample
Schema

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}

{
  "type": "object",
  "additionalProperties": {},
  "properties": {
    "type": {
      "type": "string"
    },
    "title": {
      "type": "string"
    },
    "status": {
      "type": "integer",
      "format": "int32"
    },
    "detail": {
      "type": "string"
    },
    "instance": {
      "type": "string"
    }
  }
}

Sample
Schema

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}

{
  "type": "object",
  "additionalProperties": {},
  "properties": {
    "type": {
      "type": "string"
    },
    "title": {
      "type": "string"
    },
    "status": {
      "type": "integer",
      "format": "int32"
    },
    "detail": {
      "type": "string"
    },
    "instance": {
      "type": "string"
    }
  }
}

401 Unauthorized

Representations

{
  "type": "object",
  "additionalProperties": {},
  "properties": {
    "type": {
      "type": "string"
    },
    "title": {
      "type": "string"
    },
    "status": {
      "type": "integer",
      "format": "int32"
    },
    "detail": {
      "type": "string"
    },
    "instance": {
      "type": "string"
    }
  }
}

Sample
Schema

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}

{
  "type": "object",
  "additionalProperties": {},
  "properties": {
    "type": {
      "type": "string"
    },
    "title": {
      "type": "string"
    },
    "status": {
      "type": "integer",
      "format": "int32"
    },
    "detail": {
      "type": "string"
    },
    "instance": {
      "type": "string"
    }
  }
}

Sample
Schema

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}

{
  "type": "object",
  "additionalProperties": {},
  "properties": {
    "type": {
      "type": "string"
    },
    "title": {
      "type": "string"
    },
    "status": {
      "type": "integer",
      "format": "int32"
    },
    "detail": {
      "type": "string"
    },
    "instance": {
      "type": "string"
    }
  }
}

403 Forbidden

Representations

{
  "type": "object",
  "additionalProperties": {},
  "properties": {
    "type": {
      "type": "string"
    },
    "title": {
      "type": "string"
    },
    "status": {
      "type": "integer",
      "format": "int32"
    },
    "detail": {
      "type": "string"
    },
    "instance": {
      "type": "string"
    }
  }
}

Sample
Schema

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}

{
  "type": "object",
  "additionalProperties": {},
  "properties": {
    "type": {
      "type": "string"
    },
    "title": {
      "type": "string"
    },
    "status": {
      "type": "integer",
      "format": "int32"
    },
    "detail": {
      "type": "string"
    },
    "instance": {
      "type": "string"
    }
  }
}

Sample
Schema

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}

{
  "type": "object",
  "additionalProperties": {},
  "properties": {
    "type": {
      "type": "string"
    },
    "title": {
      "type": "string"
    },
    "status": {
      "type": "integer",
      "format": "int32"
    },
    "detail": {
      "type": "string"
    },
    "instance": {
      "type": "string"
    }
  }
}

404 Not Found

Representations

{
  "type": "object",
  "additionalProperties": {},
  "properties": {
    "type": {
      "type": "string"
    },
    "title": {
      "type": "string"
    },
    "status": {
      "type": "integer",
      "format": "int32"
    },
    "detail": {
      "type": "string"
    },
    "instance": {
      "type": "string"
    }
  }
}

Sample
Schema

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}

{
  "type": "object",
  "additionalProperties": {},
  "properties": {
    "type": {
      "type": "string"
    },
    "title": {
      "type": "string"
    },
    "status": {
      "type": "integer",
      "format": "int32"
    },
    "detail": {
      "type": "string"
    },
    "instance": {
      "type": "string"
    }
  }
}

Sample
Schema

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}

{
  "type": "object",
  "additionalProperties": {},
  "properties": {
    "type": {
      "type": "string"
    },
    "title": {
      "type": "string"
    },
    "status": {
      "type": "integer",
      "format": "int32"
    },
    "detail": {
      "type": "string"
    },
    "instance": {
      "type": "string"
    }
  }
}

Code samples

@ECHO OFF

curl -v -X GET "https://api.cobuilder.com/templates-management/api/v2/classifications/{classificationVersionGuid}/classification-codes/{classificationCodeVersionGuid}?culture={string}"

--data-ascii "{body}"

using System;
using System.Net.Http.Headers;
using System.Text;
using System.Net.Http;
using System.Web;

namespace CSHttpClientSample
{
    static class Program
    {
        static void Main()
        {
            MakeRequest();
            Console.WriteLine("Hit ENTER to exit...");
            Console.ReadLine();
        }
        
        static async void MakeRequest()
        {
            var client = new HttpClient();
            var queryString = HttpUtility.ParseQueryString(string.Empty);


            // Request parameters
            queryString["culture"] = "{string}";
            var uri = "https://api.cobuilder.com/templates-management/api/v2/classifications/{classificationVersionGuid}/classification-codes/{classificationCodeVersionGuid}?" + queryString;

            var response = await client.GetAsync(uri);
        }
    }
}

// // This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
import java.net.URI;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.client.utils.URIBuilder;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.util.EntityUtils;

public class JavaSample 
{
    public static void main(String[] args) 
    {
        HttpClient httpclient = HttpClients.createDefault();

        try
        {
            URIBuilder builder = new URIBuilder("https://api.cobuilder.com/templates-management/api/v2/classifications/{classificationVersionGuid}/classification-codes/{classificationCodeVersionGuid}");

            builder.setParameter("culture", "{string}");

            URI uri = builder.build();
            HttpGet request = new HttpGet(uri);


            // Request body
            StringEntity reqEntity = new StringEntity("{body}");
            request.setEntity(reqEntity);

            HttpResponse response = httpclient.execute(request);
            HttpEntity entity = response.getEntity();

            if (entity != null) 
            {
                System.out.println(EntityUtils.toString(entity));
            }
        }
        catch (Exception e)
        {
            System.out.println(e.getMessage());
        }
    }
}

<!DOCTYPE html>
<html>
<head>
    <title>JSSample</title>
    <script src="http://ajax.googleapis.com/ajax/libs/jquery/1.9.0/jquery.min.js"></script>
</head>
<body>

<script type="text/javascript">
    $(function() {
        var params = {
            // Request parameters
            "culture": "{string}",
        };
      
        $.ajax({
            url: "https://api.cobuilder.com/templates-management/api/v2/classifications/{classificationVersionGuid}/classification-codes/{classificationCodeVersionGuid}?" + $.param(params),
            beforeSend: function(xhrObj){
                // Request headers
            },
            type: "GET",
            // Request body
            data: "{body}",
        })
        .done(function(data) {
            alert("success");
        })
        .fail(function() {
            alert("error");
        });
    });
</script>
</body>
</html>

#import <Foundation/Foundation.h>

int main(int argc, const char * argv[])
{
    NSAutoreleasePool * pool = [[NSAutoreleasePool alloc] init];
    
    NSString* path = @"https://api.cobuilder.com/templates-management/api/v2/classifications/{classificationVersionGuid}/classification-codes/{classificationCodeVersionGuid}";
    NSArray* array = @[
                         // Request parameters
                         @"entities=true",
                         @"culture={string}",
                      ];
    
    NSString* string = [array componentsJoinedByString:@"&"];
    path = [path stringByAppendingFormat:@"?%@", string];

    NSLog(@"%@", path);

    NSMutableURLRequest* _request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:path]];
    [_request setHTTPMethod:@"GET"];
    // Request headers
    // Request body
    [_request setHTTPBody:[@"{body}" dataUsingEncoding:NSUTF8StringEncoding]];
    
    NSURLResponse *response = nil;
    NSError *error = nil;
    NSData* _connectionData = [NSURLConnection sendSynchronousRequest:_request returningResponse:&response error:&error];

    if (nil != error)
    {
        NSLog(@"Error: %@", error);
    }
    else
    {
        NSError* error = nil;
        NSMutableDictionary* json = nil;
        NSString* dataString = [[NSString alloc] initWithData:_connectionData encoding:NSUTF8StringEncoding];
        NSLog(@"%@", dataString);
        
        if (nil != _connectionData)
        {
            json = [NSJSONSerialization JSONObjectWithData:_connectionData options:NSJSONReadingMutableContainers error:&error];
        }
        
        if (error || !json)
        {
            NSLog(@"Could not parse loaded json with error:%@", error);
        }
        
        NSLog(@"%@", json);
        _connectionData = nil;
    }
    
    [pool drain];

    return 0;
}

<?php
// This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
require_once 'HTTP/Request2.php';

$request = new Http_Request2('https://api.cobuilder.com/templates-management/api/v2/classifications/{classificationVersionGuid}/classification-codes/{classificationCodeVersionGuid}');
$url = $request->getUrl();

$headers = array(
    // Request headers
);

$request->setHeader($headers);

$parameters = array(
    // Request parameters
    'culture' => '{string}',
);

$url->setQueryVariables($parameters);

$request->setMethod(HTTP_Request2::METHOD_GET);

// Request body
$request->setBody("{body}");

try
{
    $response = $request->send();
    echo $response->getBody();
}
catch (HttpException $ex)
{
    echo $ex;
}

?>

########### Python 2.7 #############
import httplib, urllib, base64

headers = {
}

params = urllib.urlencode({
    # Request parameters
    'culture': '{string}',
})

try:
    conn = httplib.HTTPSConnection('api.cobuilder.com')
    conn.request("GET", "/templates-management/api/v2/classifications/{classificationVersionGuid}/classification-codes/{classificationCodeVersionGuid}?%s" % params, "{body}", headers)
    response = conn.getresponse()
    data = response.read()
    print(data)
    conn.close()
except Exception as e:
    print("[Errno {0}] {1}".format(e.errno, e.strerror))

####################################

########### Python 3.2 #############
import http.client, urllib.request, urllib.parse, urllib.error, base64

headers = {
}

params = urllib.parse.urlencode({
    # Request parameters
    'culture': '{string}',
})

try:
    conn = http.client.HTTPSConnection('api.cobuilder.com')
    conn.request("GET", "/templates-management/api/v2/classifications/{classificationVersionGuid}/classification-codes/{classificationCodeVersionGuid}?%s" % params, "{body}", headers)
    response = conn.getresponse()
    data = response.read()
    print(data)
    conn.close()
except Exception as e:
    print("[Errno {0}] {1}".format(e.errno, e.strerror))

####################################

require 'net/http'

uri = URI('https://api.cobuilder.com/templates-management/api/v2/classifications/{classificationVersionGuid}/classification-codes/{classificationCodeVersionGuid}')

query = URI.encode_www_form({
    # Request parameters
    'culture' => '{string}'
})
if query.length > 0
  if uri.query && uri.query.length > 0
    uri.query += '&' + query
  else
    uri.query = query
  end
end

request = Net::HTTP::Get.new(uri.request_uri)
# Request body
request.body = "{body}"

response = Net::HTTP.start(uri.host, uri.port, :use_ssl => uri.scheme == 'https') do |http|
    http.request(request)
end

puts response.body