GET v1/facilities/{facilityId}/unitgroups

Gets the facility unit groups.

Request Information

URI Parameters

Name	Description	Type	Additional information
facilityId	The facility identifier.	globally unique identifier	Required

Body Parameters

None.

Response Information

Resource Description

FacilityUnitGroups

Name	Type	Additional information
FacilityUnitGroupsList	Collection of UnitGroup	None.
Errors	Collection of Exception	None.
IsSuccess	boolean	None.

Response Formats

application/json, text/json

Sample:

{
  "FacilityUnitGroupsList": [
    {
      "GroupID": "2efc5926-b679-4485-ac42-d687e6237fc8",
      "GroupName": "sample string 2",
      "SortOrder": 3,
      "LowestCost": 4.1,
      "UnitTypeIds": [
        "57cf11a1-3bc1-4bc8-b761-16500beb8502",
        "63d851d0-6c02-434a-be40-b5a1279a758b"
      ]
    },
    {
      "GroupID": "2efc5926-b679-4485-ac42-d687e6237fc8",
      "GroupName": "sample string 2",
      "SortOrder": 3,
      "LowestCost": 4.1,
      "UnitTypeIds": [
        "57cf11a1-3bc1-4bc8-b761-16500beb8502",
        "63d851d0-6c02-434a-be40-b5a1279a758b"
      ]
    }
  ],
  "Errors": [
    {
      "ClassName": "System.Exception",
      "Message": null,
      "Data": null,
      "InnerException": null,
      "HelpURL": "sample string 1",
      "StackTraceString": null,
      "RemoteStackTraceString": null,
      "RemoteStackIndex": 0,
      "ExceptionMethod": null,
      "HResult": 3,
      "Source": "sample string 2",
      "WatsonBuckets": null
    },
    {
      "ClassName": "System.Exception",
      "Message": null,
      "Data": null,
      "InnerException": null,
      "HelpURL": "sample string 1",
      "StackTraceString": null,
      "RemoteStackTraceString": null,
      "RemoteStackIndex": 0,
      "ExceptionMethod": null,
      "HResult": 3,
      "Source": "sample string 2",
      "WatsonBuckets": null
    }
  ],
  "IsSuccess": true
}

application/xml, text/xml

Sample:

<FacilityUnitGroups xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OpenTech.IssnWebApi.Web.Models.BindingModels">
  <Errors xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:Exception>
      <ClassName xmlns:d4p1="http://www.w3.org/2001/XMLSchema" i:type="d4p1:string" xmlns="">System.Exception</ClassName>
      <Message i:nil="true" xmlns="" />
      <Data i:nil="true" xmlns="" />
      <InnerException i:nil="true" xmlns="" />
      <HelpURL xmlns:d4p1="http://www.w3.org/2001/XMLSchema" i:type="d4p1:string" xmlns="">sample string 1</HelpURL>
      <StackTraceString i:nil="true" xmlns="" />
      <RemoteStackTraceString i:nil="true" xmlns="" />
      <RemoteStackIndex xmlns:d4p1="http://www.w3.org/2001/XMLSchema" i:type="d4p1:int" xmlns="">0</RemoteStackIndex>
      <ExceptionMethod i:nil="true" xmlns="" />
      <HResult xmlns:d4p1="http://www.w3.org/2001/XMLSchema" i:type="d4p1:int" xmlns="">3</HResult>
      <Source xmlns:d4p1="http://www.w3.org/2001/XMLSchema" i:type="d4p1:string" xmlns="">sample string 2</Source>
      <WatsonBuckets i:nil="true" xmlns="" />
    </d2p1:Exception>
    <d2p1:Exception>
      <ClassName xmlns:d4p1="http://www.w3.org/2001/XMLSchema" i:type="d4p1:string" xmlns="">System.Exception</ClassName>
      <Message i:nil="true" xmlns="" />
      <Data i:nil="true" xmlns="" />
      <InnerException i:nil="true" xmlns="" />
      <HelpURL xmlns:d4p1="http://www.w3.org/2001/XMLSchema" i:type="d4p1:string" xmlns="">sample string 1</HelpURL>
      <StackTraceString i:nil="true" xmlns="" />
      <RemoteStackTraceString i:nil="true" xmlns="" />
      <RemoteStackIndex xmlns:d4p1="http://www.w3.org/2001/XMLSchema" i:type="d4p1:int" xmlns="">0</RemoteStackIndex>
      <ExceptionMethod i:nil="true" xmlns="" />
      <HResult xmlns:d4p1="http://www.w3.org/2001/XMLSchema" i:type="d4p1:int" xmlns="">3</HResult>
      <Source xmlns:d4p1="http://www.w3.org/2001/XMLSchema" i:type="d4p1:string" xmlns="">sample string 2</Source>
      <WatsonBuckets i:nil="true" xmlns="" />
    </d2p1:Exception>
  </Errors>
  <IsSuccess>true</IsSuccess>
  <FacilityUnitGroupsList>
    <UnitGroup>
      <GroupID>2efc5926-b679-4485-ac42-d687e6237fc8</GroupID>
      <GroupName>sample string 2</GroupName>
      <LowestCost>4.1</LowestCost>
      <SortOrder>3</SortOrder>
      <UnitTypeIds xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:guid>57cf11a1-3bc1-4bc8-b761-16500beb8502</d4p1:guid>
        <d4p1:guid>63d851d0-6c02-434a-be40-b5a1279a758b</d4p1:guid>
      </UnitTypeIds>
    </UnitGroup>
    <UnitGroup>
      <GroupID>2efc5926-b679-4485-ac42-d687e6237fc8</GroupID>
      <GroupName>sample string 2</GroupName>
      <LowestCost>4.1</LowestCost>
      <SortOrder>3</SortOrder>
      <UnitTypeIds xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:guid>57cf11a1-3bc1-4bc8-b761-16500beb8502</d4p1:guid>
        <d4p1:guid>63d851d0-6c02-434a-be40-b5a1279a758b</d4p1:guid>
      </UnitTypeIds>
    </UnitGroup>
  </FacilityUnitGroupsList>
</FacilityUnitGroups>