POST api/v1/portals/{portalUid}/staffcategories
Creates the staff category.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| portalUid |
The portal UID. |
globally unique identifier |
Required |
Body Parameters
The staff category.
StaffCategory| Name | Description | Type | Additional information |
|---|---|---|---|
| Name |
The staff category name. |
string |
Required String length: inclusive between 0 and 100 |
Request Formats
application/json, text/json
Sample:
{
"Name": "sample string 1"
}
application/xml, text/xml
Sample:
<StaffCategory xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eclipse.WebApi.Common.Models"> <Name>sample string 1</Name> </StaffCategory>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
Returns the created staff category.
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": "8a81983b-3036-4955-a03f-39490254c17e",
"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-10-27T14:00:15.6338438+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": "8a81983b-3036-4955-a03f-39490254c17e",
"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-10-27T14:00:15.6338438+00:00",
"UpdatedBy": "sample string 3"
},
"CountryGuid": "0138359c-bd04-47bf-baa2-46c055bb5314",
"Uid": "9013702e-335c-4774-8e15-9bd7ff237f9d",
"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-10-27T14:00:15.6338438+00:00",
"UpdatedBy": "sample string 5"
},
"Latitude": "sample string 7",
"Longitude": "sample string 8",
"PortalUid": "c283f653-64cc-4842-8e5a-b03f10d95665",
"PortalGuid": "a37cf4aa-a1db-45e3-8abb-474f2adf1159",
"CompanyGuid": "ebba2914-62ac-4010-9061-7ecedc6cd61a",
"Uid": "4bbf28e2-cc47-48ec-85e6-db6b4ec509b0",
"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-10-27T14:00:15.6338438+00:00",
"UpdatedBy": "sample string 13"
},
"Name": "sample string 1",
"Uid": "bae308dd-8677-461d-b4b0-73a5f361b081",
"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-10-27T14:00:15.6338438+00:00",
"UpdatedBy": "sample string 3"
}
application/xml, text/xml
Sample:
<StaffCategoryViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eclipse.WebApi.Common.ViewModels">
<DateUpdated>2025-10-27T14:00:15.6338438+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>bae308dd-8677-461d-b4b0-73a5f361b081</Uid>
<UpdatedBy>sample string 3</UpdatedBy>
<Company>
<DateUpdated>2025-10-27T14:00:15.6338438+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>4bbf28e2-cc47-48ec-85e6-db6b4ec509b0</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>ebba2914-62ac-4010-9061-7ecedc6cd61a</CompanyGuid>
<Country>
<DateUpdated>2025-10-27T14:00:15.6338438+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>9013702e-335c-4774-8e15-9bd7ff237f9d</Uid>
<UpdatedBy>sample string 5</UpdatedBy>
<CountryGuid>0138359c-bd04-47bf-baa2-46c055bb5314</CountryGuid>
<Iso3Code>sample string 1</Iso3Code>
<Name>sample string 2</Name>
<Portal>
<DateUpdated>2025-10-27T14:00:15.6338438+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>8a81983b-3036-4955-a03f-39490254c17e</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>a37cf4aa-a1db-45e3-8abb-474f2adf1159</PortalGuid>
<PortalUid>c283f653-64cc-4842-8e5a-b03f10d95665</PortalUid>
<PostCode>sample string 6</PostCode>
</Company>
<Name>sample string 1</Name>
<Portal>
<DateUpdated>2025-10-27T14:00:15.6338438+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>8a81983b-3036-4955-a03f-39490254c17e</Uid>
<UpdatedBy>sample string 3</UpdatedBy>
<Name>sample string 1</Name>
</Portal>
</StaffCategoryViewModel>