GET api/v1/portals/{portalUid}/customer/registeredbodies/statuses

Gets the customers registered body statuses.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
portalUid

The portal UID.

globally unique identifier

Required

Body Parameters

None.

Response Information

Resource Description

Returns registered body statuses for the customer portal.

Collection of RegisteredBodyStatusViewModel
NameDescriptionTypeAdditional information
Name

The registered body status name.

string

None.

Portal

The portal.

PortalViewModel

None.

RegisteredBodyStatusGuid

The unique identifier for the registered body status

globally unique identifier

None.

Uid

The GUID.

globally unique identifier

None.

Links

The links.

Collection of Link

None.

DateUpdated

Last time the record was updated

date

None.

UpdatedBy

Who updated the record last

string

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "Name": "sample string 1",
    "Portal": {
      "Name": "sample string 1",
      "Uid": "ad61e31e-4269-4d0b-b6a8-ee18e7502d05",
      "Links": [
        {
          "Href": "http://webapihelppage1.com",
          "Method": "sample string 2",
          "Rel": "sample string 3",
          "Title": "sample string 4",
          "Type": "sample string 5"
        },
        {
          "Href": "http://webapihelppage1.com",
          "Method": "sample string 2",
          "Rel": "sample string 3",
          "Title": "sample string 4",
          "Type": "sample string 5"
        }
      ],
      "DateUpdated": "2025-12-21T17:49:20.8275009+00:00",
      "UpdatedBy": "sample string 3"
    },
    "RegisteredBodyStatusGuid": "75cf7e2f-085b-4299-aef2-c296527eaa98",
    "Uid": "8935da2f-e35c-473c-be03-9c888b473b9e",
    "Links": [
      {
        "Href": "http://webapihelppage1.com",
        "Method": "sample string 2",
        "Rel": "sample string 3",
        "Title": "sample string 4",
        "Type": "sample string 5"
      },
      {
        "Href": "http://webapihelppage1.com",
        "Method": "sample string 2",
        "Rel": "sample string 3",
        "Title": "sample string 4",
        "Type": "sample string 5"
      }
    ],
    "DateUpdated": "2025-12-21T17:49:20.8275009+00:00",
    "UpdatedBy": "sample string 4"
  },
  {
    "Name": "sample string 1",
    "Portal": {
      "Name": "sample string 1",
      "Uid": "ad61e31e-4269-4d0b-b6a8-ee18e7502d05",
      "Links": [
        {
          "Href": "http://webapihelppage1.com",
          "Method": "sample string 2",
          "Rel": "sample string 3",
          "Title": "sample string 4",
          "Type": "sample string 5"
        },
        {
          "Href": "http://webapihelppage1.com",
          "Method": "sample string 2",
          "Rel": "sample string 3",
          "Title": "sample string 4",
          "Type": "sample string 5"
        }
      ],
      "DateUpdated": "2025-12-21T17:49:20.8275009+00:00",
      "UpdatedBy": "sample string 3"
    },
    "RegisteredBodyStatusGuid": "75cf7e2f-085b-4299-aef2-c296527eaa98",
    "Uid": "8935da2f-e35c-473c-be03-9c888b473b9e",
    "Links": [
      {
        "Href": "http://webapihelppage1.com",
        "Method": "sample string 2",
        "Rel": "sample string 3",
        "Title": "sample string 4",
        "Type": "sample string 5"
      },
      {
        "Href": "http://webapihelppage1.com",
        "Method": "sample string 2",
        "Rel": "sample string 3",
        "Title": "sample string 4",
        "Type": "sample string 5"
      }
    ],
    "DateUpdated": "2025-12-21T17:49:20.8275009+00:00",
    "UpdatedBy": "sample string 4"
  }
]

application/xml, text/xml

