POST api/v2.0/ExternalSearch/AddVolunteerOpportunityItems

Add External Volunteer Opportunity Items to the Search Results.

Request Information

URI Parameters

None.

Body Parameters

External Volunteer Opportunity Items to add.

Collection of ExternalVolunteerOpportunity

Name	Type	Additional information
ContributorLegacyContactKey	string	None.
Additional	Collection of string	None.
Code	string	None.
CommitmentHours	integer	None.
CreatedOn	date	None.
Description	string	None.
ExperienceLevel	string	None.
ID	string	None.
IsDelete	boolean	None.
Link	LinkInfo	None.
Location	string	None.
StartDate	date	None.
Tags	Collection of TagInfo	None.
Title	string	None.
Url	string	None.
ViewSecurityRoles	Collection of string	None.
VolunteerOpportunityType	string	None.

Request Formats

application/json, text/json

Sample:

[
  {
    "ContributorLegacyContactKey": "sample string 1",
    "Additional": [
      "sample string 1",
      "sample string 2"
    ],
    "Code": "sample string 2",
    "CommitmentHours": 3,
    "CreatedOn": "2024-12-26T10:41:11.0870456Z",
    "Description": "sample string 5",
    "ExperienceLevel": "sample string 6",
    "ID": "sample string 7",
    "IsDelete": true,
    "Link": {
      "Text": "sample string 1",
      "Url": "sample string 2"
    },
    "Location": "sample string 9",
    "StartDate": "2024-12-26T10:41:11.0870456Z",
    "Tags": [
      {
        "Tag": "sample string 1",
        "TagGroup": "sample string 2"
      },
      {
        "Tag": "sample string 1",
        "TagGroup": "sample string 2"
      }
    ],
    "Title": "sample string 11",
    "Url": "sample string 12",
    "ViewSecurityRoles": [
      "sample string 1",
      "sample string 2"
    ],
    "VolunteerOpportunityType": "sample string 13"
  },
  {
    "ContributorLegacyContactKey": "sample string 1",
    "Additional": [
      "sample string 1",
      "sample string 2"
    ],
    "Code": "sample string 2",
    "CommitmentHours": 3,
    "CreatedOn": "2024-12-26T10:41:11.0870456Z",
    "Description": "sample string 5",
    "ExperienceLevel": "sample string 6",
    "ID": "sample string 7",
    "IsDelete": true,
    "Link": {
      "Text": "sample string 1",
      "Url": "sample string 2"
    },
    "Location": "sample string 9",
    "StartDate": "2024-12-26T10:41:11.0870456Z",
    "Tags": [
      {
        "Tag": "sample string 1",
        "TagGroup": "sample string 2"
      },
      {
        "Tag": "sample string 1",
        "TagGroup": "sample string 2"
      }
    ],
    "Title": "sample string 11",
    "Url": "sample string 12",
    "ViewSecurityRoles": [
      "sample string 1",
      "sample string 2"
    ],
    "VolunteerOpportunityType": "sample string 13"
  }
]

application/xml, text/xml

Sample:

