POST v1/{Client}/Persons
Adds one Person.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| Client |
The code of the Client database to connect to. |
string |
Required |
Body Parameters
GranicusPerson object to be inserted. Note that PersonId is not required to be set.
GranicusPerson| Name | Description | Type | Additional information |
|---|---|---|---|
| PersonId | integer |
None. |
|
| PersonGuid | string |
None. |
|
| PersonLastModifiedUtc | date |
None. |
|
| PersonRowVersion | Collection of byte |
None. |
|
| PersonFirstName | string |
None. |
|
| PersonLastName | string |
Required |
|
| PersonFullName | string |
Required |
|
| PersonActiveFlag | integer |
None. |
|
| PersonCanViewFlag | integer |
None. |
|
| PersonUsedSponsorFlag | integer |
None. |
|
| PersonAddress1 | string |
None. |
|
| PersonCity1 | string |
None. |
|
| PersonState1 | string |
None. |
|
| PersonZip1 | string |
None. |
|
| PersonPhone | string |
None. |
|
| PersonFax | string |
None. |
|
| PersonEmail | string |
None. |
|
| PersonWWW | string |
None. |
|
| PersonAddress2 | string |
None. |
|
| PersonCity2 | string |
None. |
|
| PersonState2 | string |
None. |
|
| PersonZip2 | string |
None. |
|
| PersonPhone2 | string |
None. |
|
| PersonFax2 | string |
None. |
|
| PersonEmail2 | string |
None. |
|
| PersonWWW2 | string |
None. |
Request Formats
application/json, text/json
Sample:
{
"PersonId": 1,
"PersonGuid": "sample string 2",
"PersonLastModifiedUtc": "2025-11-17T08:57:19.2839868-05:00",
"PersonRowVersion": "QEA=",
"PersonFirstName": "sample string 4",
"PersonLastName": "sample string 5",
"PersonFullName": "sample string 6",
"PersonActiveFlag": 7,
"PersonCanViewFlag": 1,
"PersonUsedSponsorFlag": 8,
"PersonAddress1": "sample string 9",
"PersonCity1": "sample string 10",
"PersonState1": "sample string 11",
"PersonZip1": "sample string 12",
"PersonPhone": "sample string 13",
"PersonFax": "sample string 14",
"PersonEmail": "sample string 15",
"PersonWWW": "sample string 16",
"PersonAddress2": "sample string 17",
"PersonCity2": "sample string 18",
"PersonState2": "sample string 19",
"PersonZip2": "sample string 20",
"PersonPhone2": "sample string 21",
"PersonFax2": "sample string 22",
"PersonEmail2": "sample string 23",
"PersonWWW2": "sample string 24"
}
application/xml, text/xml
Sample:
<GranicusPerson xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LegistarWebAPI.Models.v1"> <PersonActiveFlag>7</PersonActiveFlag> <PersonAddress1>sample string 9</PersonAddress1> <PersonAddress2>sample string 17</PersonAddress2> <PersonCanViewFlag>1</PersonCanViewFlag> <PersonCity1>sample string 10</PersonCity1> <PersonCity2>sample string 18</PersonCity2> <PersonEmail>sample string 15</PersonEmail> <PersonEmail2>sample string 23</PersonEmail2> <PersonFax>sample string 14</PersonFax> <PersonFax2>sample string 22</PersonFax2> <PersonFirstName>sample string 4</PersonFirstName> <PersonFullName>sample string 6</PersonFullName> <PersonGuid>sample string 2</PersonGuid> <PersonId>1</PersonId> <PersonLastModifiedUtc>2025-11-17T08:57:19.2839868-05:00</PersonLastModifiedUtc> <PersonLastName>sample string 5</PersonLastName> <PersonPhone>sample string 13</PersonPhone> <PersonPhone2>sample string 21</PersonPhone2> <PersonRowVersion>QEA=</PersonRowVersion> <PersonState1>sample string 11</PersonState1> <PersonState2>sample string 19</PersonState2> <PersonUsedSponsorFlag>8</PersonUsedSponsorFlag> <PersonWWW>sample string 16</PersonWWW> <PersonWWW2>sample string 24</PersonWWW2> <PersonZip1>sample string 12</PersonZip1> <PersonZip2>sample string 20</PersonZip2> </GranicusPerson>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
Returns Id of a created Person as a string value when Accept header is "text/plain"; otherwise returns created Person as an object.
HttpResponseMessage| Name | Description | Type | Additional information |
|---|---|---|---|
| Version | Version |
None. |
|
| Content | HttpContent |
None. |
|
| StatusCode | HttpStatusCode |
None. |
|
| ReasonPhrase | string |
None. |
|
| Headers | Collection of Object |
None. |
|
| RequestMessage | HttpRequestMessage |
None. |
|
| IsSuccessStatusCode | boolean |
None. |