Web Service Documentation / Categories / Connection/Share Services / Send Connection Request From Test Environment

Send Connection Request From Test Environment

Updated on August 14, 2017

Description

This web service sends a connection request from a customer to you. You must run this web service as the customer that you want the connection request to originate from and specify the account that receives the request. This simulates the customer sending a connection request to you. This web service is only available in the Test environment. After a connection request is sent, you can verify it by running the web service that returns a list of pending customer connections. A connection request cannot be sent if the two accounts are already connected.

Version

9.0

HTTP Method

POST

Resource URL

/invite/account/(dxAccountId)

Header

Field Name Value Comments
Authorization Basic credentials
Content-Type application/xml

Authorization Required

Yes

Parameters

Parameter Name Description
accountId Id to the account that receives the connection request. This is typically the data exchange user.

XML Schemas

Request/Response Schema Name
Request None
Response response.xsd

Example Request

The following example sends a connection request to the account that has an id of 872343.

POST  /invite/account/872343

Example Response

The following example shows that the connection request was successfully sent.

<response status="Ok"/>
TEST