GET api/v1/companies/{companyUid}/staffcategories
Gets the staff categories by company.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| companyUid |
The company UID. |
globally unique identifier |
Required |
Body Parameters
None.
Response Information
Resource Description
Returns the staff categories by company.
Collection of StaffCategoryViewModel| Name | Description | Type | Additional information |
|---|---|---|---|
| Portal |
The portal. |
PortalViewModel |
None. |
| Company |
The company. |
CompanyViewModel |
None. |
| Name |
The name. |
string |
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:
[
{
"Portal": {
"Name": "sample string 1",
"Uid": "9b3224d8-2724-4a58-ad60-de69156d1bb0",
"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:59:56.5419883+00:00",
"UpdatedBy": "sample string 3"
},
"Company": {
"Name": "sample string 1",
"AddressLine1": "sample string 2",
"AddressLine2": "sample string 3",
"AddressLine3": "sample string 4",
"AddressLine4": "sample string 5",
"PostCode": "sample string 6",
"Country": {
"Iso3Code": "sample string 1",
"Name": "sample string 2",
"Portal": {
"Name": "sample string 1",
"Uid": "9b3224d8-2724-4a58-ad60-de69156d1bb0",
"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:59:56.5419883+00:00",
"UpdatedBy": "sample string 3"
},
"CountryGuid": "229ba217-6b92-4e75-a530-e49f4497e314",
"Uid": "b2c2ad9c-2f9b-49e3-a55b-4c6681a0f7d2",
"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:59:56.5419883+00:00",
"UpdatedBy": "sample string 5"
},
"Latitude": "sample string 7",
"Longitude": "sample string 8",
"PortalUid": "0140e248-2e84-4918-9078-fb2156959c62",
"PortalGuid": "ef07432e-d167-4abc-8f98-f226ac10c4bd",
"CompanyGuid": "ef7110f6-0dbc-444c-a9cf-b8b2d4aff9e3",
"Uid": "4d4c2558-5ec6-4652-b356-38999e624a8f",
"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:59:56.5419883+00:00",
"UpdatedBy": "sample string 13"
},
"Name": "sample string 1",
"Uid": "8483c466-da0c-412a-ac65-1619bdbe203d",
"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:59:56.5419883+00:00",
"UpdatedBy": "sample string 3"
},
{
"Portal": {
"Name": "sample string 1",
"Uid": "9b3224d8-2724-4a58-ad60-de69156d1bb0",
"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:59:56.5419883+00:00",
"UpdatedBy": "sample string 3"
},
"Company": {
"Name": "sample string 1",
"AddressLine1": "sample string 2",
"AddressLine2": "sample string 3",
"AddressLine3": "sample string 4",
"AddressLine4": "sample string 5",
"PostCode": "sample string 6",
"Country": {
"Iso3Code": "sample string 1",
"Name": "sample string 2",
"Portal": {
"Name": "sample string 1",
"Uid": "9b3224d8-2724-4a58-ad60-de69156d1bb0",
"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:59:56.5419883+00:00",
"UpdatedBy": "sample string 3"
},
"CountryGuid": "229ba217-6b92-4e75-a530-e49f4497e314",
"Uid": "b2c2ad9c-2f9b-49e3-a55b-4c6681a0f7d2",
"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:59:56.5419883+00:00",
"UpdatedBy": "sample string 5"
},
"Latitude": "sample string 7",
"Longitude": "sample string 8",
"PortalUid": "0140e248-2e84-4918-9078-fb2156959c62",
"PortalGuid": "ef07432e-d167-4abc-8f98-f226ac10c4bd",
"CompanyGuid": "ef7110f6-0dbc-444c-a9cf-b8b2d4aff9e3",
"Uid": "4d4c2558-5ec6-4652-b356-38999e624a8f",
"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:59:56.5419883+00:00",
"UpdatedBy": "sample string 13"
},
"Name": "sample string 1",
"Uid": "8483c466-da0c-412a-ac65-1619bdbe203d",
"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:59:56.5419883+00:00",
"UpdatedBy": "sample string 3"
}
]
application/xml, text/xml
Sample:
<ArrayOfStaffCategoryViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eclipse.WebApi.Common.ViewModels">
<StaffCategoryViewModel>
<DateUpdated>2025-12-21T17:59:56.5419883+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>8483c466-da0c-412a-ac65-1619bdbe203d</Uid>
<UpdatedBy>sample string 3</UpdatedBy>
<Company>
<DateUpdated>2025-12-21T17:59:56.5419883+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>4d4c2558-5ec6-4652-b356-38999e624a8f</Uid>
<UpdatedBy>sample string 13</UpdatedBy>
<AddressLine1>sample string 2</AddressLine1>
<AddressLine2>sample string 3</AddressLine2>
<AddressLine3>sample string 4</AddressLine3>
<AddressLine4>sample string 5</AddressLine4>
<CompanyGuid>ef7110f6-0dbc-444c-a9cf-b8b2d4aff9e3</CompanyGuid>
<Country>
<DateUpdated>2025-12-21T17:59:56.5419883+00:00</DateUpdated>
<Links xmlns:d5p1="http://schemas.datacontract.org/2004/07/Eclipse.WebApi.Common.Models">
<d5p1:Link>
<d5p1:Href>http://webapihelppage1.com/</d5p1:Href>
<d5p1:Method>sample string 2</d5p1:Method>
<d5p1:Rel>sample string 3</d5p1:Rel>
<d5p1:Title>sample string 4</d5p1:Title>
<d5p1:Type>sample string 5</d5p1:Type>
</d5p1:Link>
<d5p1:Link>
<d5p1:Href>http://webapihelppage1.com/</d5p1:Href>
<d5p1:Method>sample string 2</d5p1:Method>
<d5p1:Rel>sample string 3</d5p1:Rel>
<d5p1:Title>sample string 4</d5p1:Title>
<d5p1:Type>sample string 5</d5p1:Type>
</d5p1:Link>
</Links>
<Uid>b2c2ad9c-2f9b-49e3-a55b-4c6681a0f7d2</Uid>
<UpdatedBy>sample string 5</UpdatedBy>
<CountryGuid>229ba217-6b92-4e75-a530-e49f4497e314</CountryGuid>
<Iso3Code>sample string 1</Iso3Code>
<Name>sample string 2</Name>
<Portal>
<DateUpdated>2025-12-21T17:59:56.5419883+00:00</DateUpdated>
<Links xmlns:d6p1="http://schemas.datacontract.org/2004/07/Eclipse.WebApi.Common.Models">
<d6p1:Link>
<d6p1:Href>http://webapihelppage1.com/</d6p1:Href>
<d6p1:Method>sample string 2</d6p1:Method>
<d6p1:Rel>sample string 3</d6p1:Rel>
<d6p1:Title>sample string 4</d6p1:Title>
<d6p1:Type>sample string 5</d6p1:Type>
</d6p1:Link>
<d6p1:Link>
<d6p1:Href>http://webapihelppage1.com/</d6p1:Href>
<d6p1:Method>sample string 2</d6p1:Method>
<d6p1:Rel>sample string 3</d6p1:Rel>
<d6p1:Title>sample string 4</d6p1:Title>
<d6p1:Type>sample string 5</d6p1:Type>
</d6p1:Link>
</Links>
<Uid>9b3224d8-2724-4a58-ad60-de69156d1bb0</Uid>
<UpdatedBy>sample string 3</UpdatedBy>
<Name>sample string 1</Name>
</Portal>
</Country>
<Latitude>sample string 7</Latitude>
<Longitude>sample string 8</Longitude>
<Name>sample string 1</Name>
<PortalGuid>ef07432e-d167-4abc-8f98-f226ac10c4bd</PortalGuid>
<PortalUid>0140e248-2e84-4918-9078-fb2156959c62</PortalUid>
<PostCode>sample string 6</PostCode>
</Company>
<Name>sample string 1</Name>
<Portal>
<DateUpdated>2025-12-21T17:59:56.5419883+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>9b3224d8-2724-4a58-ad60-de69156d1bb0</Uid>
<UpdatedBy>sample string 3</UpdatedBy>
<Name>sample string 1</Name>
</Portal>
</StaffCategoryViewModel>
<StaffCategoryViewModel>
<DateUpdated>2025-12-21T17:59:56.5419883+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>8483c466-da0c-412a-ac65-1619bdbe203d</Uid>
<UpdatedBy>sample string 3</UpdatedBy>
<Company>
<DateUpdated>2025-12-21T17:59:56.5419883+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>4d4c2558-5ec6-4652-b356-38999e624a8f</Uid>
<UpdatedBy>sample string 13</UpdatedBy>
<AddressLine1>sample string 2</AddressLine1>
<AddressLine2>sample string 3</AddressLine2>
<AddressLine3>sample string 4</AddressLine3>
<AddressLine4>sample string 5</AddressLine4>
<CompanyGuid>ef7110f6-0dbc-444c-a9cf-b8b2d4aff9e3</CompanyGuid>
<Country>
<DateUpdated>2025-12-21T17:59:56.5419883+00:00</DateUpdated>
<Links xmlns:d5p1="http://schemas.datacontract.org/2004/07/Eclipse.WebApi.Common.Models">
<d5p1:Link>
<d5p1:Href>http://webapihelppage1.com/</d5p1:Href>
<d5p1:Method>sample string 2</d5p1:Method>
<d5p1:Rel>sample string 3</d5p1:Rel>
<d5p1:Title>sample string 4</d5p1:Title>
<d5p1:Type>sample string 5</d5p1:Type>
</d5p1:Link>
<d5p1:Link>
<d5p1:Href>http://webapihelppage1.com/</d5p1:Href>
<d5p1:Method>sample string 2</d5p1:Method>
<d5p1:Rel>sample string 3</d5p1:Rel>
<d5p1:Title>sample string 4</d5p1:Title>
<d5p1:Type>sample string 5</d5p1:Type>
</d5p1:Link>
</Links>
<Uid>b2c2ad9c-2f9b-49e3-a55b-4c6681a0f7d2</Uid>
<UpdatedBy>sample string 5</UpdatedBy>
<CountryGuid>229ba217-6b92-4e75-a530-e49f4497e314</CountryGuid>
<Iso3Code>sample string 1</Iso3Code>
<Name>sample string 2</Name>
<Portal>
<DateUpdated>2025-12-21T17:59:56.5419883+00:00</DateUpdated>
<Links xmlns:d6p1="http://schemas.datacontract.org/2004/07/Eclipse.WebApi.Common.Models">
<d6p1:Link>
<d6p1:Href>http://webapihelppage1.com/</d6p1:Href>
<d6p1:Method>sample string 2</d6p1:Method>
<d6p1:Rel>sample string 3</d6p1:Rel>
<d6p1:Title>sample string 4</d6p1:Title>
<d6p1:Type>sample string 5</d6p1:Type>
</d6p1:Link>
<d6p1:Link>
<d6p1:Href>http://webapihelppage1.com/</d6p1:Href>
<d6p1:Method>sample string 2</d6p1:Method>
<d6p1:Rel>sample string 3</d6p1:Rel>
<d6p1:Title>sample string 4</d6p1:Title>
<d6p1:Type>sample string 5</d6p1:Type>
</d6p1:Link>
</Links>
<Uid>9b3224d8-2724-4a58-ad60-de69156d1bb0</Uid>
<UpdatedBy>sample string 3</UpdatedBy>
<Name>sample string 1</Name>
</Portal>
</Country>
<Latitude>sample string 7</Latitude>
<Longitude>sample string 8</Longitude>
<Name>sample string 1</Name>
<PortalGuid>ef07432e-d167-4abc-8f98-f226ac10c4bd</PortalGuid>
<PortalUid>0140e248-2e84-4918-9078-fb2156959c62</PortalUid>
<PostCode>sample string 6</PostCode>
</Company>
<Name>sample string 1</Name>
<Portal>
<DateUpdated>2025-12-21T17:59:56.5419883+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>9b3224d8-2724-4a58-ad60-de69156d1bb0</Uid>
<UpdatedBy>sample string 3</UpdatedBy>
<Name>sample string 1</Name>
</Portal>
</StaffCategoryViewModel>
</ArrayOfStaffCategoryViewModel>