Contact| Azure BizTalk Services
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:
-
Create your first logic app, or quickly get started using a pre-built template
-
View all the available connectors you can use in your logic apps
A Contact entity provides the contact information specific to a partner, a business profile, or an agreement.
Contact Entity Properties
Create a Contact
List Contacts
Update a Contact
Delete a Contact
Link Other Entities with Contacts
Delete Link between Other Entities and Contacts
Contact Entity Properties
Property |
Type |
Description |
|---|---|---|
ID |
Int |
Specifies a unique ID for the contact. This value is auto-generated. |
Agreement |
Agreement |
A navigation property that references the agreement to which the contact details apply. |
BusinessProfile |
BusinessProfile |
Required. A navigation property that references the business profile to which the contact details apply. |
Partner |
Partner |
A navigation property that references the partner to which the contact details apply |
AddressLine1 |
String |
Specifies the address. This must not be more than 256 characters. |
AddressLine2 |
String |
Specifies the address. This must not be more than 256 characters. |
City |
String |
Specifies the city. This must not be more than 512 characters. |
Country |
String |
Specifies the country or region. This must not be more than 256 characters. |
EmailId |
String |
Specifies the e-mail ID. This must not be more than 256 characters. |
FirstName |
String |
Specifies the first name. This must not be more than 256 characters. |
LastName |
String |
Specifies the last name. This must not be more than 256 characters. |
Phone |
String |
Specifies the phone contact details. This must not be more than 256 characters. |
PostalCode |
String |
Specifies the postal code. This must not be more than 16 characters. |
State |
String |
Specifies the state. This must not be more than 256 characters. |
WebsiteURL |
String |
Specifies the website URL. This must not be more than 256 characters. |
Version |
Byte[] |
This value is auto-generated and is for internal use only. |
Considerations
A Contact entity must be associated with either a Partner, a BusinessProfile, or an Agreement entity.
Create a Contact
You can create a contact using a POST HTTP request.
Method |
Request URI |
HTTP Version |
|---|---|---|
POST |
https://mybiztalkservice.biztalk.windows.net/default/$PartnerManagement/Contacts |
HTTP/1.1 |
Note
You cannot create a contact without linking it to a partner, a business profile, or an agreement. In the following sample request, a contact is linked to a business profile using the <link> element of the request body.
Sample Request
POST https://mybiztalkservice.biztalk.windows.net/default/$PartnerManagement/Contacts 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
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">
<category term="Microsoft.ApplicationServer.Integration.PartnerManagement.Contact" scheme="https://schemas.microsoft.com/ado/2007/08/dataservices/scheme" />
<link rel="https://schemas.microsoft.com/ado/2007/08/dataservices/related/BusinessProfile" type="application/atom+xml;type=entry" title="BusinessProfile" href="https://mybiztalkservice.biztalk.windows.net/default/$PartnerManagement/BusinessProfiles(1)" />
<id />
<title />
<updated>2013-02-01T18:28:40Z</updated>
<author>
<name />
</author>
<content type="application/xml">
<m:properties>
<d:City>Redmond</d:City>
<d:FirstName>John</d:FirstName>
<d:LastName>Smith</d:LastName>
<d:State>WA</d:State>
</m:properties>
</content>
</entry>
List Contacts
You can list contacts using a GET HTTP request.
Method |
Request URI |
HTTP Version |
|---|---|---|
GET |
https://mybiztalkservice.biztalk.windows.net/default/$PartnerManagement/Contacts This returns all the business profiles |
HTTP/1.1 |
GET |
https://mybiztalkservice.biztalk.windows.net/default/$PartnerManagement/Contacts(id) This returns information about the contacts with the specified ID. |
HTTP/1.1 |
Sample Request
Retrieve all the contacts
GET https://mybiztalkservice.biztalk.windows.net/default/$PartnerManagement/Contacts 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/json
Host: integration.zurich.test.dnsdemo1.com:5446
Retrieve information about a specific contact
GET https://mybiztalkservice.biztalk.windows.net/default/$PartnerManagement/Contacts(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/json
Host: integration.zurich.test.dnsdemo1.com:5446
Update a Contact
You can update a contact using a MERGE HTTP request.
Method |
Request URI |
HTTP Version |
|---|---|---|
MERGE |
https://mybiztalkservice.biztalk.windows.net/default/$PartnerManagement/Contacts (id) |
HTTP/1.1 |
Sample Request
MERGE https://mybiztalkservice.biztalk.windows.net/default/$PartnerManagement/Contacts(id) 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'00000000000010BF'"
Host: integration.zurich.test.dnsdemo1.com:5446
Content-Length: 790
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://integration.zurich.test.dnsdemo1.com:5446/test01/$PartnerManagement/Contacts(2)</id>
<category term="Microsoft.ApplicationServer.Integration.PartnerManagement.Contact" scheme="https://schemas.microsoft.com/ado/2007/08/dataservices/scheme" />
<title />
<updated>2013-02-01T19:18:10Z</updated>
<author>
<name />
</author>
<content type="application/xml">
<m:properties>
<d:FirstName>Jeff</d:FirstName>
<d:LastName>Chia</d:LastName>
</m:properties>
</content>
</entry>
Delete a Contact
You can delete a business profile using a DELETE HTTP request.
Method |
Request URI |
HTTP Version |
|---|---|---|
DELETE |
https://mybiztalkservice.biztalk.windows.net/default/$PartnerManagement/Contacts(id) |
HTTP/1.1 |
Sample Request
DELETE https://mybiztalkservice.biztalk.windows.net/default/$PartnerManagement/Contacts(1) HTTP/1.1
User-Agent: Microsoft ADO.NET Data Services
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'00000000000010C0'"
Host: integration.zurich.test.dnsdemo1.com:5446
Link Other Entities with Contacts
In Create a Contact section, we saw how to create a link between a contact and business profile while creating a contact. In this section, we see how to create a link in the opposite direction, that is, from a another entity (for example, partner) to a contact. To create the link, the URI of the contact entity must be included in the request body.
Method |
Request URI |
HTTP Version |
|---|---|---|
POST |
https://mybiztalkservice.biztalk.windows.net/default/$PartnerManagement/Partners(id)/$links/Contacts Partner(id) denotes the ID of the partner that links to the contact |
HTTP/1.1 |
Sample Request
POST https://mybiztalkservice.biztalk.windows.net/default/$PartnerManagement/Partners(1)/$links/Contacts 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
Content-Length: 208
Expect: 100-continue
<?xml version="1.0" encoding="utf-8"?>
<uri xmlns="https://schemas.microsoft.com/ado/2007/08/dataservices/metadata">https://mybiztalkservice.biztalk.windows.net/default/$PartnerManagement/Contacts(2)</uri>
Delete Link between Other Entities and Contacts
You can delete a link between other entities and contacts by using the HTTP DELETE method.
Method |
Request URI |
HTTP Version |
|---|---|---|
DELETE |
https://mybiztalkservice.biztalk.windows.net/default/$PartnerManagement/Partners(id)/$links/Contacts(id) |
HTTP/1.1 |
Sample Request
DELETE https://mybiztalkservice.biztalk.windows.net/default/$PartnerManagement/Partners(1)/$links/Contacts(2) 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