X12ValidationOverride

 

Updated: November 27, 2015

System_CAPS_importantImportant

Microsoft Azure BizTalk Services (MABS) is being retired, and replaced with Azure Logic Apps. If you currently use MABS, then Move from BizTalk Services to Logic Appsprovides some guidance on moving your integration solutions to Logic Apps.

If you're brand new to Logic Apps, then we suggest getting started here:

Property

Type

Description

ID

Int

Specifies a unique ID for the X12 validation override. This value is auto-generated.

AllowLeadingAndTrailingSpacesAndZeroes

Bool

Required. Specifies whether leading and trailing spaces must be allowed.

MessageId

String

Required. Specifies the message ID, such as, 810. This value must not be a duplicate in the context of the same X12ProtocolSettings.

X12ProtocolSettings

X12ProtocolSettings

Required. A navigation property that references the X12 protocol settings associated with the overrides.

X12ProtocolSettingsId

Int

Required. A navigation property that references an X12 protocol settings ID.

SeparatorPolicy

Int

Required. Specifies the separator policy. The possible values are 0 (for not allowed), 1 (for optional), and 2(for mandatory).

ValidateCharacterSet

Bool

Required. Specifies whether the character set must be validated or not.

ValidateEDITypes

Bool

Required. Specifies whether the EDI types must be validated or not.

ValidateXSDTypes

Bool

Required. Specifies whether the XSD validation must be performed or not.

Version

Byte[]

This value is auto-generated and is for internal use only.

You can create an X12 validation override entity using a POST HTTP request.

Method

Request URI

HTTP Version

POST

https://mybiztalkservice.biztalk.windows.net/default/$PartnerManagement/X12ValidationOverrides

HTTP/1.1

The following request message shows how to create an X12 validation override entity and link it to X12ProtocoSetting entity.

POST https://mybiztalkservice.biztalk.windows.net/default/$PartnerManagement/X12ValidationOverrides HTTP/1.1
Accept-Charset: UTF-8
DataServiceVersion: 1.0;NetFx
MaxDataServiceVersion: 3.0;NetFx
Accept: application/atom+xml,application/xml
Authorization: WRAP access_token="<token>"
x-ms-version: 1.0
Content-Type: application/atom+xml
Host: integration.zurich.test.dnsdemo1.com:5446
Content-Length: 1446
Expect: 100-continue

<?xml version="1.0" encoding="utf-8"?><entry xmlns="http://www.w3.org/2005/Atom" xmlns:d="http://schemas.microsoft.com/ado/2007/08/dataservices" xmlns:m="http://schemas.microsoft.com/ado/2007/08/dataservices/metadata">
  <category term="Microsoft.ApplicationServer.Integration.PartnerManagement.X12ValidationOverride" scheme="http://schemas.microsoft.com/ado/2007/08/dataservices/scheme" />
  <link rel="http://schemas.microsoft.com/ado/2007/08/dataservices/related/X12ProtocolSettings" type="application/atom+xml;type=entry" title="X12ProtocolSettings" href="https://mybiztalkservice.biztalk.windows.net/default/$PartnerManagement/ProtocolSettings(1)/Microsoft.ApplicationServer.Integration.PartnerManagement.X12ProtocolSettings" />
  <id />
  <title />
  <updated>2013-02-10T23:00:50Z</updated>
  <author>
    <name />
  </author>
  <content type="application/xml">
    <m:properties>
      <d:AllowLeadingAndTrailingSpacesAndZeroes m:type="Edm.Boolean">true</d:AllowLeadingAndTrailingSpacesAndZeroes>
      <d:Id m:type="Edm.Int32">0</d:Id>
      <d:MessageId>810</d:MessageId>
      <d:SeparatorPolicy m:type="Edm.Int16">2</d:SeparatorPolicy>
      <d:ValidateCharacterSet m:type="Edm.Boolean">true</d:ValidateCharacterSet>
      <d:ValidateEDITypes m:type="Edm.Boolean">true</d:ValidateEDITypes>
      <d:ValidateXSDTypes m:type="Edm.Boolean">true</d:ValidateXSDTypes>
      <d:Version m:type="Edm.Binary">AA==</d:Version>
      <d:X12ProtocolSettingsId m:type="Edm.Int32">0</d:X12ProtocolSettingsId>
    </m:properties>
  </content>
