Jump to

• Request
• Response

Generate a Schema Implementation Guide

get

/ic/api/b2b/v1/schemas/{schemaId}/guide

Generates implementation guide for the schema.

Request

Path Parameters

• schemaId: string
  B2B schema id.

Query Parameters

• format: string
  document format.

  Default Value: html
• standardId: string
  document standard id.
• transactionId: string

  document transaction id.

  Example:

  /b2b/v1/schemas/STANDARD/guide?format=html&standardId=X12&versionId=4010&transactionId=100

• versionId: string
  document version id.

Back to Top

Response

Supported Media Types

• text/plain

200 Response

Successful operation

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object"
    }
}

Nested Schema : items

Type: object

400 Response

Bad request

500 Response

Server error

Back to Top