Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| communityId |
The community identifier. |
integer |
Required |
Body Parameters
The community.
Pico.Community| Name | Description | Type | Additional information |
|---|---|---|---|
| code |
Gets or sets the code. |
string |
None. |
| description |
Gets or sets the description. |
string |
None. |
| isActive |
Gets or sets a value indicating whether this is active. |
boolean |
None. |
| id |
Gets or sets the community identifier. |
integer |
None. |
| address |
Gets or sets the address identifier. |
integer |
None. |
| corporatePartner |
Gets or sets the corporate partner identifier. |
integer |
None. |
| organization |
Gets or sets the organization identifier. |
integer |
None. |
| parentCommunity |
Gets or sets the parent community identifier. |
integer |
None. |
| provider |
Gets or sets the provider identifier. |
integer |
None. |
Request Formats
application/json, text/json
{
"code": "sample String 1",
"description": "sample String 2",
"isActive": true,
"id": "4",
"address": "1",
"corporatePartner": "1",
"organization": "5",
"parentCommunity": "1",
"provider": "6"
}
text/html
{"code":"sample String 1","description":"sample String 2","isActive":true,"id":"4","address":"1","corporatePartner":"1","organization":"5","parentCommunity":"1","provider":"6"}
application/xml, text/xml
<Community xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <Code>sample String 1</Code> <Description>sample String 2</Description> <IsActive>true</IsActive> <CommunityId>4</CommunityId> <AddressId>1</AddressId> <CorporatePartnerId>1</CorporatePartnerId> <OrganizationId>5</OrganizationId> <ParentCommunityId>1</ParentCommunityId> <ProviderId>6</ProviderId> </Community>
application/x-www-form-urlencoded
Sample not available.
Response Information
Resource Description
The updated community.
Pico.Community| Name | Description | Type | Additional information |
|---|---|---|---|
| code |
Gets or sets the code. |
string |
None. |
| description |
Gets or sets the description. |
string |
None. |
| isActive |
Gets or sets a value indicating whether this is active. |
boolean |
None. |
| id |
Gets or sets the community identifier. |
integer |
None. |
| address |
Gets or sets the address identifier. |
integer |
None. |
| corporatePartner |
Gets or sets the corporate partner identifier. |
integer |
None. |
| organization |
Gets or sets the organization identifier. |
integer |
None. |
| parentCommunity |
Gets or sets the parent community identifier. |
integer |
None. |
| provider |
Gets or sets the provider identifier. |
integer |
None. |
Response Formats
application/json, text/json
{
"code": "sample String 1",
"description": "sample String 2",
"isActive": true,
"id": "4",
"address": "1",
"corporatePartner": "1",
"organization": "5",
"parentCommunity": "1",
"provider": "6"
}
text/html
{"code":"sample String 1","description":"sample String 2","isActive":true,"id":"4","address":"1","corporatePartner":"1","organization":"5","parentCommunity":"1","provider":"6"}
application/xml, text/xml
<Community xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <Code>sample String 1</Code> <Description>sample String 2</Description> <IsActive>true</IsActive> <CommunityId>4</CommunityId> <AddressId>1</AddressId> <CorporatePartnerId>1</CorporatePartnerId> <OrganizationId>5</OrganizationId> <ParentCommunityId>1</ParentCommunityId> <ProviderId>6</ProviderId> </Community>