POST FlagManagement/CreateFlag

Creates a flag


Parameters

NameDescriptionAdditional information
flagRequest
The flag Request.

Define this parameter in the request body.

Request body formats

application/json, text/json

Sample:
{
  "FlagId": 1,
  "FlagType": 1,
  "FlagAction": 0,
  "CustomFlagText": "sample string 2",
  "InvalidDateFlagType": 1,
  "Date": "2025-01-26T07:20:14.8550918+00:00",
  "ShiftType": 0,
  "Months": 64,
  "AmberTolerance": 1.0,
  "Frequency": 64,
  "FlagFrequencyType": 1,
  "Period": 64,
  "FlagPeriodType": 1,
  "Limit": 1.0,
  "Description": "sample string 3",
  "Active": true,
  "ClaimantJustificationRequired": true,
  "DisplayImmediately": true,
  "FlagTolerancePercentage": 1.0,
  "FinancialYear": 1,
  "TipLimit": 1.0,
  "FlagLevel": 0,
  "ApproverJustificationRequired": true,
  "IncreaseLimitByNumOthers": true,
  "DisplayLimit": true,
  "NotesForAuthoriser": "sample string 10",
  "ItemRoleInclusionType": 1,
  "ExpenseItemInclusionType": 1,
  "PassengerLimit": 1,
  "ValidateSelectedExpenseItem": true,
  "FlagDescritpion": "sample string 12",
  "FlagTypeDescription": "sample string 13",
  "DailyMileageLimit": 1.0
}

application/xml, text/xml

Sample:
<Flag xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SpendManagementApi.Models.Types">
  <Active>true</Active>
  <AmberTolerance>1</AmberTolerance>
  <ApproverJustificationRequired>true</ApproverJustificationRequired>
  <ClaimantJustificationRequired>true</ClaimantJustificationRequired>
  <CustomFlagText>sample string 2</CustomFlagText>
  <DailyMileageLimit>1</DailyMileageLimit>
  <Date>2025-01-26T07:20:14.8550918+00:00</Date>
  <Description>sample string 3</Description>
  <DisplayImmediately>true</DisplayImmediately>
  <DisplayLimit>true</DisplayLimit>
  <ExpenseItemInclusionType>All</ExpenseItemInclusionType>
  <FinancialYear>1</FinancialYear>
  <FlagAction>None</FlagAction>
  <FlagDescritpion>sample string 12</FlagDescritpion>
  <FlagFrequencyType>InTheLast</FlagFrequencyType>
  <FlagId>1</FlagId>
  <FlagLevel>None</FlagLevel>
  <FlagPeriodType>Days</FlagPeriodType>
  <FlagTolerancePercentage>1</FlagTolerancePercentage>
  <FlagType>Duplicate</FlagType>
  <Frequency>64</Frequency>
  <IncreaseLimitByNumOthers>true</IncreaseLimitByNumOthers>
  <InvalidDateFlagType>SetDate</InvalidDateFlagType>
  <ItemRoleInclusionType>All</ItemRoleInclusionType>
  <Limit>1</Limit>
  <Months>64</Months>
  <NotesForAuthoriser>sample string 10</NotesForAuthoriser>
  <PassengerLimit>1</PassengerLimit>
  <Period>64</Period>
  <ShiftType>RosteredOnActivity</ShiftType>
  <TipLimit>1</TipLimit>
  <ValidateSelectedExpenseItem>true</ValidateSelectedExpenseItem>
</Flag>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response body formats

FlagResponse of the created flag

application/json, text/json

Sample:
{
  "Item": {
    "FlagId": 1,
    "FlagType": 1,
    "FlagAction": 0,
    "CustomFlagText": "sample string 2",
    "InvalidDateFlagType": 1,
    "Date": "2025-01-26T07:20:14.9129595+00:00",
    "ShiftType": 0,
    "Months": 64,
    "AmberTolerance": 1.0,
    "Frequency": 64,
    "FlagFrequencyType": 1,
    "Period": 64,
    "FlagPeriodType": 1,
    "Limit": 1.0,
    "Description": "sample string 3",
    "Active": true,
    "ClaimantJustificationRequired": true,
    "DisplayImmediately": true,
    "FlagTolerancePercentage": 1.0,
    "FinancialYear": 1,
    "TipLimit": 1.0,
    "FlagLevel": 0,
    "ApproverJustificationRequired": true,
    "IncreaseLimitByNumOthers": true,
    "DisplayLimit": true,
    "NotesForAuthoriser": "sample string 10",
    "ItemRoleInclusionType": 1,
    "ExpenseItemInclusionType": 1,
    "PassengerLimit": 1,
    "ValidateSelectedExpenseItem": true,
    "FlagDescritpion": "sample string 12",
    "FlagTypeDescription": "sample string 13",
    "DailyMileageLimit": 1.0
  },
  "ResponseInformation": {
    "Errors": [
      {
        "ErrorCode": "sample string 1",
        "Message": "sample string 2"
      },
      {
        "ErrorCode": "sample string 1",
        "Message": "sample string 2"
      },
      {
        "ErrorCode": "sample string 1",
        "Message": "sample string 2"
      }
    ],
    "Status": 0,
    "Links": [
      {
        "Rel": "sample string 1",
        "Href": "sample string 2",
        "Title": "sample string 3",
        "IsTemplated": true
      },
      {
        "Rel": "sample string 1",
        "Href": "sample string 2",
        "Title": "sample string 3",
        "IsTemplated": true
      },
      {
        "Rel": "sample string 1",
        "Href": "sample string 2",
        "Title": "sample string 3",
        "IsTemplated": true
      }
    ]
  }
}