</entry>

You can list X12 validation overrides using a GET HTTP request.

Method

Request URI

HTTP Version

GET

https://mybiztalkservice.biztalk.windows.net/default/$PartnerManagement/X12ValidationOverrides

This returns all the X12 validation overrides

HTTP/1.1

GET

https://mybiztalkservice.biztalk.windows.net/default/$PartnerManagement/X12ValidationOverrides(id)

This returns information about the X12 validation override with the specified ID.

HTTP/1.1

Retrieve all the X12 validation overrides

GET https://mybiztalkservice.biztalk.windows.net/default/$PartnerManagement/X12ValidationOverrides HTTP/1.1
User-Agent: Microsoft ADO.NET Data Services
Accept-Charset: UTF-8
DataServiceVersion: 1.0;NetFx
MaxDataServiceVersion: 3.0;NetFx
Accept: application/atom+xml,application/xml
Authorization: WRAP access_token="<token>"
x-ms-version: 1.0
Host: integration.zurich.test.dnsdemo1.com:5446

Retrieve information about a specific X12 validation override

GET https://mybiztalkservice.biztalk.windows.net/default/$PartnerManagement/X12ValidationOverrides(1) HTTP/1.1
User-Agent: Microsoft ADO.NET Data Services
Accept-Charset: UTF-8
DataServiceVersion: 1.0;NetFx
MaxDataServiceVersion: 3.0;NetFx
Accept: application/atom+xml,application/xml
Authorization: WRAP access_token="<token>"
x-ms-version: 1.0
Host: integration.zurich.test.dnsdemo1.com:5446

You can update an X12 validation override using a MERGE HTTP request.

Method

Request URI

HTTP Version

MERGE

https://mybiztalkservice.biztalk.windows.net/default/$PartnerManagement/X12ValidationOverrides(id)

HTTP/1.1

MERGE https://mybiztalkservice.biztalk.windows.net/default/$PartnerManagement/X12ValidationOverrides(1) HTTP/1.1
User-Agent: Microsoft ADO.NET Data Services
Accept-Charset: UTF-8
DataServiceVersion: 1.0;NetFx
MaxDataServiceVersion: 3.0;NetFx
Accept: application/atom+xml,application/xml
Authorization: WRAP access_token="<token>"
x-ms-version: 1.0
Content-Type: application/atom+xml
If-Match: W/"X'0000000000000FA3'"
Host: integration.zurich.test.dnsdemo1.com:5446
Content-Length: 1217
Expect: 100-continue

<?xml version="1.0" encoding="utf-8"?><entry xmlns="http://www.w3.org/2005/Atom" xmlns:d="http://schemas.microsoft.com/ado/2007/08/dataservices" xmlns:m="http://schemas.microsoft.com/ado/2007/08/dataservices/metadata">
  <id>https://mybiztalkservice.biztalk.windows.net/default/$PartnerManagement/X12ValidationOverrides(1)</id>
  <category term="Microsoft.ApplicationServer.Integration.PartnerManagement.X12ValidationOverride" scheme="http://schemas.microsoft.com/ado/2007/08/dataservices/scheme" />
  <title />
  <updated>2013-02-10T23:13:39Z</updated>
  <author>
    <name />
  </author>
  <content type="application/xml">
    <m:properties>
      <d:AllowLeadingAndTrailingSpacesAndZeroes m:type="Edm.Boolean">true</d:AllowLeadingAndTrailingSpacesAndZeroes>
      <d:Id m:type="Edm.Int32">1</d:Id>
      <d:MessageId>810</d:MessageId>
      <d:SeparatorPolicy m:type="Edm.Int16">2</d:SeparatorPolicy>
      <d:ValidateCharacterSet m:type="Edm.Boolean">false</d:ValidateCharacterSet>
      <d:ValidateEDITypes m:type="Edm.Boolean">false</d:ValidateEDITypes>
      <d:ValidateXSDTypes m:type="Edm.Boolean">false</d:ValidateXSDTypes>
      <d:Version m:type="Edm.Binary">AAAAAAAAD6M=</d:Version>
      <d:X12ProtocolSettingsId m:type="Edm.Int32">11</d:X12ProtocolSettingsId>
    </m:properties>
  </content>
