Portfolio Manager will be unavailable due to system upgrades beginning Saturday, November 16, 12:00 AM EST through Monday, November 18, 11:59 PM EST.
Web Service Documentation / Categories / Connection/Share Services / Send Property Share Request From Test Environment
Updated on July 17, 2013
This web service sends a share request for a specific property from a customer to you. You must run this web service as the customer that you want the property share request to originate from and specify the account that receives the request. This simulates the customer sending a property share request to you. Any existing share for this specific property between you and this customer will be updated after submitting this service. If a property share is pending acceptance/rejection, additional share requests cannot be sent. This web service is only available in the Test environment. After the property share request is sent, you can verify it by running the web service that returns a list of pending property share requests.
23.0
POST
/invite/account/(dxAccountId)/property/(propertyId)?accessLevel=(accessLevel)
Field Name | Value | Comments |
---|---|---|
Authorization | Basic credentials | |
Content-Type | application/xml |
Yes
Parameter Name | Description |
---|---|
accessLevel | Indicates the access level for the share request. Valid values are READ or READ_WRITE. Default is READ_WRITE. |
dxAccountId | Id to the account that receives the connection request. This is typically the data exchange user. |
propertyId | Id to the property that is to be shared |
Request/Response | Schema Name |
---|---|
Request | None |
Response | response.xsd |
The following example sends a share request (read write) for a property that has an id of 5544 to the account that has an id of 4534534.
POST /invite/account/4534534/property/5544?accessLevel=READ_WRITE
The following example shows that the share request was successfully sent.
<?xml version="1.0" encoding="UTF-8"?>
<response status="Ok"/>