lock
POST
apiportal/v1/Community
Create a basic community member
EXPANDexpand_more
Request Information
Roles
- Vendor_APIClient
URI Parameters
None.
Body Parameters
Collection of CommunityCore| Name | Description | Type | Additional information |
|---|---|---|---|
| ID | integer |
None. |
|
| IDType | string |
None. |
|
| Surname | string |
None. |
|
| Title | string |
None. |
|
| Preferred | string |
None. |
|
| Given1 | string |
None. |
|
| Given2 | string |
None. |
|
| Gender | string |
None. |
|
| string |
None. |
||
| MobilePhone | string |
None. |
|
| OccupPhone | string |
None. |
|
| OccupFax | string |
None. |
|
| OccupEmail | string |
None. |
|
| OccupCode | string |
None. |
|
| OccupDesc | string |
None. |
|
| OccupCompany | string |
None. |
|
| OccupCompanyAttn | string |
None. |
|
| OccupIndustryCode | string |
None. |
|
| OccupPositionCode | string |
None. |
|
| BirthDate | date |
None. |
|
| Education | string |
None. |
|
| Qualifications | string |
None. |
|
| MailFormat | string |
None. |
|
| ReligionCode | string |
None. |
Request Formats
A
[
{
"ID": 1,
"IDType": "sample string 2",
"Surname": "sample string 3",
"Title": "sample string 4",
"Preferred": "sample string 5",
"Given1": "sample string 6",
"Given2": "sample string 7",
"Gender": "sample string 8",
"Email": "sample string 9",
"MobilePhone": "sample string 10",
"OccupPhone": "sample string 11",
"OccupFax": "sample string 12",
"OccupEmail": "sample string 13",
"OccupCode": "sample string 14",
"OccupDesc": "sample string 15",
"OccupCompany": "sample string 16",
"OccupCompanyAttn": "sample string 17",
"OccupIndustryCode": "sample string 18",
"OccupPositionCode": "sample string 19",
"BirthDate": "2025-12-16T11:55:47.0921956+11:00",
"Education": "sample string 20",
"Qualifications": "sample string 21",
"MailFormat": "sample string 22",
"ReligionCode": "sample string 23"
},
{
"ID": 1,
"IDType": "sample string 2",
"Surname": "sample string 3",
"Title": "sample string 4",
"Preferred": "sample string 5",
"Given1": "sample string 6",
"Given2": "sample string 7",
"Gender": "sample string 8",
"Email": "sample string 9",
"MobilePhone": "sample string 10",
"OccupPhone": "sample string 11",
"OccupFax": "sample string 12",
"OccupEmail": "sample string 13",
"OccupCode": "sample string 14",
"OccupDesc": "sample string 15",
"OccupCompany": "sample string 16",
"OccupCompanyAttn": "sample string 17",
"OccupIndustryCode": "sample string 18",
"OccupPositionCode": "sample string 19",
"BirthDate": "2025-12-16T11:55:47.0921956+11:00",
"Education": "sample string 20",
"Qualifications": "sample string 21",
"MailFormat": "sample string 22",
"ReligionCode": "sample string 23"
}
]
<ArrayOfCommunityCore xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Synergetic.Model.APIClient">
<CommunityCore>
<BirthDate>2025-12-16T11:55:47.0921956+11:00</BirthDate>
<Education>sample string 20</Education>
<Email>sample string 9</Email>
<Gender>sample string 8</Gender>
<Given1>sample string 6</Given1>
<Given2>sample string 7</Given2>
<ID>1</ID>
<IDType>sample string 2</IDType>
<MailFormat>sample string 22</MailFormat>
<MobilePhone>sample string 10</MobilePhone>
<OccupCode>sample string 14</OccupCode>
<OccupCompany>sample string 16</OccupCompany>
<OccupCompanyAttn>sample string 17</OccupCompanyAttn>
<OccupDesc>sample string 15</OccupDesc>
<OccupEmail>sample string 13</OccupEmail>
<OccupFax>sample string 12</OccupFax>
<OccupIndustryCode>sample string 18</OccupIndustryCode>
<OccupPhone>sample string 11</OccupPhone>
<OccupPositionCode>sample string 19</OccupPositionCode>
<Preferred>sample string 5</Preferred>
<Qualifications>sample string 21</Qualifications>
<ReligionCode>sample string 23</ReligionCode>
<Surname>sample string 3</Surname>
<Title>sample string 4</Title>
</CommunityCore>
<CommunityCore>
<BirthDate>2025-12-16T11:55:47.0921956+11:00</BirthDate>
<Education>sample string 20</Education>
<Email>sample string 9</Email>
<Gender>sample string 8</Gender>
<Given1>sample string 6</Given1>
<Given2>sample string 7</Given2>
<ID>1</ID>
<IDType>sample string 2</IDType>
<MailFormat>sample string 22</MailFormat>
<MobilePhone>sample string 10</MobilePhone>
<OccupCode>sample string 14</OccupCode>
<OccupCompany>sample string 16</OccupCompany>
<OccupCompanyAttn>sample string 17</OccupCompanyAttn>
<OccupDesc>sample string 15</OccupDesc>
<OccupEmail>sample string 13</OccupEmail>
<OccupFax>sample string 12</OccupFax>
<OccupIndustryCode>sample string 18</OccupIndustryCode>
<OccupPhone>sample string 11</OccupPhone>
<OccupPositionCode>sample string 19</OccupPositionCode>
<Preferred>sample string 5</Preferred>
<Qualifications>sample string 21</Qualifications>
<ReligionCode>sample string 23</ReligionCode>
<Surname>sample string 3</Surname>
<Title>sample string 4</Title>
</CommunityCore>
</ArrayOfCommunityCore>
Sample not available.
EXPANDexpand_more
Response Information
Resource Description
List of community members created
Collection of CreateCommunityRespModel| Name | Description | Type | Additional information |
|---|---|---|---|
| RowNum | integer |
None. |
|
| Result | CreateCommunityModel |
None. |
Response Formats
A
[
{
"RowNum": 1,
"Result": {
"CommunityID": 1,
"SpouseID": 1
}
},
{
"RowNum": 1,
"Result": {
"CommunityID": 1,
"SpouseID": 1
}
}
]
<ArrayOfCreateCommunityRespModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Synergetic.Model.APIClient">
<CreateCommunityRespModel>
<Result>
<CommunityID>1</CommunityID>
<SpouseID>1</SpouseID>
</Result>
<RowNum>1</RowNum>
</CreateCommunityRespModel>
<CreateCommunityRespModel>
<Result>
<CommunityID>1</CommunityID>
<SpouseID>1</SpouseID>
</Result>
<RowNum>1</RowNum>
</CreateCommunityRespModel>
</ArrayOfCreateCommunityRespModel>