POST api/DeclareIP/CreateItemDeclareIP

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
FormContext	FormContext	None.
IPUrl	string	None.
WebUrl	string	None.
EOfficeDataSiteUrl	string	None.
EmailUserCreate	string	None.

Request Formats

application/json, text/json

Sample:

{
  "FormContext": {
    "DisplayMode": "sample string 1",
    "ListName": "sample string 2",
    "ListGuid": "1f85bb58-4ccb-4c1c-ba3e-98eff4a8a070",
    "HistoryListGuid": "73cc1b93-a752-4ceb-a8d0-2f926db038ea",
    "ItemId": 5,
    "itemId": "sample string 6",
    "ItemUniqueId": "beee5636-38e7-4648-9f23-2d67b84d2781",
    "CurrentUser": {
      "Id": 1,
      "Email": "sample string 2",
      "Username": "sample string 3",
      "DisplayName": "sample string 4",
      "PictureURL": "sample string 5"
    },
    "WebRelativeUrl": "sample string 8",
    "RootSiteUrl": "sample string 9",
    "WebUrl": "sample string 10",
    "DiscussionListGuid": "5bef44cf-ea30-4c88-9e1a-7cb2d8f2fe56",
    "DocLibListGuid": "83d9afd2-fe4e-4c60-b5d1-78fac4332726",
    "Settings": {
      "BackendApiUrl": "sample string 1",
      "EOfficeDataSiteUrl": "sample string 2",
      "HTTMSiteURL": "sample string 3"
    },
    "FormItem": {
      "Id": 1,
      "UniqueId": "5ad86a50-1dea-428b-a620-647427b05b69",
      "Title": "sample string 2",
      "Ref": "sample string 3",
      "Requester": {
        "Id": 1,
        "Email": "sample string 2",
        "Username": "sample string 3",
        "DisplayName": "sample string 4",
        "PictureURL": "sample string 5"
      },
      "FormCode": "sample string 4",
      "FormType": "sample string 5",
      "FormTemplate": "sample string 6",
      "FormNumber": "sample string 7",
      "FormTemplateID": 8,
      "FormTemplateWebGuid": "57c7983f-5ff2-457b-b8e3-59ce511e2088",
      "FormTemplateSiteGuid": "280f9976-77b9-441a-97a6-8e8bd556e4ec",
      "FormPublishedDate": "2026-05-07T20:25:30.9607204+07:00",
      "ApprovalStatus": "sample string 9",
      "CurrentApprovers": [
        {
          "Id": 1,
          "Email": "sample string 2",
          "Username": "sample string 3",
          "DisplayName": "sample string 4",
          "PictureURL": "sample string 5"
        },
        {
          "Id": 1,
          "Email": "sample string 2",
          "Username": "sample string 3",
          "DisplayName": "sample string 4",
          "PictureURL": "sample string 5"
        }
      ],
      "HistoryListGuid": "c728f9cb-28ed-444e-ac41-460d6bae2f56",
      "DiscussionListGuid": "1dc2cc1c-e564-4627-84a1-9550428c1edc",
      "DocLibListGuid": "577896a6-0b9c-4860-8aba-6138ee600eff",
      "FormCategory": "sample string 10",
      "Department": {
        "Label": "sample string 1",
        "TermGuid": "sample string 2",
        "WssId": 3,
        "TypeId": "{19e70ed0-4177-456b-8156-015e4d163ff8}"
      },
      "WFName": "sample string 11",
      "CurrentApproverDueDate": "2026-05-07T20:25:30.9607204+07:00",
      "SubmittedDate": "2026-05-07T20:25:30.9607204+07:00",
      "CurrentGroup": "sample string 12",
      "CurrentApproverJobTitle": "sample string 13",
      "SubmitCounter": 14,
      "EffectiveDate": "2026-05-07T20:25:30.9607204+07:00",
      "IsoNumber": "sample string 15",
      "HasTemplate": "sample string 16",
      "HasIsoNumber": "sample string 17",
      "Group": "sample string 18",
      "DepartmentCode": {},
      "FormSetItemID": "sample string 20",
      "RefDisplayHTML": "sample string 21",
      "MFItem": {
        "Id": 1,
        "Title": "sample string 2",
        "Ref": "sample string 3",
        "SiteGuid": "0e3ab8a8-1cb5-4133-bc10-93beda562684",
        "ListGuid": "10b489d6-2775-4d80-87a0-5e325a130fd1",
        "WebGuid": "2223228e-7c0d-471e-b52d-8e964ab0a207",
        "ItemId": 7,
        "RefDisplayHTML": "sample string 8",
        "FormCode": "sample string 9",
        "WebUrl": "sample string 10",
        "FormType": "sample string 11"
      },
      "PRItemDetailListGuid": "9ccb7417-049b-4857-9be5-575113c205be"
    },
    "ClearAdditionalItemOnly": true,
    "ClearApprovalGroup": true,
    "SiteGuid": "2768b127-4133-4598-a154-153613e671df",
    "WebGuid": "06b6867d-aca6-431d-b34b-835af86506a0",
    "SyncPermission": true,
    "ClearApprovalMatrix": true,
    "WFName": "sample string 18",
    "EOfficeDataSiteUrl": "sample string 19",
    "FormCode": "sample string 20",
    "FormType": "sample string 21",
    "KeyValue": "sample string 22",
    "IsGenerateApprovalMatrix": true
  },
  "IPUrl": "sample string 1",
  "WebUrl": "sample string 2",
  "EOfficeDataSiteUrl": "sample string 3",
  "EmailUserCreate": "sample string 4"
}

