admin/SUG/opportunity/savevolunteer
Request Information
Body Parameters
Body parameters need to be integrated as json key value collection followed by valid object notations, below if the list of parameters can be sent as request body by an integrator.
| Name | Description | Type | Additional information |
|---|---|---|---|
| OpportunityInfo | Collection of ContactOpportunityInfo |
None. |
|
| Prefix | string |
String length: inclusive between 0 and 100 |
|
| FirstName | string |
String length: inclusive between 0 and 250 |
|
| LastName | string |
String length: inclusive between 0 and 250 |
|
| Suffix | string |
String length: inclusive between 0 and 100 |
|
| BirthDate | date |
None. |
|
| Deceased | boolean |
None. |
|
| Gender | string |
String length: inclusive between 0 and 250 |
|
| Ethnicities | string |
None. |
|
| Id | integer |
None. |
|
| ContactName | string |
String length: inclusive between 0 and 250 |
|
| Active | boolean |
None. |
|
| PersonalEmail | ContactEmail |
None. |
|
| WorkEmail | ContactEmail |
None. |
|
| PhoneNumber | string |
String length: inclusive between 0 and 15 |
|
| CellNumber | string |
String length: inclusive between 0 and 15 |
|
| FaxNumber | string |
String length: inclusive between 0 and 15 |
|
| HomePhoneNumber | string |
String length: inclusive between 0 and 15 |
|
| WorkPhoneNumber | string |
String length: inclusive between 0 and 15 |
|
| MailingAddress | ContactAddress |
None. |
Request Format
Below is the typical object of the request, in order to use the API for various requirement, refer the documentation.
{
"OpportunityInfo": [
{
"OpportunityId": 2,
"OpportunityName": "String Parameter 3",
"OpportunityOwner": "String Parameter 4",
"OrganizationName": "String Parameter 5",
"CurrentStatus": "String Parameter 6",
"VerifiedHours": 7.0,
"UnverifiedHours": 8.0,
"ApplicationDate": "2024/09/07 18:02:58",
"OpportunityStartDate": "2024/09/07 18:02:58",
"OpportunityEndDate": "2024/09/07 18:02:58"
},
{
"OpportunityId": 2,
"OpportunityName": "String Parameter 3",
"OpportunityOwner": "String Parameter 4",
"OrganizationName": "String Parameter 5",
"CurrentStatus": "String Parameter 6",
"VerifiedHours": 7.0,
"UnverifiedHours": 8.0,
"ApplicationDate": "2024/09/07 18:02:58",
"OpportunityStartDate": "2024/09/07 18:02:58",
"OpportunityEndDate": "2024/09/07 18:02:58"
}
],
"Prefix": "String Parameter 1",
"FirstName": "String Parameter 2",
"LastName": "String Parameter 3",
"Suffix": "String Parameter 4",
"BirthDate": "2024/09/07 18:02:58",
"Deceased": true,
"Gender": "String Parameter 6",
"Ethnicities": "String Parameter 7",
"Id": 8,
"ContactName": "String Parameter 9",
"Active": true,
"PersonalEmail": {
"EmailAddress": "String Parameter 1",
"Verified": true
},
"WorkEmail": {
"EmailAddress": "String Parameter 1",
"Verified": true
},
"PhoneNumber": "String Parameter 11",
"CellNumber": "String Parameter 12",
"FaxNumber": "String Parameter 13",
"HomePhoneNumber": "String Parameter 14",
"WorkPhoneNumber": "String Parameter 15",
"MailingAddress": {
"Address1": "String Parameter 1",
"Address2": "String Parameter 2",
"Address3": "String Parameter 3",
"Address4": "String Parameter 4",
"City": "String Parameter 5",
"State": "String Parameter 6",
"Zip": "String Parameter 7",
"Country": "String Parameter 8",
"County": "String Parameter 9"
}
}
Response Information
Resource Description
ITypedResponseOfVolunteerContact| Name | Description | Type | Additional information |
|---|---|---|---|
| Result | VolunteerContact |
None. |
|
| Category | string |
None. |
Response Formats
Sample not available.