| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| SuiteDataSourceInstanceId | body | Guid | No | Guid representing the external systems datasource information. |
| AlternateKey | body | string | No | The unique key that represents the connection structure object on the external system. |
| ObjectId | body | Guid | No | Guid of the connection structure object within PSTPF. If ObjectId is known, the external system may pass this instead of the alternate key. |
| RmsTableCtxId | body | Guid | No | Connection Structure RmsTableCtxId. |
| StructureDefinitionId | body | Guid | No | Id of the Connection Structure Definition. |
| StructureTypeId | body | Guid | No | Id of the Structure Type. |
| StructureDefinitionXml | body | string | No | XML for the children in the structure for the object indicated via alternateKey/objectId. |
| Name | body | string | No | Connection Structure Name. |
| Reference | body | string | No | Connection Structure Reference. |
| LicenseeId | query | Guid | No | |
| SessionId | query | Guid | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /xml/reply/SaveObjectStructure HTTP/1.1
Host: production-eros-platform-apisubscription.azurewebsites.net
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<SaveObjectStructure xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.ServiceModelSubscription">
<_x003C_AlternateKey_x003E_k__BackingField>String</_x003C_AlternateKey_x003E_k__BackingField>
<_x003C_LicenseeId_x003E_k__BackingField>00000000-0000-0000-0000-000000000000</_x003C_LicenseeId_x003E_k__BackingField>
<_x003C_Name_x003E_k__BackingField>String</_x003C_Name_x003E_k__BackingField>
<_x003C_ObjectId_x003E_k__BackingField>00000000-0000-0000-0000-000000000000</_x003C_ObjectId_x003E_k__BackingField>
<_x003C_Reference_x003E_k__BackingField>String</_x003C_Reference_x003E_k__BackingField>
<_x003C_SessionId_x003E_k__BackingField>00000000-0000-0000-0000-000000000000</_x003C_SessionId_x003E_k__BackingField>
<_x003C_StructureDefinitionId_x003E_k__BackingField>00000000-0000-0000-0000-000000000000</_x003C_StructureDefinitionId_x003E_k__BackingField>
<_x003C_StructureDefinitionXml_x003E_k__BackingField>String</_x003C_StructureDefinitionXml_x003E_k__BackingField>
<_x003C_StructureTypeId_x003E_k__BackingField>00000000-0000-0000-0000-000000000000</_x003C_StructureTypeId_x003E_k__BackingField>
<_x003C_SuiteDataSourceInstanceId_x003E_k__BackingField>00000000-0000-0000-0000-000000000000</_x003C_SuiteDataSourceInstanceId_x003E_k__BackingField>
</SaveObjectStructure>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<ResponseStatus xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
<ErrorCode>String</ErrorCode>
<Message>String</Message>
<StackTrace>String</StackTrace>
<Errors>
<ResponseError>
<ErrorCode>String</ErrorCode>
<FieldName>String</FieldName>
<Message>String</Message>
<Meta xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d4p1:KeyValueOfstringstring>
<d4p1:Key>String</d4p1:Key>
<d4p1:Value>String</d4p1:Value>
</d4p1:KeyValueOfstringstring>
</Meta>
</ResponseError>
</Errors>
<Meta xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:KeyValueOfstringstring>
<d2p1:Key>String</d2p1:Key>
<d2p1:Value>String</d2p1:Value>
</d2p1:KeyValueOfstringstring>
</Meta>
</ResponseStatus>