EDI Management API (1.0.9)

Download OpenAPI specification:Download

EDI validation, translation, and management system.

Authentication

APIKeyScheme

API Key from channel configuration

Security Scheme Type API Key
Header parameter name: X-FT-API-Key

OAuth2Scheme

Token-based auth using OAuth2

Security Scheme Type OAuth2
clientCredentials OAuth Flow
Token URL: /token
Scopes:
    authorizationCode OAuth Flow
    Authorization URL: /authorize
    Token URL: /token
    Scopes:

      Transactions

      Perform EDI validation and translation to XML, or translation from XML to EDI

      Submit an EDI interchange for validation and conversion (Persistent)

      Submit an EDI interchange for validation and conversion to a back-end application. This operation accepts a well-formed EDI interchange and (when successfully translated) responds with an EDI format corresponding to the input (e.g. an X12 997). The transformed interchange is written to local server storage (other other queuing system) to be retrieved by or forwarded to a back-end application for further processing.

      Authorizations:
      Request Body schema:

      EDI payload in either X12 or EDIFACT format

      object

      Properly formatted EDI interchange

      Responses

      Submit an XML format interchange for conversion to EDI (Persistent)

      Submit an XML interchange for validation and conversion to EDI. This operation accepts a well-formed XML interchange and (when successfully translated) responds with an EDI format corresponding to the input. Information about the interchange (transaction control numbers, types of transactions, etc.) is persisted to the Fresno database for tracking and to support acknowledgement confirmation.

      Authorizations:
      Request Body schema: application/xml

      XML payload to be converted to EDI

      object

      Properly formatted XML interchange

      Responses

      Translate an EDI interchange (Persistent)

      Translate an EDI interchange and persist meta information and validation status in history. This operation accepts a well-formed EDI interchange and (when successfully translated) responds with an XML representation of the interchange. The Link header includes a URI that may be used for retrieval of validation/status information pertaining to the interchange.

      Authorizations:
      Request Body schema:

      EDI payload in either X12 or EDIFACT format

      object

      Properly formatted EDI interchange

      Responses

      Response samples

      Content type
      { }

      Validate an EDI interchange (Persistent)

      Validate an EDI interchange and persist meta information and validation status in history. This operation accepts a well-formed EDI interchange and responds with either an EDI format corresponding to the input or a JSON format describing the result of validation.

      Authorizations:
      Request Body schema:

      EDI payload in either X12 or EDIFACT format

      object

      Properly formatted EDI interchange

      Responses

      Response samples

      Content type
      No sample

      History

      Channel transaction history

      Retrieve a list of functional groups for a particular interchange

      Authorizations:
      query Parameters
      interchangeId
      required
      string

      Interchange identifier

      Responses

      Response samples

      Content type
      application/json
      [
      • {
        }
      ]

      Retrieve a functional group by identifier

      Authorizations:
      path Parameters
      id
      required
      string

      Record identifier

      Responses

      Response samples

      Content type
      application/json
      {
      • "ackCode": "string",
      • "agencyCode": "string",
      • "channel": {
        },
      • "controlCount": "string",
      • "controlReference": "string",
      • "createdAt": "2019-08-24T14:15:22Z",
      • "industryCode": "string",
      • "release": "string",
      • "updatedAt": "2019-08-24T14:15:22Z",
      • "uuid": "string",
      • "version": "string",
      • "createTimestamp": "2019-08-24T14:15:22Z",
      • "errors": [
        ],
      • "receiverId": "string",
      • "receiverIdType": "string",
      • "senderId": "string",
      • "senderIdType": "string",
      • "type": "string",
      • "controlEntity": {
        }
      }

      Retrieve a list of interchanges

      Authorizations:
      query Parameters
      page
      required
      integer <int32>
      Default: 1

      Page number

      Responses

      Response samples

      Content type
      application/json
      [
      • {
        }
      ]

      Retrieve an interchange by identifier

      Authorizations:
      path Parameters
      id
      required
      string

      Responses

      Response samples

      Content type
      application/json
      {
      • "ackCode": "string",
      • "agencyCode": "string",
      • "channel": {
        },
      • "controlCount": "string",
      • "controlReference": "string",
      • "createdAt": "2019-08-24T14:15:22Z",
      • "industryCode": "string",
      • "release": "string",
      • "updatedAt": "2019-08-24T14:15:22Z",
      • "uuid": "string",
      • "version": "string",
      • "ackRequested": "string",
      • "componentSeparator": "string",
      • "createTimestamp": "2019-08-24T14:15:22Z",
      • "decimalMark": "string",
      • "direction": "string",
      • "elementSeparator": "string",
      • "errors": [
        ],
      • "interchangeControl": {
        },
      • "messageDigest": "string",
      • "receiverId": "string",
      • "receiverIdType": "string",
      • "releaseCharacter": "string",
      • "repetitionSeparator": "string",
      • "segmentTerminator": "string",
      • "senderId": "string",
      • "senderIdType": "string",
      • "testIndicator": "string",
      • "controlEntity": {
        },
      • "errorCount": 0
      }

      Retrieve an interchange acknowledgement by identifier

      Authorizations:
      path Parameters
      interchangeId
      required
      string

      Responses

      Response samples

      Content type
      No sample

      Retrieve a list of transactions for a particular interchange, group, or date/time range

      Authorizations:
      query Parameters
      dateFrom
      string <date-time> (OffsetDateTime)
      dateThru
      string <date-time> (OffsetDateTime)
      groupId
      string
      interchangeId
      string

      Responses

      Response samples

      Content type
      application/json
      [
      • {
        }
      ]

      Retrieve a transaction by identifier

      Authorizations:
      path Parameters
      id
      required
      string

      Record identifier

      Responses

      Response samples

      Content type
      application/json
      {
      • "ackCode": "string",
      • "agencyCode": "string",
      • "channel": {
        },
      • "controlCount": "string",
      • "controlReference": "string",
      • "createdAt": "2019-08-24T14:15:22Z",
      • "industryCode": "string",
      • "release": "string",
      • "updatedAt": "2019-08-24T14:15:22Z",
      • "uuid": "string",
      • "version": "string",
      • "errors": [
        ],
      • "type": "string",
      • "controlEntity": {
        }
      }

      Administration

      Channel maintenance and configuration

      Retrieve a list of channels, optionally filtering by name

      Authorizations:
      query Parameters
      name
      string
      Default: ""

      Responses

      Response samples

      Content type
      application/json
      [
      • {
        }
      ]

      Create a new channel

      Authorizations:
      Request Body schema: application/json
      title
      required
      string (Readable name for the record) <= 255 characters \S

      Responses

      Request samples

      Content type
      application/json
      {
      • "title": "string"
      }

      Response samples

      Content type
      application/json
      {
      • "createdAt": "string",
      • "name": "string",
      • "title": "string",
      • "updatedAt": "string",
      • "uuid": "string"
      }

      Retrieve a channel by unique identifier

      Authorizations:
      path Parameters
      id
      required
      string

      Channel ID

      Responses

      Response samples

      Content type
      application/json
      {
      • "createdAt": "string",
      • "name": "string",
      • "title": "string",
      • "updatedAt": "string",
      • "uuid": "string"
      }

      Update a channel

      Authorizations:
      path Parameters
      id
      required
      string

      Record identifier

      Request Body schema: application/json
      title
      required
      string (Readable name for the record) <= 255 characters \S

      Responses

      Request samples

      Content type
      application/json
      {
      • "title": "string"
      }

      Response samples

      Content type
      application/json
      {
      • "createdAt": "string",
      • "name": "string",
      • "title": "string",
      • "updatedAt": "string",
      • "uuid": "string"
      }

      Retrieve an interchange control's group control list

      Authorizations:
      query Parameters
      interchangeControlId
      string

      Interchange control ID

      Responses

      Response samples

      Content type
      application/json
      [
      • {
        }
      ]

      Create a new group control record for an interchange control.

      Authorizations:
      Request Body schema: application/json
      agencyCode
      string <= 4 characters

      Agency code of the standards body that defines the schema of this record

      channelId
      string

      Channel identifier. Required for new records, otherwise read-only

      industryCode
      string <= 255 characters

      Industry identifier (implementation version) of the standard

      lastControlNumber
      integer <int64>

      The previous control number used for outbound data. Defaults to 0 for new records.

      release
      string <= 255 characters

      Release (sub-version) of the standard

      title
      required
      string (Readable name for the record) <= 255 characters \S
      version
      required
      string <= 255 characters \S

      Version of the standard

      interchangeControlId
      string

      Interchange control identifier. Required for new records, otherwise read-only

      localId
      required
      string

      Used for the sender on output interchanges and the receiver on inbound groups

      localIdType
      string

      Used for the sender on output interchanges and the receiver on inbound groups. Not used for X12

      remoteId
      required
      string

      Used for the receiver on output interchanges and the sender on inbound groups

      remoteIdType
      string

      Used for the receiver on output interchanges and the sender on inbound groups. Not used for X12

      type
      required
      string\S

      Functional/message group type code

      Responses

      Request samples

      Content type
      application/json
      {
      • "agencyCode": "stri",
      • "channelId": "string",
      • "industryCode": "string",
      • "lastControlNumber": 0,
      • "release": "string",
      • "title": "string",
      • "version": "string",
      • "interchangeControlId": "string",
      • "localId": "string",
      • "localIdType": "string",
      • "remoteId": "string",
      • "remoteIdType": "string",
      • "type": "string"
      }

      Response samples

      Content type
      application/json
      {
      • "agencyCode": "stri",
      • "channelId": "string",
      • "createdAt": "string",
      • "industryCode": "string",
      • "lastControlNumber": 0,
      • "release": "string",
      • "title": "string",
      • "updatedAt": "string",
      • "uuid": "string",
      • "version": "string",
      • "interchangeControlId": "string",
      • "localId": "string",
      • "localIdType": "string",
      • "remoteId": "string",
      • "remoteIdType": "string",
      • "type": "string"
      }

      Retrieve a group control by identifier

      Authorizations:
      path Parameters
      id
      required
      string

      Record identifier

      Responses

      Response samples

      Content type
      application/json
      {
      • "agencyCode": "stri",
      • "channelId": "string",
      • "createdAt": "string",
      • "industryCode": "string",
      • "lastControlNumber": 0,
      • "release": "string",
      • "title": "string",
      • "updatedAt": "string",
      • "uuid": "string",
      • "version": "string",
      • "interchangeControlId": "string",
      • "localId": "string",
      • "localIdType": "string",
      • "remoteId": "string",
      • "remoteIdType": "string",
      • "type": "string"
      }

      Updates a group control

      Authorizations:
      path Parameters
      id
      required
      string

      Record identifier

      Request Body schema: application/json
      agencyCode
      string <= 4 characters

      Agency code of the standards body that defines the schema of this record

      channelId
      string

      Channel identifier. Required for new records, otherwise read-only

      industryCode
      string <= 255 characters

      Industry identifier (implementation version) of the standard

      lastControlNumber
      integer <int64>

      The previous control number used for outbound data. Defaults to 0 for new records.

      release
      string <= 255 characters

      Release (sub-version) of the standard

      title
      required
      string (Readable name for the record) <= 255 characters \S
      version
      required
      string <= 255 characters \S

      Version of the standard

      interchangeControlId
      string

      Interchange control identifier. Required for new records, otherwise read-only

      localId
      required
      string

      Used for the sender on output interchanges and the receiver on inbound groups

      localIdType
      string

      Used for the sender on output interchanges and the receiver on inbound groups. Not used for X12

      remoteId
      required
      string

      Used for the receiver on output interchanges and the sender on inbound groups

      remoteIdType
      string

      Used for the receiver on output interchanges and the sender on inbound groups. Not used for X12

      type
      required
      string\S

      Functional/message group type code

      Responses

      Request samples

      Content type
      application/json
      {
      • "agencyCode": "stri",
      • "channelId": "string",
      • "industryCode": "string",
      • "lastControlNumber": 0,
      • "release": "string",
      • "title": "string",
      • "version": "string",
      • "interchangeControlId": "string",
      • "localId": "string",
      • "localIdType": "string",
      • "remoteId": "string",
      • "remoteIdType": "string",
      • "type": "string"
      }

      Response samples

      Content type
      application/json
      {
      • "agencyCode": "stri",
      • "channelId": "string",
      • "createdAt": "string",
      • "industryCode": "string",
      • "lastControlNumber": 0,
      • "release": "string",
      • "title": "string",
      • "updatedAt": "string",
      • "uuid": "string",
      • "version": "string",
      • "interchangeControlId": "string",
      • "localId": "string",
      • "localIdType": "string",
      • "remoteId": "string",
      • "remoteIdType": "string",
      • "type": "string"
      }

      Retrieve a channel's interchange controls

      Authorizations:
      query Parameters
      channelId
      string

      Channel ID

      Responses

      Response samples

      Content type
      application/json
      [
      • {
        }
      ]

      Create a new interchange control record for a channel.

      Authorizations:
      Request Body schema: application/json
      agencyCode
      string <= 4 characters

      Agency code of the standards body that defines the schema of this record

      channelId
      string

      Channel identifier. Required for new records, otherwise read-only

      industryCode
      string <= 255 characters

      Industry identifier (implementation version) of the standard

      lastControlNumber
      integer <int64>

      The previous control number used for outbound data. Defaults to 0 for new records.

      release
      string <= 255 characters

      Release (sub-version) of the standard

      title
      required
      string (Readable name for the record) <= 255 characters \S
      version
      required
      string <= 255 characters \S

      Version of the standard

      componentSeparator
      string <= 1 characters

      Component element separator to be used for outbound interchanges. Default value is dialect specific (EDIFACT/X12) if not specified.

      decimalMark
      string <= 1 characters

      Decimal character to be used for outbound interchanges. Not supported for X12

      elementSeparator
      string <= 1 characters

      Element separator to be used for outbound interchanges. Default value is dialect specific (EDIFACT/X12) if not specified.

      localId
      required
      string <= 255 characters \S

      Used for the sender on output interchanges and the receiver on inbound interchanges

      localIdType
      string <= 255 characters \S

      Used for the sender on output interchanges and the receiver on inbound interchanges. Optional for EDIFACT, required for X12

      releaseCharacter
      string <= 1 characters

      Release character to be used for outbound interchanges. Default value is dialect specific (EDIFACT/X12) if not specified.

      remoteId
      required
      string <= 255 characters \S

      Used for the receiver on output interchanges and the sender on inbound interchanges

      remoteIdType
      string <= 255 characters \S

      Used for the receiver on output interchanges and the sender on inbound interchanges. Optional for EDIFACT, required for X12

      repetitionSeparator
      string <= 1 characters

      Repetition separator to be used for outbound interchanges. Default value is dialect specific (EDIFACT/X12) if not specified.

      segmentTerminator
      string <= 1 characters

      Segment terminator to be used for outbound interchanges. Default value is dialect specific (EDIFACT/X12) if not specified.

      standard
      required
      string <= 7 characters \S
      Enum: "EDIFACT" "X12"

      EDI standard

      testIndicator
      required
      string <= 1 characters

      Test indicator to be used for outbound interchanges. Value is dialect specific (EDIFACT/X12). For example, X12 uses P and T, whereas EDIFACT uses 1 through 5.

      Responses

      Request samples

      Content type
      application/json
      {
      • "agencyCode": "stri",
      • "channelId": "string",
      • "industryCode": "string",
      • "lastControlNumber": 0,
      • "release": "string",
      • "title": "string",
      • "version": "string",
      • "componentSeparator": "s",
      • "decimalMark": "s",
      • "elementSeparator": "s",
      • "localId": "string",
      • "localIdType": "string",
      • "releaseCharacter": "s",
      • "remoteId": "string",
      • "remoteIdType": "string",
      • "repetitionSeparator": "s",
      • "segmentTerminator": "s",
      • "standard": "EDIFACT",
      • "testIndicator": "s"
      }

      Response samples

      Content type
      application/json
      {
      • "agencyCode": "stri",
      • "channelId": "string",
      • "createdAt": "string",
      • "industryCode": "string",
      • "lastControlNumber": 0,
      • "release": "string",
      • "title": "string",
      • "updatedAt": "string",
      • "uuid": "string",
      • "version": "string",
      • "componentSeparator": "s",
      • "decimalMark": "s",
      • "elementSeparator": "s",
      • "localId": "string",
      • "localIdType": "string",
      • "releaseCharacter": "s",
      • "remoteId": "string",
      • "remoteIdType": "string",
      • "repetitionSeparator": "s",
      • "segmentTerminator": "s",
      • "standard": "EDIFACT",
      • "testIndicator": "s"
      }

      Retrieve an interchange control by ID

      Authorizations:
      path Parameters
      id
      required
      string

      Interchange control ID

      Responses

      Response samples

      Content type
      application/json
      {
      • "agencyCode": "stri",
      • "channelId": "string",
      • "createdAt": "string",
      • "industryCode": "string",
      • "lastControlNumber": 0,
      • "release": "string",
      • "title": "string",
      • "updatedAt": "string",
      • "uuid": "string",
      • "version": "string",
      • "componentSeparator": "s",
      • "decimalMark": "s",
      • "elementSeparator": "s",
      • "localId": "string",
      • "localIdType": "string",
      • "releaseCharacter": "s",
      • "remoteId": "string",
      • "remoteIdType": "string",
      • "repetitionSeparator": "s",
      • "segmentTerminator": "s",
      • "standard": "EDIFACT",
      • "testIndicator": "s"
      }

      Updates an interchange control

      Authorizations:
      path Parameters
      id
      required
      string

      Interchange control ID

      Request Body schema: application/json
      agencyCode
      string <= 4 characters

      Agency code of the standards body that defines the schema of this record

      channelId
      string

      Channel identifier. Required for new records, otherwise read-only

      industryCode
      string <= 255 characters

      Industry identifier (implementation version) of the standard

      lastControlNumber
      integer <int64>

      The previous control number used for outbound data. Defaults to 0 for new records.

      release
      string <= 255 characters

      Release (sub-version) of the standard

      title
      required
      string (Readable name for the record) <= 255 characters \S
      version
      required
      string <= 255 characters \S

      Version of the standard

      componentSeparator
      string <= 1 characters

      Component element separator to be used for outbound interchanges. Default value is dialect specific (EDIFACT/X12) if not specified.

      decimalMark
      string <= 1 characters

      Decimal character to be used for outbound interchanges. Not supported for X12

      elementSeparator
      string <= 1 characters

      Element separator to be used for outbound interchanges. Default value is dialect specific (EDIFACT/X12) if not specified.

      localId
      required
      string <= 255 characters \S

      Used for the sender on output interchanges and the receiver on inbound interchanges

      localIdType
      string <= 255 characters \S

      Used for the sender on output interchanges and the receiver on inbound interchanges. Optional for EDIFACT, required for X12

      releaseCharacter
      string <= 1 characters

      Release character to be used for outbound interchanges. Default value is dialect specific (EDIFACT/X12) if not specified.

      remoteId
      required
      string <= 255 characters \S

      Used for the receiver on output interchanges and the sender on inbound interchanges

      remoteIdType
      string <= 255 characters \S

      Used for the receiver on output interchanges and the sender on inbound interchanges. Optional for EDIFACT, required for X12

      repetitionSeparator
      string <= 1 characters

      Repetition separator to be used for outbound interchanges. Default value is dialect specific (EDIFACT/X12) if not specified.

      segmentTerminator
      string <= 1 characters

      Segment terminator to be used for outbound interchanges. Default value is dialect specific (EDIFACT/X12) if not specified.

      standard
      required
      string <= 7 characters \S
      Enum: "EDIFACT" "X12"

      EDI standard

      testIndicator
      required
      string <= 1 characters

      Test indicator to be used for outbound interchanges. Value is dialect specific (EDIFACT/X12). For example, X12 uses P and T, whereas EDIFACT uses 1 through 5.

      Responses

      Request samples

      Content type
      application/json
      {
      • "agencyCode": "stri",
      • "channelId": "string",
      • "industryCode": "string",
      • "lastControlNumber": 0,
      • "release": "string",
      • "title": "string",
      • "version": "string",
      • "componentSeparator": "s",
      • "decimalMark": "s",
      • "elementSeparator": "s",
      • "localId": "string",
      • "localIdType": "string",
      • "releaseCharacter": "s",
      • "remoteId": "string",
      • "remoteIdType": "string",
      • "repetitionSeparator": "s",
      • "segmentTerminator": "s",
      • "standard": "EDIFACT",
      • "testIndicator": "s"
      }

      Response samples

      Content type
      application/json
      {
      • "agencyCode": "stri",
      • "channelId": "string",
      • "createdAt": "string",
      • "industryCode": "string",
      • "lastControlNumber": 0,
      • "release": "string",
      • "title": "string",
      • "updatedAt": "string",
      • "uuid": "string",
      • "version": "string",
      • "componentSeparator": "s",
      • "decimalMark": "s",
      • "elementSeparator": "s",
      • "localId": "string",
      • "localIdType": "string",
      • "releaseCharacter": "s",
      • "remoteId": "string",
      • "remoteIdType": "string",
      • "repetitionSeparator": "s",
      • "segmentTerminator": "s",
      • "standard": "EDIFACT",
      • "testIndicator": "s"
      }

      Retrieve a transaction control list

      Authorizations:
      query Parameters
      groupControlId
      string
      interchangeControlId
      string

      Responses

      Response samples

      Content type
      application/json
      [
      • {
        }
      ]

      Create a new transaction control record for an interchange control.

      Authorizations:
      Request Body schema: application/json
      agencyCode
      string <= 4 characters

      Agency code of the standards body that defines the schema of this record

      channelId
      string

      Channel identifier. Required for new records, otherwise read-only

      industryCode
      string <= 255 characters

      Industry identifier (implementation version) of the standard

      lastControlNumber
      integer <int64>

      The previous control number used for outbound data. Defaults to 0 for new records.

      release
      string <= 255 characters

      Release (sub-version) of the standard

      title
      required
      string (Readable name for the record) <= 255 characters \S
      version
      required
      string <= 255 characters \S

      Version of the standard

      groupControlId
      string

      Group control identifier. Required for new records directly tied to a group control record, not used otherwise

      interchangeControlId
      string

      Interchange control identifier. Required for new records directly tied to an interchange control record, not used otherwise

      type
      string

      Responses

      Request samples

      Content type
      application/json
      {
      • "agencyCode": "stri",
      • "channelId": "string",
      • "industryCode": "string",
      • "lastControlNumber": 0,
      • "release": "string",
      • "title": "string",
      • "version": "string",
      • "groupControlId": "string",
      • "interchangeControlId": "string",
      • "type": "string"
      }

      Response samples

      Content type
      application/json
      {
      • "agencyCode": "stri",
      • "channelId": "string",
      • "createdAt": "string",
      • "industryCode": "string",
      • "lastControlNumber": 0,
      • "release": "string",
      • "title": "string",
      • "updatedAt": "string",
      • "uuid": "string",
      • "version": "string",
      • "groupControlId": "string",
      • "interchangeControlId": "string",
      • "type": "string"
      }

      Retrieve a transaction control by ID

      Authorizations:
      path Parameters
      id
      required
      string

      Record identifier

      Responses

      Response samples

      Content type
      application/json
      {
      • "agencyCode": "stri",
      • "channelId": "string",
      • "createdAt": "string",
      • "industryCode": "string",
      • "lastControlNumber": 0,
      • "release": "string",
      • "title": "string",
      • "updatedAt": "string",
      • "uuid": "string",
      • "version": "string",
      • "groupControlId": "string",
      • "interchangeControlId": "string",
      • "type": "string"
      }

      Update a transaction control

      Authorizations:
      path Parameters
      id
      required
      string

      Record identifier

      Request Body schema: application/json
      agencyCode
      string <= 4 characters

      Agency code of the standards body that defines the schema of this record

      channelId
      string

      Channel identifier. Required for new records, otherwise read-only

      industryCode
      string <= 255 characters

      Industry identifier (implementation version) of the standard

      lastControlNumber
      integer <int64>

      The previous control number used for outbound data. Defaults to 0 for new records.

      release
      string <= 255 characters

      Release (sub-version) of the standard

      title
      required
      string (Readable name for the record) <= 255 characters \S
      version
      required
      string <= 255 characters \S

      Version of the standard

      groupControlId
      string

      Group control identifier. Required for new records directly tied to a group control record, not used otherwise

      interchangeControlId
      string

      Interchange control identifier. Required for new records directly tied to an interchange control record, not used otherwise

      type
      string

      Responses

      Request samples

      Content type
      application/json
      {
      • "agencyCode": "stri",
      • "channelId": "string",
      • "industryCode": "string",
      • "lastControlNumber": 0,
      • "release": "string",
      • "title": "string",
      • "version": "string",
      • "groupControlId": "string",
      • "interchangeControlId": "string",
      • "type": "string"
      }

      Response samples

      Content type
      application/json
      {
      • "agencyCode": "stri",
      • "channelId": "string",
      • "createdAt": "string",
      • "industryCode": "string",
      • "lastControlNumber": 0,
      • "release": "string",
      • "title": "string",
      • "updatedAt": "string",
      • "uuid": "string",
      • "version": "string",
      • "groupControlId": "string",
      • "interchangeControlId": "string",
      • "type": "string"
      }

      Configuration

      Configuration information for a web-based user interface

      Retrieve JavaScript module for front end configuration

      Responses

      Schema Maintenance

      Define and review the EDI schemas available in the system

      Retrieve a list of transaction schemas known to the system

      Authorizations:

      Responses

      Create a new transaction schema to be used for EDI validation

      Authorizations:
      Request Body schema: multipart/form-data
      standard
      string\S
      agencyCode
      string\S
      version
      string\S
      release
      string
      Default: ""
      industryCode
      string
      Default: ""
      transactionCode
      string\S
      senderIdType
      string
      Default: ""
      senderId
      string
      Default: ""
      receiverIdType
      string
      Default: ""
      receiverId
      string
      Default: ""
      file
      string <binary>

      Responses

      <no summary>

      Authorizations:
      query Parameters
      standard
      string
      version
      string

      Responses

      Response samples

      Content type
      application/schema+json
      { }

      <no summary>

      Authorizations:
      query Parameters
      standard
      string
      type
      string
      version
      string

      Responses

      Response samples

      Content type
      application/schema+json
      { }

      <no summary>

      Authorizations:
      path Parameters
      file
      required
      string
      standard
      required
      string
      type
      required
      string
      version
      required
      string

      Responses

      Response samples

      Content type
      No sample

      <no summary>

      Authorizations:
      path Parameters
      file
      required
      string
      standard
      required
      string
      type
      required
      string
      version
      required
      string

      Responses