< Back to main page

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

Gets all forms related to the given 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.
language Translation of forms 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

Forms associated with the given message.

Response body formats

application/hal+xml

Sample:

Sample not available.

application/hal+json

Sample: 
{
  "_links": {
    "self": {
      "href": "sample string 51"
    }
  },
  "_embedded": {
    "sample string 54": [
      {
        "FormId": 1,
        "Type": "sample string 99",
        "FormData": "sample string 79",
        "DataFormatId": "sample string 13",
        "DataFormatVersion": 5,
        "ValidationStatus": "sample string 94",
        "Name": "sample string 59",
        "SigningLocked": true,
        "SignedByDefault": true,
        "_links": {
          "self": {
            "href": "sample string 2"
          }
        }
      },
      {
        "FormId": 1,
        "Type": "sample string 99",
        "FormData": "sample string 79",
        "DataFormatId": "sample string 13",
        "DataFormatVersion": 5,
        "ValidationStatus": "sample string 94",
        "Name": "sample string 59",
        "SigningLocked": true,
        "SignedByDefault": true,
        "_links": {
          "self": {
            "href": "sample string 2"
          }
        }
      },
      {
        "FormId": 1,
        "Type": "sample string 99",
        "FormData": "sample string 79",
        "DataFormatId": "sample string 13",
        "DataFormatVersion": 5,
        "ValidationStatus": "sample string 94",
        "Name": "sample string 59",
        "SigningLocked": true,
        "SignedByDefault": true,
        "_links": {
          "self": {
            "href": "sample string 2"
          }
        }
      }
    ]
  }
}