Partner

  • Article

 

Important

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:

A Partner entity represents a trading partner entity. A partner is the most basic building block of a trading partner management solution.

  • Partner Entity Properties

  • Create a Partner

  • List Partners

  • Update a Partner

  • Delete a Partner

Partner Entity Properties

Property

Type

Description

Name

String

Required. Specifies a unique name for the partner. The partner name must not exceed 256 characters.

ID

Int

Specifies a unique ID for the partner. This value is auto-generated.

Description

String

Specifies a descriptive text for the partner. The text must not exceed 256 characters.

BusinessProfiles

DataServiceCollection<BusinessProfile>

A navigation property that references the business profiles associated with the partner.

Contacts

DataServiceCollection<Contact>

A navigation property that references the contact details associated with the partner.

CustomSettings

DataServiceCollection<CustomSetting>

A navigation property that references the custom information about a partner.

PartnershipsAsA

DataServiceCollection<Partnership>

A navigation property that references the sender partnerships.

PartnershipsAsB

DataServiceCollection<Partnership>

A navigation property that references the receiver partnerships.

Version

Byte[]

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

Create a Partner

You can create a partner using a POST HTTP request.

Method

Request URI

HTTP Version

POST

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

HTTP/1.1

Sample Request

POST https://mybiztalkservice.biztalk.windows.net/default/$PartnerManagement/Partners HTTP/1.1
Content-Type: application/atom+xml
Accept: text/html, application/xhtml+xml, */*
Host: integration.zurich.test.dnsdemo1.com:5446
Connection: Keep-Alive
DataServiceVersion: 1.0;NetFx
MaxDataServiceVersion: 3.0;NetFx
x-ms-version: 1.0
Authorization: WRAP access_token = "<token>"

<?xml version="1.0" encoding="utf-8"?>
<entry xmlns="https://www.w3.org/2005/Atom" xmlns:d="https://schemas.microsoft.com/ado/2007/08/dataservices" xmlns:m="https://schemas.microsoft.com/ado/2007/08/dataservices/metadata">
  <category term="Microsoft.ApplicationServer.Integration.PartnerManagement.Partner" scheme="https://schemas.microsoft.com/ado/2007/08/dataservices/scheme" />
  <id />
  <title />
  <updated>2013-01-28T20:35:43Z</updated>
  <author>
    <name />
  </author>
  <content type="application/xml">
    <m:properties>
      <d:Name>MyPartner</d:Name>
    </m:properties>
  </content>
</entry>

List Partners

You can list partners using a GET HTTP request.

Method

Request URI

HTTP Version

GET

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

This returns information about all the partners

HTTP/1.1

GET

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

This returns information about the partner with the specified ID.

HTTP/1.1

Sample Request

Retrieve all the partners

GET https://mybiztalkservice.biztalk.windows.net/default/$PartnerManagement/Partners HTTP/1.1
Accept: text/html, application/xhtml+xml, */*
DataServiceVersion: 1.0;NetFx
MaxDataServiceVersion: 3.0;NetFx
x-ms-version: 1.0
Host: integration.zurich.test.dnsdemo1.com:5446
Connection: Keep-Alive
Authorization: WRAP access_token = "<token>"

Retrieve a specific partner

GET https://mybiztalkservice.biztalk.windows.net/default/$PartnerManagement/Partners(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>"
Host: integration.zurich.test.dnsdemo1.com:5446

Update a Partner

You can update a partner using a MERGE HTTP request.

Method

Request URI

HTTP Version

MERGE

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

HTTP/1.1

Sample Request

MERGE https://mybiztalkservice.biztalk.windows.net/default/$PartnerManagement/Partners(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/atom+xml
If-Match: W/"X'0000000000000FB5'"
Host: integration.zurich.test.dnsdemo1.com:5446
Expect: 100-continue

<?xml version="1.0" encoding="utf-8"?><entry xmlns="https://www.w3.org/2005/Atom" xmlns:d="https://schemas.microsoft.com/ado/2007/08/dataservices" xmlns:m="https://schemas.microsoft.com/ado/2007/08/dataservices/metadata">
  <id>https://mybiztalkservice.biztalk.windows.net/default/$PartnerManagement/Partners(1)</id>
  <category term="Microsoft.ApplicationServer.Integration.PartnerManagement.Partner" scheme="https://schemas.microsoft.com/ado/2007/08/dataservices/scheme" />
  <title />
  <updated>2013-01-28T20:51:19Z</updated>
  <author>
    <name />
  </author>
  <content type="application/xml">
    <m:properties>
      <d:Name>NewPartnerxxx</d:Name>
    </m:properties>
  </content>
</entry>

Delete a Partner

You can update a partner using a DELETE HTTP request.

Method

Request URI

HTTP Version

DELETE

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

HTTP/1.1

Sample Request

DELETE https://mybiztalkservice.biztalk.windows.net/default/$PartnerManagement/Partners(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>"
If-Match: W/"X'0000000000000FB5'"
Host: integration.zurich.test.dnsdemo1.com:5446
Content-Length: 0

See Also

TPM OM API: Exposed Entities and Properties