GET serviceowner/consents?serviceCode={serviceCode}&serviceEditionCode={serviceEditionCode}&status[0]={status[0]}&status[1]={status[1]}&continuation={continuation}

Get a list of all consents offered by reportees for the specified service.

Request Information

Parameters

Name	Description	Additional information
queryOptions	OData Query details. This object is created by the Framework based on parameters in the url.	None.
serviceCode	(Required) The external service code for the service	Define this parameter in the request URI.
serviceEditionCode	(Required) The external service edition code for the service	Define this parameter in the request URI.
status	Array of consent status to included in the list. Possible statuses are 'Active' and 'Revoked'. By default both statuses are included in the returned list.	Define this parameter in the request URI.
continuation	Continuation token to continue this query from a previous response. Each response that returns a non-empty list of consents will also contain a valid continuation token, based on the last consent in the list. The format is {timestamp}_{id}, where the timestamp format is yyyy'-'MM'-'dd'T'HH':'mm':'ss.fff. Example of continuation token: 2020-01-01T08:30:00.010_23	Define this parameter in the request URI.

Response Information

Returns a list of consents for the specified service.

Response body formats

application/hal+xml

Sample:

Sample not available.

application/hal+json

Sample:

{
  "_links": {
    "self": {
      "href": "sample string 79"
    }
  },
  "_embedded": {
    "sample string 75": [
      {
        "ConsentId": 1,
        "AuthorizationCode": "sample string 81",
        "Status": "sample string 40",
        "OfferedBy": {
          "ReporteeId": "sample string 90",
          "Name": "sample string 82",
          "Type": "sample string 93",
          "SocialSecurityNumber": "sample string 38",
          "OrganizationNumber": "sample string 79",
          "ParentOrganizationNumber": "sample string 65",
          "OrganizationForm": "sample string 19",
          "Status": "sample string 93"
        },
        "CoveredBy": {
          "ReporteeId": "sample string 90",
          "Name": "sample string 82",
          "Type": "sample string 93",
          "SocialSecurityNumber": "sample string 38",
          "OrganizationNumber": "sample string 79",
          "ParentOrganizationNumber": "sample string 65",
          "OrganizationForm": "sample string 19",
          "Status": "sample string 93"
        },
        "HandledBy": {
          "ReporteeId": "sample string 90",
          "Name": "sample string 82",
          "Type": "sample string 93",
          "SocialSecurityNumber": "sample string 38",
          "OrganizationNumber": "sample string 79",
          "ParentOrganizationNumber": "sample string 65",
          "OrganizationForm": "sample string 19",
          "Status": "sample string 93"
        },
        "Created": "2023-03-27T16:03:35.8690847+02:00",
        "ValidTo": "2023-03-27T16:03:35.8690847+02:00",
        "LastChanged": "2023-03-27T16:03:35.8690847+02:00",
        "_links": {
          "self": {
            "href": "sample string 25"
          }
        }
      },
      {
        "ConsentId": 1,
        "AuthorizationCode": "sample string 81",
        "Status": "sample string 40",
        "OfferedBy": {
          "ReporteeId": "sample string 90",
          "Name": "sample string 82",
          "Type": "sample string 93",
          "SocialSecurityNumber": "sample string 38",
          "OrganizationNumber": "sample string 79",
          "ParentOrganizationNumber": "sample string 65",
          "OrganizationForm": "sample string 19",
          "Status": "sample string 93"
        },
        "CoveredBy": {
          "ReporteeId": "sample string 90",
          "Name": "sample string 82",
          "Type": "sample string 93",
          "SocialSecurityNumber": "sample string 38",
          "OrganizationNumber": "sample string 79",
          "ParentOrganizationNumber": "sample string 65",
          "OrganizationForm": "sample string 19",
          "Status": "sample string 93"
        },
        "HandledBy": {
          "ReporteeId": "sample string 90",
          "Name": "sample string 82",
          "Type": "sample string 93",
          "SocialSecurityNumber": "sample string 38",
          "OrganizationNumber": "sample string 79",
          "ParentOrganizationNumber": "sample string 65",
          "OrganizationForm": "sample string 19",
          "Status": "sample string 93"
        },
        "Created": "2023-03-27T16:03:35.8690847+02:00",
        "ValidTo": "2023-03-27T16:03:35.8690847+02:00",
        "LastChanged": "2023-03-27T16:03:35.8690847+02:00",
        "_links": {
          "self": {
            "href": "sample string 25"
          }
        }
      },
      {
        "ConsentId": 1,
        "AuthorizationCode": "sample string 81",
        "Status": "sample string 40",
        "OfferedBy": {
          "ReporteeId": "sample string 90",
          "Name": "sample string 82",
          "Type": "sample string 93",
          "SocialSecurityNumber": "sample string 38",
          "OrganizationNumber": "sample string 79",
          "ParentOrganizationNumber": "sample string 65",
          "OrganizationForm": "sample string 19",
          "Status": "sample string 93"
        },
        "CoveredBy": {
          "ReporteeId": "sample string 90",
          "Name": "sample string 82",
          "Type": "sample string 93",
          "SocialSecurityNumber": "sample string 38",
          "OrganizationNumber": "sample string 79",
          "ParentOrganizationNumber": "sample string 65",
          "OrganizationForm": "sample string 19",
          "Status": "sample string 93"
        },
        "HandledBy": {
          "ReporteeId": "sample string 90",
          "Name": "sample string 82",
          "Type": "sample string 93",
          "SocialSecurityNumber": "sample string 38",
          "OrganizationNumber": "sample string 79",
          "ParentOrganizationNumber": "sample string 65",
          "OrganizationForm": "sample string 19",
          "Status": "sample string 93"
        },
        "Created": "2023-03-27T16:03:35.8690847+02:00",
        "ValidTo": "2023-03-27T16:03:35.8690847+02:00",
        "LastChanged": "2023-03-27T16:03:35.8690847+02:00",
        "_links": {
          "self": {
            "href": "sample string 25"
          }
        }
      }
    ]
  },
  "continuationtoken": "sample string 87"
}