Sample:
<ArrayOfRegisteredBodyStatusViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eclipse.WebApi.Common.ViewModels">
  <RegisteredBodyStatusViewModel>
    <DateUpdated>2025-12-21T17:49:20.8275009+00:00</DateUpdated>
    <Links xmlns:d3p1="http://schemas.datacontract.org/2004/07/Eclipse.WebApi.Common.Models">
      <d3p1:Link>
        <d3p1:Href>http://webapihelppage1.com/</d3p1:Href>
        <d3p1:Method>sample string 2</d3p1:Method>
        <d3p1:Rel>sample string 3</d3p1:Rel>
        <d3p1:Title>sample string 4</d3p1:Title>
        <d3p1:Type>sample string 5</d3p1:Type>
      </d3p1:Link>
      <d3p1:Link>
        <d3p1:Href>http://webapihelppage1.com/</d3p1:Href>
        <d3p1:Method>sample string 2</d3p1:Method>
        <d3p1:Rel>sample string 3</d3p1:Rel>
        <d3p1:Title>sample string 4</d3p1:Title>
        <d3p1:Type>sample string 5</d3p1:Type>
      </d3p1:Link>
    </Links>
    <Uid>8935da2f-e35c-473c-be03-9c888b473b9e</Uid>
    <UpdatedBy>sample string 4</UpdatedBy>
    <Name>sample string 1</Name>
    <Portal>
      <DateUpdated>2025-12-21T17:49:20.8275009+00:00</DateUpdated>
      <Links xmlns:d4p1="http://schemas.datacontract.org/2004/07/Eclipse.WebApi.Common.Models">
        <d4p1:Link>
          <d4p1:Href>http://webapihelppage1.com/</d4p1:Href>
          <d4p1:Method>sample string 2</d4p1:Method>
          <d4p1:Rel>sample string 3</d4p1:Rel>
          <d4p1:Title>sample string 4</d4p1:Title>
          <d4p1:Type>sample string 5</d4p1:Type>
        </d4p1:Link>
        <d4p1:Link>
          <d4p1:Href>http://webapihelppage1.com/</d4p1:Href>
          <d4p1:Method>sample string 2</d4p1:Method>
          <d4p1:Rel>sample string 3</d4p1:Rel>
          <d4p1:Title>sample string 4</d4p1:Title>
          <d4p1:Type>sample string 5</d4p1:Type>
        </d4p1:Link>
      </Links>
      <Uid>ad61e31e-4269-4d0b-b6a8-ee18e7502d05</Uid>
      <UpdatedBy>sample string 3</UpdatedBy>
      <Name>sample string 1</Name>
    </Portal>
    <RegisteredBodyStatusGuid>75cf7e2f-085b-4299-aef2-c296527eaa98</RegisteredBodyStatusGuid>
  </RegisteredBodyStatusViewModel>
  <RegisteredBodyStatusViewModel>
    <DateUpdated>2025-12-21T17:49:20.8275009+00:00</DateUpdated>
    <Links xmlns:d3p1="http://schemas.datacontract.org/2004/07/Eclipse.WebApi.Common.Models">
      <d3p1:Link>
        <d3p1:Href>http://webapihelppage1.com/</d3p1:Href>
        <d3p1:Method>sample string 2</d3p1:Method>
        <d3p1:Rel>sample string 3</d3p1:Rel>
        <d3p1:Title>sample string 4</d3p1:Title>
        <d3p1:Type>sample string 5</d3p1:Type>
      </d3p1:Link>
      <d3p1:Link>
        <d3p1:Href>http://webapihelppage1.com/</d3p1:Href>
        <d3p1:Method>sample string 2</d3p1:Method>
        <d3p1:Rel>sample string 3</d3p1:Rel>
        <d3p1:Title>sample string 4</d3p1:Title>
        <d3p1:Type>sample string 5</d3p1:Type>
      </d3p1:Link>
    </Links>
    <Uid>8935da2f-e35c-473c-be03-9c888b473b9e</Uid>
    <UpdatedBy>sample string 4</UpdatedBy>
    <Name>sample string 1</Name>
    <Portal>
      <DateUpdated>2025-12-21T17:49:20.8275009+00:00</DateUpdated>
      <Links xmlns:d4p1="http://schemas.datacontract.org/2004/07/Eclipse.WebApi.Common.Models">
        <d4p1:Link>
          <d4p1:Href>http://webapihelppage1.com/</d4p1:Href>
          <d4p1:Method>sample string 2</d4p1:Method>
          <d4p1:Rel>sample string 3</d4p1:Rel>
          <d4p1:Title>sample string 4</d4p1:Title>
          <d4p1:Type>sample string 5</d4p1:Type>
        </d4p1:Link>
        <d4p1:Link>
          <d4p1:Href>http://webapihelppage1.com/</d4p1:Href>
          <d4p1:Method>sample string 2</d4p1:Method>
          <d4p1:Rel>sample string 3</d4p1:Rel>
          <d4p1:Title>sample string 4</d4p1:Title>
          <d4p1:Type>sample string 5</d4p1:Type>
        </d4p1:Link>
      </Links>
      <Uid>ad61e31e-4269-4d0b-b6a8-ee18e7502d05</Uid>
      <UpdatedBy>sample string 3</UpdatedBy>
      <Name>sample string 1</Name>
    </Portal>
    <RegisteredBodyStatusGuid>75cf7e2f-085b-4299-aef2-c296527eaa98</RegisteredBodyStatusGuid>
  </RegisteredBodyStatusViewModel>
</ArrayOfRegisteredBodyStatusViewModel>