application/xml, text/xml

Sample:
<FlagResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SpendManagementApi.Models.Responses">
  <ResponseInformation xmlns="http://schemas.datacontract.org/2004/07/SpendManagementApi.Models.Common">
    <Errors>
      <ApiErrorDetail>
        <ErrorCode>sample string 1</ErrorCode>
        <Message>sample string 2</Message>
      </ApiErrorDetail>
      <ApiErrorDetail>
        <ErrorCode>sample string 1</ErrorCode>
        <Message>sample string 2</Message>
      </ApiErrorDetail>
      <ApiErrorDetail>
        <ErrorCode>sample string 1</ErrorCode>
        <Message>sample string 2</Message>
      </ApiErrorDetail>
    </Errors>
    <Links>
      <Link>
        <Href>sample string 2</Href>
        <IsTemplated>true</IsTemplated>
        <Rel>sample string 1</Rel>
        <Title>sample string 3</Title>
      </Link>
      <Link>
        <Href>sample string 2</Href>
        <IsTemplated>true</IsTemplated>
        <Rel>sample string 1</Rel>
        <Title>sample string 3</Title>
      </Link>
      <Link>
        <Href>sample string 2</Href>
        <IsTemplated>true</IsTemplated>
        <Rel>sample string 1</Rel>
        <Title>sample string 3</Title>
      </Link>
    </Links>
    <Status>Failure</Status>
  </ResponseInformation>
  <Item xmlns:d2p1="http://schemas.datacontract.org/2004/07/SpendManagementApi.Models.Types" xmlns="http://schemas.datacontract.org/2004/07/SpendManagementApi.Models.Common">
    <d2p1:Active>true</d2p1:Active>
    <d2p1:AmberTolerance>1</d2p1:AmberTolerance>
    <d2p1:ApproverJustificationRequired>true</d2p1:ApproverJustificationRequired>
    <d2p1:ClaimantJustificationRequired>true</d2p1:ClaimantJustificationRequired>
    <d2p1:CustomFlagText>sample string 2</d2p1:CustomFlagText>
    <d2p1:DailyMileageLimit>1</d2p1:DailyMileageLimit>
    <d2p1:Date>2025-01-26T07:20:14.9129595+00:00</d2p1:Date>
    <d2p1:Description>sample string 3</d2p1:Description>
    <d2p1:DisplayImmediately>true</d2p1:DisplayImmediately>
    <d2p1:DisplayLimit>true</d2p1:DisplayLimit>
    <d2p1:ExpenseItemInclusionType>All</d2p1:ExpenseItemInclusionType>
    <d2p1:FinancialYear>1</d2p1:FinancialYear>
    <d2p1:FlagAction>None</d2p1:FlagAction>
    <d2p1:FlagDescritpion>sample string 12</d2p1:FlagDescritpion>
    <d2p1:FlagFrequencyType>InTheLast</d2p1:FlagFrequencyType>
    <d2p1:FlagId>1</d2p1:FlagId>
    <d2p1:FlagLevel>None</d2p1:FlagLevel>
    <d2p1:FlagPeriodType>Days</d2p1:FlagPeriodType>
    <d2p1:FlagTolerancePercentage>1</d2p1:FlagTolerancePercentage>
    <d2p1:FlagType>Duplicate</d2p1:FlagType>
    <d2p1:Frequency>64</d2p1:Frequency>
    <d2p1:IncreaseLimitByNumOthers>true</d2p1:IncreaseLimitByNumOthers>
    <d2p1:InvalidDateFlagType>SetDate</d2p1:InvalidDateFlagType>
    <d2p1:ItemRoleInclusionType>All</d2p1:ItemRoleInclusionType>
    <d2p1:Limit>1</d2p1:Limit>
    <d2p1:Months>64</d2p1:Months>
    <d2p1:NotesForAuthoriser>sample string 10</d2p1:NotesForAuthoriser>
    <d2p1:PassengerLimit>1</d2p1:PassengerLimit>
    <d2p1:Period>64</d2p1:Period>
    <d2p1:ShiftType>RosteredOnActivity</d2p1:ShiftType>
    <d2p1:TipLimit>1</d2p1:TipLimit>
    <d2p1:ValidateSelectedExpenseItem>true</d2p1:ValidateSelectedExpenseItem>
  </Item>
</FlagResponse>
URI parameters
=
Headers | Add header
: Delete
Body
Samples:
Status
Headers
Body