POST ShortTermItems/GetItemStatus

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
SecurityKey		string	None.
PolicyId		integer	None.

Request Formats

application/json, text/json

Sample:

{
  "SecurityKey": "sample string 1",
  "PolicyId": 2
}

application/xml, text/xml

Sample:

<SecurityTokenVerifiedRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/api.oneplan.co.za.Models">
  <PolicyId>2</PolicyId>
  <SecurityKey>sample string 1</SecurityKey>
</SecurityTokenVerifiedRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ResponseOfListOfItemStatus

Name	Type	Additional information
Success	boolean	None.
Message	string	None.
Entity	Collection of ItemStatus	None.

Response Formats

application/json, text/json

Sample:

{
  "Success": true,
  "Message": "sample string 2",
  "Entity": [
    {
      "Id": 1,
      "CreatedDateTime": "2025-05-13T22:30:24.6042402+02:00",
      "CreatedBy": "sample string 3",
      "EnumName": "sample string 4",
      "DisplayName": "sample string 5",
      "StartDate": "2025-05-13T22:30:24.6042402+02:00",
      "EndDate": "2025-05-13T22:30:24.6042402+02:00",
      "Description": "sample string 8",
      "ColorHex": "sample string 9"
    },
    {
      "Id": 1,
      "CreatedDateTime": "2025-05-13T22:30:24.6042402+02:00",
      "CreatedBy": "sample string 3",
      "EnumName": "sample string 4",
      "DisplayName": "sample string 5",
      "StartDate": "2025-05-13T22:30:24.6042402+02:00",
      "EndDate": "2025-05-13T22:30:24.6042402+02:00",
      "Description": "sample string 8",
      "ColorHex": "sample string 9"
    }
  ]
}

application/xml, text/xml

Sample:

<ResponseOfArrayOfItemStatus_PYwLh37g xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OnePlan.Core">
  <Entity xmlns:d2p1="http://schemas.datacontract.org/2004/07/api.oneplan.co.za.GeneratedModels">
    <d2p1:ItemStatus>
      <d2p1:ColorHex>sample string 9</d2p1:ColorHex>
      <d2p1:CreatedBy>sample string 3</d2p1:CreatedBy>
      <d2p1:CreatedDateTime>2025-05-13T22:30:24.6042402+02:00</d2p1:CreatedDateTime>
      <d2p1:Description>sample string 8</d2p1:Description>
      <d2p1:DisplayName>sample string 5</d2p1:DisplayName>
      <d2p1:EndDate>2025-05-13T22:30:24.6042402+02:00</d2p1:EndDate>
      <d2p1:EnumName>sample string 4</d2p1:EnumName>
      <d2p1:Id>1</d2p1:Id>
      <d2p1:StartDate>2025-05-13T22:30:24.6042402+02:00</d2p1:StartDate>
    </d2p1:ItemStatus>
    <d2p1:ItemStatus>
      <d2p1:ColorHex>sample string 9</d2p1:ColorHex>
      <d2p1:CreatedBy>sample string 3</d2p1:CreatedBy>
      <d2p1:CreatedDateTime>2025-05-13T22:30:24.6042402+02:00</d2p1:CreatedDateTime>
      <d2p1:Description>sample string 8</d2p1:Description>
      <d2p1:DisplayName>sample string 5</d2p1:DisplayName>
      <d2p1:EndDate>2025-05-13T22:30:24.6042402+02:00</d2p1:EndDate>
      <d2p1:EnumName>sample string 4</d2p1:EnumName>
      <d2p1:Id>1</d2p1:Id>
      <d2p1:StartDate>2025-05-13T22:30:24.6042402+02:00</d2p1:StartDate>
    </d2p1:ItemStatus>
  </Entity>
  <Message>sample string 2</Message>
  <Success>true</Success>
</ResponseOfArrayOfItemStatus_PYwLh37g>