POST api/v1/portals/{portalUid}/customer/compliance

Create a compliance item

Request Information

URI Parameters

Name	Description	Type	Additional information
portalUid	the portal we are creating the compliance item in	globally unique identifier	Required

Body Parameters

the compliance item to create

Compliance

Name	Description	Type	Additional information
Name	The name of the skill.	string	Required String length: inclusive between 0 and 100
Expires	Does this compliance item expire	boolean	None.
WarningPeriod	The warning period, in days before expiry (in days)	integer	None.
Issued	Is this compliance item issued	boolean	None.
IssuedFor	For how long is the compliance item issued (in days)	integer	None.
Instructions	Additional instructions for completing the compliance item	string	None.

Request Formats

application/json, text/json

Sample:

{
  "Name": "sample string 1",
  "Expires": true,
  "WarningPeriod": 3,
  "Issued": true,
  "IssuedFor": 5,
  "Instructions": "sample string 6"
}

application/xml, text/xml

Sample:

<Compliance xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eclipse.WebApi.Common.Models">
  <Expires>true</Expires>
  <Instructions>sample string 6</Instructions>
  <Issued>true</Issued>
  <IssuedFor>5</IssuedFor>
  <Name>sample string 1</Name>
  <WarningPeriod>3</WarningPeriod>
</Compliance>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

created compliance item

ComplianceViewModel

Name	Description	Type	Additional information
Portal	The portal.	PortalViewModel	None.
ComplianceGuid	The compliance guid	globally unique identifier	None.
Name	The compliance items name.	string	None.
Expires	Does this compliance item expire	boolean	None.
WarningPeriod	How may days before it expires should we warn the user	integer	None.
Issued	Is this compliance item issued from a given date	boolean	None.
IssuedFor	The number of days from the issue date that this compliance item is valid	integer	None.
Instructions	The instuctions to be given to a candidate for the compliance item	string	None.
DateCreated	Date created	date	None.
DateUpdated	Date last updated	date	None.
Heading	The compliance heading for this compliance item	string	None.
HeadingDescription	The headings description	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": "587563f4-6909-49e7-8a94-e82891532b66",
    "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:34.0615815+00:00",
    "UpdatedBy": "sample string 3"
  },
  "ComplianceGuid": "c5e983d9-d92d-47b0-8d31-caf8b436e960",
  "Name": "sample string 2",
  "Expires": true,
  "WarningPeriod": 4,
  "Issued": true,
  "IssuedFor": 6,
  "Instructions": "sample string 7",
  "DateCreated": "2025-10-27T14:00:34.0615815+00:00",
  "DateUpdated": "2025-10-27T14:00:34.0615815+00:00",
  "Heading": "sample string 10",
  "HeadingDescription": "sample string 11",
  "Uid": "ae0e0b1b-edee-476e-aabd-705d7f05d1bd",
  "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"
    }
  ],
  "UpdatedBy": "sample string 13"
}

application/xml, text/xml

Sample:

<ComplianceViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eclipse.WebApi.Common.ViewModels">
  <DateUpdated xmlns:d2p1="http://www.w3.org/2001/XMLSchema" i:type="d2p1:dateTime">2025-10-27T14:00:34.0615815+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>ae0e0b1b-edee-476e-aabd-705d7f05d1bd</Uid>
  <UpdatedBy>sample string 13</UpdatedBy>
  <ComplianceGuid>c5e983d9-d92d-47b0-8d31-caf8b436e960</ComplianceGuid>
  <DateCreated>2025-10-27T14:00:34.0615815+00:00</DateCreated>
  <DateUpdated xmlns:d2p1="http://www.w3.org/2001/XMLSchema" i:type="d2p1:dateTime">2025-10-27T14:00:34.0615815+00:00</DateUpdated>
  <Expires>true</Expires>
  <Heading>sample string 10</Heading>
  <HeadingDescription>sample string 11</HeadingDescription>
  <Instructions>sample string 7</Instructions>
  <Issued>true</Issued>
  <IssuedFor>6</IssuedFor>
  <Name>sample string 2</Name>
  <Portal>
    <DateUpdated>2025-10-27T14:00:34.0615815+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>587563f4-6909-49e7-8a94-e82891532b66</Uid>
    <UpdatedBy>sample string 3</UpdatedBy>
    <Name>sample string 1</Name>
  </Portal>
  <WarningPeriod>4</WarningPeriod>
</ComplianceViewModel>