GET api/ImplementationGuide/Edit/{implementationGuideId}

Returns all information related to an implementation guide to be edited

Request Information

URI Parameters

Name	Description	Type	Additional information
implementationGuideId	The id of the implementation guide	integer	None.

Body Parameters

None.

Response Information

Resource Description

Trifolia.Web.Models.IGManagement.EditModel

Name	Type	Additional information
Id	integer	None.
Identifier	string	None.
Name	string	None.
DisplayName	string	None.
WebDisplayName	string	None.
WebDescription	string	None.
WebReadmeOverview	string	None.
TypeId	integer	None.
ConsolidatedFormat	boolean	None.
TestIg	boolean	None.
PreviousVersionName	string	None.
PreviousVersionId	integer	None.
CurrentVersion	integer	None.
DisableVersionFields	boolean	None.
OrganizationId	integer	None.
Html	string	None.
CardinalityZeroOrOne	string	None.
CardinalityExactlyOne	string	None.
CardinalityAtLeastOne	string	None.
CardinalityZeroOrMore	string	None.
CardinalityZero	string	None.
TemplateTypes	Collection of Trifolia.Web.Models.IGManagement.EditModel+TemplateTypeItem	None.
CustomSchematrons	Collection of Trifolia.Web.Models.IGManagement.EditModel+CustomSchematronItem	None.
DeletedCustomSchematrons	Collection of integer	None.
PreviousIgs	Dictionary of integer [key] and string [value]	None.
ViewPermissions	Collection of Trifolia.Web.Models.IGManagement.EditModel+Permission	None.
EditPermissions	Collection of Trifolia.Web.Models.IGManagement.EditModel+Permission	None.
DefaultViewPermissions	Collection of Trifolia.Web.Models.IGManagement.EditModel+Permission	None.
DefaultEditPermissions	Collection of Trifolia.Web.Models.IGManagement.EditModel+Permission	None.
Sections	Collection of Trifolia.Web.Models.IGManagement.EditModel+Section	None.
Categories	Collection of string	None.
AccessManagerId	integer	None.
AllowAccessRequests	boolean	None.
NotifyNewPermissions	boolean	None.

Response Formats

application/json, text/json

Sample:

{
  "Id": 1,
  "Identifier": "sample string 2",
  "Name": "sample string 3",
  "DisplayName": "sample string 4",
  "WebDisplayName": "sample string 5",
  "WebDescription": "sample string 6",
  "WebReadmeOverview": "sample string 7",
  "TypeId": 1,
  "ConsolidatedFormat": true,
  "TestIg": true,
  "PreviousVersionName": "sample string 10",
  "PreviousVersionId": 1,
  "CurrentVersion": 1,
  "DisableVersionFields": true,
  "OrganizationId": 1,
  "Html": "sample string 12",
  "CardinalityZeroOrOne": "sample string 13",
  "CardinalityExactlyOne": "sample string 14",
  "CardinalityAtLeastOne": "sample string 15",
  "CardinalityZeroOrMore": "sample string 16",
  "CardinalityZero": "sample string 17",
  "TemplateTypes": [
    {
      "DefaultName": "sample string 1",
      "Description": "sample string 2",
      "Name": "sample string 3"
    },
    {
      "DefaultName": "sample string 1",
      "Description": "sample string 2",
      "Name": "sample string 3"
    }
  ],
  "CustomSchematrons": [
    {
      "Id": 1,
      "Phase": "sample string 2",
      "PatternId": "sample string 3",
      "PatternContent": "sample string 4"
    },
    {
      "Id": 1,
      "Phase": "sample string 2",
      "PatternId": "sample string 3",
      "PatternContent": "sample string 4"
    }
  ],
  "DeletedCustomSchematrons": [
    1,
    2
  ],
  "PreviousIgs": {
    "1": "sample string 2",
    "3": "sample string 4"
  },
  "ViewPermissions": [
    {
      "Id": 1,
      "Name": "sample string 2",
      "Type": 0
    },
    {
      "Id": 1,
      "Name": "sample string 2",
      "Type": 0
    }
  ],
  "EditPermissions": [
    {
      "Id": 1,
      "Name": "sample string 2",
      "Type": 0
    },
    {
      "Id": 1,
      "Name": "sample string 2",
      "Type": 0
    }
  ],
  "DefaultViewPermissions": [
    {
      "Id": 1,
      "Name": "sample string 2",
      "Type": 0
    },
    {
      "Id": 1,
      "Name": "sample string 2",
      "Type": 0
    }
  ],
  "DefaultEditPermissions": [
    {
      "Id": 1,
      "Name": "sample string 2",
      "Type": 0
    },
    {
      "Id": 1,
      "Name": "sample string 2",
      "Type": 0
    }
  ],
  "Sections": [
    {
      "Id": 1,
      "Heading": "sample string 1",
      "Content": "sample string 2",
      "Order": 3,
      "Level": 4
    },
    {
      "Id": 1,
      "Heading": "sample string 1",
      "Content": "sample string 2",
      "Order": 3,
      "Level": 4
    }
  ],
  "Categories": [
    "sample string 1",
    "sample string 2"
  ],
  "AccessManagerId": 1,
  "AllowAccessRequests": true,
  "NotifyNewPermissions": true
}

application/xml, text/xml

Sample:

<EditModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Trifolia.Web.Models.IGManagement">
  <AccessManagerId>1</AccessManagerId>
  <AllowAccessRequests>true</AllowAccessRequests>
  <CardinalityAtLeastOne>sample string 15</CardinalityAtLeastOne>
  <CardinalityExactlyOne>sample string 14</CardinalityExactlyOne>
  <CardinalityZero>sample string 17</CardinalityZero>
  <CardinalityZeroOrMore>sample string 16</CardinalityZeroOrMore>
  <CardinalityZeroOrOne>sample string 13</CardinalityZeroOrOne>
  <Categories xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </Categories>
  <ConsolidatedFormat>true</ConsolidatedFormat>
  <CurrentVersion>1</CurrentVersion>
  <CustomSchematrons>
    <EditModel.CustomSchematronItem>
      <Id>1</Id>
      <PatternContent>sample string 4</PatternContent>
      <PatternId>sample string 3</PatternId>
      <Phase>sample string 2</Phase>
    </EditModel.CustomSchematronItem>
    <EditModel.CustomSchematronItem>
      <Id>1</Id>
      <PatternContent>sample string 4</PatternContent>
      <PatternId>sample string 3</PatternId>
      <Phase>sample string 2</Phase>
    </EditModel.CustomSchematronItem>
  </CustomSchematrons>
  <DefaultEditPermissions>
    <EditModel.Permission>
      <Id>1</Id>
      <Name>sample string 2</Name>
      <Type>Everyone</Type>
    </EditModel.Permission>
    <EditModel.Permission>
      <Id>1</Id>
      <Name>sample string 2</Name>
      <Type>Everyone</Type>
    </EditModel.Permission>
  </DefaultEditPermissions>
  <DefaultViewPermissions>
    <EditModel.Permission>
      <Id>1</Id>
      <Name>sample string 2</Name>
      <Type>Everyone</Type>
    </EditModel.Permission>
    <EditModel.Permission>
      <Id>1</Id>
      <Name>sample string 2</Name>
      <Type>Everyone</Type>
    </EditModel.Permission>
  </DefaultViewPermissions>
  <DeletedCustomSchematrons xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </DeletedCustomSchematrons>
  <DisableVersionFields>true</DisableVersionFields>
  <DisplayName>sample string 4</DisplayName>
  <EditPermissions>
    <EditModel.Permission>
      <Id>1</Id>
      <Name>sample string 2</Name>
      <Type>Everyone</Type>
    </EditModel.Permission>
    <EditModel.Permission>
      <Id>1</Id>
      <Name>sample string 2</Name>
      <Type>Everyone</Type>
    </EditModel.Permission>
  </EditPermissions>
  <Html>sample string 12</Html>
  <Id>1</Id>
  <Identifier>sample string 2</Identifier>
  <Name>sample string 3</Name>
  <NotifyNewPermissions>true</NotifyNewPermissions>
  <OrganizationId>1</OrganizationId>
  <PreviousIgs xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfintstring>
      <d2p1:Key>1</d2p1:Key>
      <d2p1:Value>sample string 2</d2p1:Value>
    </d2p1:KeyValueOfintstring>
    <d2p1:KeyValueOfintstring>
      <d2p1:Key>3</d2p1:Key>
      <d2p1:Value>sample string 4</d2p1:Value>
    </d2p1:KeyValueOfintstring>
  </PreviousIgs>
  <PreviousVersionId>1</PreviousVersionId>
  <PreviousVersionName>sample string 10</PreviousVersionName>
  <Sections>
    <EditModel.Section>
      <Content>sample string 2</Content>
      <Heading>sample string 1</Heading>
      <Id>1</Id>
      <Level>4</Level>
      <Order>3</Order>
    </EditModel.Section>
    <EditModel.Section>
      <Content>sample string 2</Content>
      <Heading>sample string 1</Heading>
      <Id>1</Id>
      <Level>4</Level>
      <Order>3</Order>
    </EditModel.Section>
  </Sections>
  <TemplateTypes>
    <EditModel.TemplateTypeItem>
      <DefaultName>sample string 1</DefaultName>
      <Description>sample string 2</Description>
      <Name>sample string 3</Name>
    </EditModel.TemplateTypeItem>
    <EditModel.TemplateTypeItem>
      <DefaultName>sample string 1</DefaultName>
      <Description>sample string 2</Description>
      <Name>sample string 3</Name>
    </EditModel.TemplateTypeItem>
  </TemplateTypes>
  <TestIg>true</TestIg>
  <TypeId>1</TypeId>
  <ViewPermissions>
    <EditModel.Permission>
      <Id>1</Id>
      <Name>sample string 2</Name>
      <Type>Everyone</Type>
    </EditModel.Permission>
    <EditModel.Permission>
      <Id>1</Id>
      <Name>sample string 2</Name>
      <Type>Everyone</Type>
    </EditModel.Permission>
  </ViewPermissions>
  <WebDescription>sample string 6</WebDescription>
  <WebDisplayName>sample string 5</WebDisplayName>
  <WebReadmeOverview>sample string 7</WebReadmeOverview>
</EditModel>

GET api/ImplementationGuide/Edit/{implementationGuideId}

Request Information

URI Parameters

Body Parameters

Response Information

Resource Description

Response Formats

application/json, text/json

application/xml, text/xml

URI parameters

Headers | Add header

Body

Status

Headers

Body