application/xml, text/xml

Sample:

<DeclareIP xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Appvity.eOffice.Backend.Services.DeclareIPService">
  <EOfficeDataSiteUrl>sample string 3</EOfficeDataSiteUrl>
  <EmailUserCreate>sample string 4</EmailUserCreate>
  <FormContext xmlns:d2p1="http://schemas.datacontract.org/2004/07/Appvity.eOffice.Backend.Models">
    <d2p1:ClearAdditionalItemOnly>true</d2p1:ClearAdditionalItemOnly>
    <d2p1:ClearApprovalGroup>true</d2p1:ClearApprovalGroup>
    <d2p1:ClearApprovalMatrix>true</d2p1:ClearApprovalMatrix>
    <d2p1:CurrentUser>
      <d2p1:DisplayName>sample string 4</d2p1:DisplayName>
      <d2p1:Email>sample string 2</d2p1:Email>
      <d2p1:Id>1</d2p1:Id>
      <d2p1:PictureURL>sample string 5</d2p1:PictureURL>
      <d2p1:Username>sample string 3</d2p1:Username>
    </d2p1:CurrentUser>
    <d2p1:DiscussionListGuid>5bef44cf-ea30-4c88-9e1a-7cb2d8f2fe56</d2p1:DiscussionListGuid>
    <d2p1:DisplayMode>sample string 1</d2p1:DisplayMode>
    <d2p1:DocLibListGuid>83d9afd2-fe4e-4c60-b5d1-78fac4332726</d2p1:DocLibListGuid>
    <d2p1:EOfficeDataSiteUrl>sample string 19</d2p1:EOfficeDataSiteUrl>
    <d2p1:FormCode>sample string 20</d2p1:FormCode>
    <d2p1:FormItem>
      <d2p1:ApprovalStatus>sample string 9</d2p1:ApprovalStatus>
      <d2p1:CurrentApproverDueDate>2026-05-07T20:25:30.9607204+07:00</d2p1:CurrentApproverDueDate>
      <d2p1:CurrentApproverJobTitle>sample string 13</d2p1:CurrentApproverJobTitle>
      <d2p1:CurrentApprovers>
        <d2p1:FormUser>
          <d2p1:DisplayName>sample string 4</d2p1:DisplayName>
          <d2p1:Email>sample string 2</d2p1:Email>
          <d2p1:Id>1</d2p1:Id>
          <d2p1:PictureURL>sample string 5</d2p1:PictureURL>
          <d2p1:Username>sample string 3</d2p1:Username>
        </d2p1:FormUser>
        <d2p1:FormUser>
          <d2p1:DisplayName>sample string 4</d2p1:DisplayName>
          <d2p1:Email>sample string 2</d2p1:Email>
          <d2p1:Id>1</d2p1:Id>
          <d2p1:PictureURL>sample string 5</d2p1:PictureURL>
          <d2p1:Username>sample string 3</d2p1:Username>
        </d2p1:FormUser>
      </d2p1:CurrentApprovers>
      <d2p1:CurrentGroup>sample string 12</d2p1:CurrentGroup>
      <d2p1:Department xmlns:d4p1="http://schemas.datacontract.org/2004/07/Microsoft.SharePoint.Client.Taxonomy">
        <d4p1:Label>sample string 1</d4p1:Label>
        <d4p1:TermGuid>sample string 2</d4p1:TermGuid>
        <d4p1:WssId>3</d4p1:WssId>
      </d2p1:Department>
      <d2p1:DiscussionListGuid>1dc2cc1c-e564-4627-84a1-9550428c1edc</d2p1:DiscussionListGuid>
      <d2p1:DocLibListGuid>577896a6-0b9c-4860-8aba-6138ee600eff</d2p1:DocLibListGuid>
      <d2p1:EffectiveDate>2026-05-07T20:25:30.9607204+07:00</d2p1:EffectiveDate>
      <d2p1:FormCategory>sample string 10</d2p1:FormCategory>
      <d2p1:FormCode>sample string 4</d2p1:FormCode>
      <d2p1:FormNumber>sample string 7</d2p1:FormNumber>
      <d2p1:FormPublishedDate>2026-05-07T20:25:30.9607204+07:00</d2p1:FormPublishedDate>
      <d2p1:FormSetItemID>sample string 20</d2p1:FormSetItemID>
      <d2p1:FormTemplate>sample string 6</d2p1:FormTemplate>
      <d2p1:FormTemplateID>8</d2p1:FormTemplateID>
      <d2p1:FormTemplateSiteGuid>280f9976-77b9-441a-97a6-8e8bd556e4ec</d2p1:FormTemplateSiteGuid>
      <d2p1:FormTemplateWebGuid>57c7983f-5ff2-457b-b8e3-59ce511e2088</d2p1:FormTemplateWebGuid>
      <d2p1:FormType>sample string 5</d2p1:FormType>
      <d2p1:Group>sample string 18</d2p1:Group>
      <d2p1:HasIsoNumber>sample string 17</d2p1:HasIsoNumber>
      <d2p1:HasTemplate>sample string 16</d2p1:HasTemplate>
      <d2p1:HistoryListGuid>c728f9cb-28ed-444e-ac41-460d6bae2f56</d2p1:HistoryListGuid>
      <d2p1:Id>1</d2p1:Id>
      <d2p1:IsoNumber>sample string 15</d2p1:IsoNumber>
      <d2p1:MFItem xmlns:d4p1="http://schemas.datacontract.org/2004/07/Appvity.eOffice.Backend.Services.MFService">
        <d4p1:FormCode>sample string 9</d4p1:FormCode>
        <d4p1:FormType>sample string 11</d4p1:FormType>
        <d4p1:Id>1</d4p1:Id>
        <d4p1:ItemId>7</d4p1:ItemId>
        <d4p1:ListGuid>10b489d6-2775-4d80-87a0-5e325a130fd1</d4p1:ListGuid>
        <d4p1:Ref>sample string 3</d4p1:Ref>
        <d4p1:RefDisplayHTML>sample string 8</d4p1:RefDisplayHTML>
        <d4p1:SiteGuid>0e3ab8a8-1cb5-4133-bc10-93beda562684</d4p1:SiteGuid>
        <d4p1:Title>sample string 2</d4p1:Title>
        <d4p1:WebGuid>2223228e-7c0d-471e-b52d-8e964ab0a207</d4p1:WebGuid>
        <d4p1:WebUrl>sample string 10</d4p1:WebUrl>
      </d2p1:MFItem>
      <d2p1:PRItemDetailListGuid>9ccb7417-049b-4857-9be5-575113c205be</d2p1:PRItemDetailListGuid>
      <d2p1:Ref>sample string 3</d2p1:Ref>
      <d2p1:RefDisplayHTML>sample string 21</d2p1:RefDisplayHTML>
      <d2p1:Requester>
        <d2p1:DisplayName>sample string 4</d2p1:DisplayName>
        <d2p1:Email>sample string 2</d2p1:Email>
        <d2p1:Id>1</d2p1:Id>
        <d2p1:PictureURL>sample string 5</d2p1:PictureURL>
        <d2p1:Username>sample string 3</d2p1:Username>
      </d2p1:Requester>
      <d2p1:SubmitCounter>14</d2p1:SubmitCounter>
      <d2p1:SubmittedDate>2026-05-07T20:25:30.9607204+07:00</d2p1:SubmittedDate>
      <d2p1:Title>sample string 2</d2p1:Title>
      <d2p1:UniqueId>5ad86a50-1dea-428b-a620-647427b05b69</d2p1:UniqueId>
      <d2p1:WFName>sample string 11</d2p1:WFName>
    </d2p1:FormItem>
    <d2p1:FormType>sample string 21</d2p1:FormType>
    <d2p1:HistoryListGuid>73cc1b93-a752-4ceb-a8d0-2f926db038ea</d2p1:HistoryListGuid>
    <d2p1:IsGenerateApprovalMatrix>true</d2p1:IsGenerateApprovalMatrix>
    <d2p1:ItemId>5</d2p1:ItemId>
    <d2p1:ItemUniqueId>beee5636-38e7-4648-9f23-2d67b84d2781</d2p1:ItemUniqueId>
    <d2p1:KeyValue>sample string 22</d2p1:KeyValue>
    <d2p1:ListGuid>1f85bb58-4ccb-4c1c-ba3e-98eff4a8a070</d2p1:ListGuid>
    <d2p1:ListName>sample string 2</d2p1:ListName>
    <d2p1:RootSiteUrl>sample string 9</d2p1:RootSiteUrl>
    <d2p1:Settings>
      <d2p1:BackendApiUrl>sample string 1</d2p1:BackendApiUrl>
      <d2p1:EOfficeDataSiteUrl>sample string 2</d2p1:EOfficeDataSiteUrl>
      <d2p1:HTTMSiteURL>sample string 3</d2p1:HTTMSiteURL>
    </d2p1:Settings>
    <d2p1:SiteGuid>2768b127-4133-4598-a154-153613e671df</d2p1:SiteGuid>
    <d2p1:SyncPermission>true</d2p1:SyncPermission>
    <d2p1:WFName>sample string 18</d2p1:WFName>
    <d2p1:WebGuid>06b6867d-aca6-431d-b34b-835af86506a0</d2p1:WebGuid>
    <d2p1:WebRelativeUrl>sample string 8</d2p1:WebRelativeUrl>
    <d2p1:WebUrl>sample string 10</d2p1:WebUrl>
    <d2p1:itemId>sample string 6</d2p1:itemId>
  </FormContext>
  <IPUrl>sample string 1</IPUrl>
  <WebUrl>sample string 2</WebUrl>
</DeclareIP>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'DeclareIP'.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.