PATCH

apiportal/v1/community/{communityid}/Relationship

Update a relationship - replaces only supplied parameters

Request Information

Roles

Vendor_APIClient

URI Parameters

Name	Description	Type	Additional information
communityid	Community ID	integer	None.

Body Parameters

List of relationships

Collection of spuRelationships_Request

Name	Type	Additional information
RelationshipSeq	integer	None.
RelatedID	integer	None.
Relationship	string	None.
UseEmail	string	None.
UseSMS	string	None.
PortalApproval	string	None.
NonCommunityRelation	string	None.

Request Formats

[
  {
    "RelationshipSeq": 1,
    "RelatedID": 2,
    "Relationship": "sample string 3",
    "UseEmail": "sample string 4",
    "UseSMS": "sample string 5",
    "PortalApproval": "sample string 6",
    "NonCommunityRelation": "sample string 7"
  },
  {
    "RelationshipSeq": 1,
    "RelatedID": 2,
    "Relationship": "sample string 3",
    "UseEmail": "sample string 4",
    "UseSMS": "sample string 5",
    "PortalApproval": "sample string 6",
    "NonCommunityRelation": "sample string 7"
  }
]

<ArrayOfspuRelationships_Request xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Synergetic.Model.APIClient">
  <spuRelationships_Request>
    <NonCommunityRelation>sample string 7</NonCommunityRelation>
    <PortalApproval>sample string 6</PortalApproval>
    <RelatedID>2</RelatedID>
    <Relationship>sample string 3</Relationship>
    <RelationshipSeq>1</RelationshipSeq>
    <UseEmail>sample string 4</UseEmail>
    <UseSMS>sample string 5</UseSMS>
  </spuRelationships_Request>
  <spuRelationships_Request>
    <NonCommunityRelation>sample string 7</NonCommunityRelation>
    <PortalApproval>sample string 6</PortalApproval>
    <RelatedID>2</RelatedID>
    <Relationship>sample string 3</Relationship>
    <RelationshipSeq>1</RelationshipSeq>
    <UseEmail>sample string 4</UseEmail>
    <UseSMS>sample string 5</UseSMS>
  </spuRelationships_Request>
</ArrayOfspuRelationships_Request>

Sample not available.

Response Information

Resource Description

List of ChangeEntitySeqRespModel

Collection of ChangeEntitySeqRespModel

Name	Description	Type	Additional information
RowNum		integer	None.
Result		ChangeEntitySeqModel	None.

[
  {
    "RowNum": 1,
    "Result": {
      "EntitySeq": 1,
      "Error": "sample string 1",
      "ValidationDetails": [
        {
          "FieldName": "sample string 1",
          "Reason": "sample string 2"
        },
        {
          "FieldName": "sample string 1",
          "Reason": "sample string 2"
        }
      ]
    }
  },
  {
    "RowNum": 1,
    "Result": {
      "EntitySeq": 1,
      "Error": "sample string 1",
      "ValidationDetails": [
        {
          "FieldName": "sample string 1",
          "Reason": "sample string 2"
        },
        {
          "FieldName": "sample string 1",
          "Reason": "sample string 2"
        }
      ]
    }
  }
]

<ArrayOfChangeEntitySeqRespModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Synergetic.Model.APIClient">
  <ChangeEntitySeqRespModel>
    <Result>
      <Error>sample string 1</Error>
      <ValidationDetails>
        <ValidationDetails>
          <FieldName>sample string 1</FieldName>
          <Reason>sample string 2</Reason>
        </ValidationDetails>
        <ValidationDetails>
          <FieldName>sample string 1</FieldName>
          <Reason>sample string 2</Reason>
        </ValidationDetails>
      </ValidationDetails>
      <EntitySeq>1</EntitySeq>
    </Result>
    <RowNum>1</RowNum>
  </ChangeEntitySeqRespModel>
  <ChangeEntitySeqRespModel>
    <Result>
      <Error>sample string 1</Error>
      <ValidationDetails>
        <ValidationDetails>
          <FieldName>sample string 1</FieldName>
          <Reason>sample string 2</Reason>
        </ValidationDetails>
        <ValidationDetails>
          <FieldName>sample string 1</FieldName>
          <Reason>sample string 2</Reason>
        </ValidationDetails>
      </ValidationDetails>
      <EntitySeq>1</EntitySeq>
    </Result>
    <RowNum>1</RowNum>
  </ChangeEntitySeqRespModel>
</ArrayOfChangeEntitySeqRespModel>