< Back to main page

GET {who}/messages/{messageId}/forms/{formId}?language={language}

Gets the specific form based on the given combination of message and form id.

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.
formId Id of the form to be retrieved.

Define this parameter in the request URI.
language Translation of the form retrieved, valid values are: 1033 (EN), 1044 (NB) and 2068 (NN) This is an optional parameter, defaults to the user preset language

Define this parameter in the request URI.

Response Information

The form that is identified with the message and form id values if it exists.

Response body formats

application/hal+xml

Sample:

Sample not available.

application/hal+json

Sample: 
{
  "FormId": 1,
  "Type": "sample string 70",
  "FormData": "sample string 87",
  "DataFormatId": "sample string 49",
  "DataFormatVersion": 5,
  "ValidationStatus": "sample string 90",
  "Name": "sample string 36",
  "SigningLocked": true,
  "SignedByDefault": true,
  "_links": {
    "self": {
      "href": "sample string 4"
    }
  }
}