GET api/v1/portals/{portalUid}/customer/registeredbodies/statuses/{registeredBodyStatusGuid}
Gets the registered body status by GUID.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| portalUid |
the customer portal |
globally unique identifier |
Required |
| registeredBodyStatusGuid |
The registered body status GUID. |
globally unique identifier |
Required |
Body Parameters
None.
Response Information
Resource Description
Returns the specified registered body status.
RegisteredBodyStatusViewModel| Name | Description | Type | Additional 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": "bd603454-f63a-436e-afc5-a6fb63354dd6",
"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.3743737+00:00",
"UpdatedBy": "sample string 3"
},
"RegisteredBodyStatusGuid": "03b68bdd-4ebd-45e8-b11c-422ac47b4f4d",
"Uid": "79d0350a-7efa-4249-bc87-eee5cd0cc911",
"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.3743737+00:00",
"UpdatedBy": "sample string 4"
}
application/xml, text/xml
Sample:
<RegisteredBodyStatusViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eclipse.WebApi.Common.ViewModels">
<DateUpdated>2025-12-21T17:49:20.3743737+00:00</DateUpdated>
<Links xmlns:d2p1="http://schemas.datacontract.org/2004/07/Eclipse.WebApi.Common.Models">
<d2p1:Link>
<d2p1:Href>http://webapihelppage1.com/</d2p1:Href>
<d2p1:Method>sample string 2</d2p1:Method>
<d2p1:Rel>sample string 3</d2p1:Rel>
<d2p1:Title>sample string 4</d2p1:Title>
<d2p1:Type>sample string 5</d2p1:Type>
</d2p1:Link>
<d2p1:Link>
<d2p1:Href>http://webapihelppage1.com/</d2p1:Href>
<d2p1:Method>sample string 2</d2p1:Method>
<d2p1:Rel>sample string 3</d2p1:Rel>
<d2p1:Title>sample string 4</d2p1:Title>
<d2p1:Type>sample string 5</d2p1:Type>
</d2p1:Link>
</Links>
<Uid>79d0350a-7efa-4249-bc87-eee5cd0cc911</Uid>
<UpdatedBy>sample string 4</UpdatedBy>
<Name>sample string 1</Name>
<Portal>
<DateUpdated>2025-12-21T17:49:20.3743737+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>bd603454-f63a-436e-afc5-a6fb63354dd6</Uid>
<UpdatedBy>sample string 3</UpdatedBy>
<Name>sample string 1</Name>
</Portal>
<RegisteredBodyStatusGuid>03b68bdd-4ebd-45e8-b11c-422ac47b4f4d</RegisteredBodyStatusGuid>
</RegisteredBodyStatusViewModel>