<ArrayOfExternalSearchItem.ExternalVolunteerOpportunity xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/HigherLogic.Business.Core">
  <ExternalSearchItem.ExternalVolunteerOpportunity>
    <_x003C_Additional_x003E_k__BackingField xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </_x003C_Additional_x003E_k__BackingField>
    <_x003C_Code_x003E_k__BackingField>sample string 2</_x003C_Code_x003E_k__BackingField>
    <_x003C_CommitmentHours_x003E_k__BackingField>3</_x003C_CommitmentHours_x003E_k__BackingField>
    <_x003C_ContributorLegacyContactKey_x003E_k__BackingField>sample string 1</_x003C_ContributorLegacyContactKey_x003E_k__BackingField>
    <_x003C_CreatedOn_x003E_k__BackingField>2024-12-26T05:41:11.0870456-05:00</_x003C_CreatedOn_x003E_k__BackingField>
    <_x003C_Description_x003E_k__BackingField>sample string 5</_x003C_Description_x003E_k__BackingField>
    <_x003C_ExperienceLevel_x003E_k__BackingField>sample string 6</_x003C_ExperienceLevel_x003E_k__BackingField>
    <_x003C_ID_x003E_k__BackingField>sample string 7</_x003C_ID_x003E_k__BackingField>
    <_x003C_IsDelete_x003E_k__BackingField>true</_x003C_IsDelete_x003E_k__BackingField>
    <_x003C_Link_x003E_k__BackingField>
      <_x003C_Text_x003E_k__BackingField>sample string 1</_x003C_Text_x003E_k__BackingField>
      <_x003C_Url_x003E_k__BackingField>sample string 2</_x003C_Url_x003E_k__BackingField>
    </_x003C_Link_x003E_k__BackingField>
    <_x003C_Location_x003E_k__BackingField>sample string 9</_x003C_Location_x003E_k__BackingField>
    <_x003C_StartDate_x003E_k__BackingField>2024-12-26T05:41:11.0870456-05:00</_x003C_StartDate_x003E_k__BackingField>
    <_x003C_Tags_x003E_k__BackingField>
      <ExternalSearchItem.TagInfo>
        <_x003C_TagGroup_x003E_k__BackingField>sample string 2</_x003C_TagGroup_x003E_k__BackingField>
        <_x003C_Tag_x003E_k__BackingField>sample string 1</_x003C_Tag_x003E_k__BackingField>
      </ExternalSearchItem.TagInfo>
      <ExternalSearchItem.TagInfo>
        <_x003C_TagGroup_x003E_k__BackingField>sample string 2</_x003C_TagGroup_x003E_k__BackingField>
        <_x003C_Tag_x003E_k__BackingField>sample string 1</_x003C_Tag_x003E_k__BackingField>
      </ExternalSearchItem.TagInfo>
    </_x003C_Tags_x003E_k__BackingField>
    <_x003C_Title_x003E_k__BackingField>sample string 11</_x003C_Title_x003E_k__BackingField>
    <_x003C_Url_x003E_k__BackingField>sample string 12</_x003C_Url_x003E_k__BackingField>
    <_x003C_ViewSecurityRoles_x003E_k__BackingField xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </_x003C_ViewSecurityRoles_x003E_k__BackingField>
    <_x003C_VolunteerOpportunityType_x003E_k__BackingField>sample string 13</_x003C_VolunteerOpportunityType_x003E_k__BackingField>
  </ExternalSearchItem.ExternalVolunteerOpportunity>
  <ExternalSearchItem.ExternalVolunteerOpportunity>
    <_x003C_Additional_x003E_k__BackingField xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </_x003C_Additional_x003E_k__BackingField>
    <_x003C_Code_x003E_k__BackingField>sample string 2</_x003C_Code_x003E_k__BackingField>
    <_x003C_CommitmentHours_x003E_k__BackingField>3</_x003C_CommitmentHours_x003E_k__BackingField>
    <_x003C_ContributorLegacyContactKey_x003E_k__BackingField>sample string 1</_x003C_ContributorLegacyContactKey_x003E_k__BackingField>
    <_x003C_CreatedOn_x003E_k__BackingField>2024-12-26T05:41:11.0870456-05:00</_x003C_CreatedOn_x003E_k__BackingField>
    <_x003C_Description_x003E_k__BackingField>sample string 5</_x003C_Description_x003E_k__BackingField>
    <_x003C_ExperienceLevel_x003E_k__BackingField>sample string 6</_x003C_ExperienceLevel_x003E_k__BackingField>
    <_x003C_ID_x003E_k__BackingField>sample string 7</_x003C_ID_x003E_k__BackingField>
    <_x003C_IsDelete_x003E_k__BackingField>true</_x003C_IsDelete_x003E_k__BackingField>
    <_x003C_Link_x003E_k__BackingField>
      <_x003C_Text_x003E_k__BackingField>sample string 1</_x003C_Text_x003E_k__BackingField>
      <_x003C_Url_x003E_k__BackingField>sample string 2</_x003C_Url_x003E_k__BackingField>
    </_x003C_Link_x003E_k__BackingField>
    <_x003C_Location_x003E_k__BackingField>sample string 9</_x003C_Location_x003E_k__BackingField>
    <_x003C_StartDate_x003E_k__BackingField>2024-12-26T05:41:11.0870456-05:00</_x003C_StartDate_x003E_k__BackingField>
    <_x003C_Tags_x003E_k__BackingField>
      <ExternalSearchItem.TagInfo>
        <_x003C_TagGroup_x003E_k__BackingField>sample string 2</_x003C_TagGroup_x003E_k__BackingField>
        <_x003C_Tag_x003E_k__BackingField>sample string 1</_x003C_Tag_x003E_k__BackingField>
      </ExternalSearchItem.TagInfo>
      <ExternalSearchItem.TagInfo>
        <_x003C_TagGroup_x003E_k__BackingField>sample string 2</_x003C_TagGroup_x003E_k__BackingField>
        <_x003C_Tag_x003E_k__BackingField>sample string 1</_x003C_Tag_x003E_k__BackingField>
      </ExternalSearchItem.TagInfo>
    </_x003C_Tags_x003E_k__BackingField>
    <_x003C_Title_x003E_k__BackingField>sample string 11</_x003C_Title_x003E_k__BackingField>
    <_x003C_Url_x003E_k__BackingField>sample string 12</_x003C_Url_x003E_k__BackingField>
    <_x003C_ViewSecurityRoles_x003E_k__BackingField xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </_x003C_ViewSecurityRoles_x003E_k__BackingField>
    <_x003C_VolunteerOpportunityType_x003E_k__BackingField>sample string 13</_x003C_VolunteerOpportunityType_x003E_k__BackingField>
  </ExternalSearchItem.ExternalVolunteerOpportunity>
</ArrayOfExternalSearchItem.ExternalVolunteerOpportunity>

Response Information

Resource Description

AddItemsResponse

Name	Description	Type	Additional information
QueuedIdList	List of IDs that have been successfully accepted for index queuing within the Community site.	Collection of string	None.
Errors	List of Errors that occurred when attempting to queue the passed in External Search items.	Collection of ItemError	None.

Response Formats

application/json, text/json

Sample:

{
  "QueuedIdList": [
    "sample string 1",
    "sample string 2"
  ],
  "Errors": [
    {
      "ErrorMessage": "sample string 1",
      "Item": "sample string 2"
    },
    {
      "ErrorMessage": "sample string 1",
      "Item": "sample string 2"
    }
  ]
}

application/xml, text/xml

Sample:

<AddItemsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/HigherLogic.API.Models.Enterprise.ExternalSearch">
  <Errors>
    <ItemError>
      <ErrorMessage>sample string 1</ErrorMessage>
      <Item>sample string 2</Item>
    </ItemError>
    <ItemError>
      <ErrorMessage>sample string 1</ErrorMessage>
      <Item>sample string 2</Item>
    </ItemError>
  </Errors>
  <QueuedIdList xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </QueuedIdList>
</AddItemsResponse>