POST {who}/messages/{messageId}/forms

Add a new form to an existing message.

Request Information

Parameters

NameDescriptionAdditional information
who The id of the reportee for which the message belongs. Valid values are "my", or an organization number of an organization the user can represent, or "r"<Reportee.ReporteeId>, where the identified reportee may be a person or organization.

Define this parameter in the request URI.

messageId Id of the message for which forms should be retrieved.

Define this parameter in the request URI.

form All details of the form element to be created.

Define this parameter in the request body.

Request body formats

application/hal+xml

Sample:
<resource rel="form">
    <DataFormatId>string example 34</DataFormatId>
    <DataFormatVersion>string example 38</DataFormatVersion>
    <FormData><![CDATA[<Skjema xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" ...>...</Skjema>]]></FormData>
</resource>
                    

application/hal+json

Sample:
{
    "Type": "SubForm",
    "DataFormatId": "string example 36",
    "DataFormatVersion": "string example 38",
    "FormData": "<Skjema xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\"...>...</Skjema>"
}
                     

Response body formats

application/hal+xml

No sample

application/hal+json

Sample:
{
    "Secret": "h43ofah43fuha43hfjlrkeahfa98743gh",
    "UserName": "enterpriseuser123",
    "Created": "2021-07-06T11:06:30.9786158+02:00",
    "OwnerOrgNo": "910494392"
}