</entry>

You can delete an X12 validation override using a DELETE HTTP request.

Method

Request URI

HTTP Version

DELETE

https://mybiztalkservice.biztalk.windows.net/default/$PartnerManagement/X12ValidationOverrides(id)

HTTP/1.1

DELETE https://mybiztalkservice.biztalk.windows.net/default/$PartnerManagement/X12ValidationOverrides(1) HTTP/1.1
User-Agent: Microsoft ADO.NET Data Services
Accept-Charset: UTF-8
DataServiceVersion: 1.0;NetFx
MaxDataServiceVersion: 3.0;NetFx
Accept: application/atom+xml,application/xml
Authorization: WRAP access_token="<token>"
x-ms-version: 1.0
If-Match: W/"X'0000000000000A69'"
Host: integration.zurich.test.dnsdemo1.com:5446
Content-Length: 0

In Create an X12ValidationOverride section, we saw how to create a link between an X12 validation override and an X12 protocol settings entity while creating the X12 validation override entity. In this section, we see how to create a link in the opposite direction, that is, from an X12 protocol setting entity to an X12 validation override. To create the link, the URI of the X12 validation override must be included in the request body.

Method

Request URI

HTTP Version

POST

https://mybiztalkservice.biztalk.windows.net/default/$PartnerManagement/ProtocolSettings(id)/Microsoft.ApplicationServer.Integration.PartnerManagement.X12ProtocolSettings/$links/ValidationOverrides

ProtocolSettings(id) denotes the ID of the protocol setting that links to the X12 validation override.

HTTP/1.1

POST https://mybiztalkservice.biztalk.windows.net/default/$PartnerManagement/ProtocolSettings(1)/
Microsoft.ApplicationServer.Integration.PartnerManagement.X12ProtocolSettings/$links/ValidationOverrides HTTP/1.1
User-Agent: Microsoft ADO.NET Data Services
Accept-Charset: UTF-8
DataServiceVersion: 1.0;NetFx
MaxDataServiceVersion: 3.0;NetFx
Accept: application/atom+xml,application/xml
Authorization: WRAP access_token="<token>"
x-ms-version: 1.0
Content-Type: application/xml
Host: integration.zurich.test.dnsdemo1.com:5446
Content-Length: 221
Expect: 100-continue

<?xml version="1.0" encoding="utf-8"?>
<uri xmlns="http://schemas.microsoft.com/ado/2007/08/dataservices/metadata">https://mybiztalkservice.biztalk.windows.net/default/$PartnerManagement/X12ValidationOverrides(1)</uri>

You can delete a link between other entities and an X12 validation override by using the HTTP DELETE method.

Method

Request URI

HTTP Version

DELETE

https://mybiztalkservice.biztalk.windows.net/default/$PartnerManagement/ProtocolSettings(id)/Microsoft.ApplicationServer.Integration.PartnerManagement.X12ProtocolSettings/$links/ValidationOverrides(id)

HTTP/1.1

DELETE https://mybiztalkservice.biztalk.windows.net/default/$PartnerManagement/ProtocolSettings(1)/
Microsoft.ApplicationServer.Integration.PartnerManagement.X12ProtocolSettings/$links/ValidationOverrides(1)
HTTP/1.1
Accept-Charset: UTF-8
DataServiceVersion: 1.0;NetFx
MaxDataServiceVersion: 3.0;NetFx
x-ms-version: 1.0
Accept: application/atom+xml,application/xml
Authorization: WRAP access_token="<token>"
Content-Type: application/xml
Host: integration.zurich.test.dnsdemo1.com:5446
Expect: 100-continue
Show: