GET api/sitetypes/{siteTypeName}
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| siteTypeName | string |
Required |
Body Parameters
None.
Response Information
Resource Description
SiteTypeViewModel| Name | Description | Type | Additional information |
|---|---|---|---|
| Name | string |
Required Invalid Chars: .!@#$%^&*\|`~=+/?<>()[]," Max length: 50 |
|
| Description | string |
None. |
|
| IsDefault | boolean |
None. |
|
| DefaultTemplateId | integer |
None. |
|
| DefaultMeasTypeId | integer |
None. |
|
| UserField1Label | string |
Max length: 255 |
|
| UserField2Label | string |
Max length: 255 |
|
| UserField3Label | string |
Max length: 255 |
|
| UserField4Label | string |
Max length: 255 |
|
| UserField5Label | string |
Max length: 255 |
|
| IsCore | boolean |
None. |
|
| Links |
Gets the links. |
Collection of LinkModel |
None. |
Response Formats
application/json, text/json
Sample:
{
"name": "sample string 1",
"description": "sample string 2",
"isDefault": true,
"defaultTemplateId": 1,
"defaultMeasTypeId": 1,
"userField1Label": "sample string 4",
"userField2Label": "sample string 5",
"userField3Label": "sample string 6",
"userField4Label": "sample string 7",
"userField5Label": "sample string 8",
"isCore": true
}
application/xml, text/xml
Sample:
<SiteTypeViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TelogWebAPI.Models"> <DefaultMeasTypeId>1</DefaultMeasTypeId> <DefaultTemplateId>1</DefaultTemplateId> <Description>sample string 2</Description> <IsCore>true</IsCore> <IsDefault>true</IsDefault> <Name>sample string 1</Name> <UserField1Label>sample string 4</UserField1Label> <UserField2Label>sample string 5</UserField2Label> <UserField3Label>sample string 6</UserField3Label> <UserField4Label>sample string 7</UserField4Label> <UserField5Label>sample string 8</UserField5Label> </SiteTypeViewModel>