PUT SignOffGroups/{id}

Request Parameters
Request Samples
Response Samples

Parameters

Name	Description	Additional information
id	The Id of the SignOffGroup to edit.	Define this parameter in the request URI.
request	The SignOffGroup to edit	Define this parameter in the request body.

Request body formats

application/json, text/json

Sample:

{
  "GroupId": 10,
  "GroupName": "TestGroupName",
  "Description": "TestGroupDescription",
  "OneClickAuthorization": true,
  "Stages": [
    {
      "SignOffId": 1,
      "SignOffType": 1,
      "SignOffStage": 1,
      "Relid": 1,
      "RelSignOffPerson": null,
      "StageInclusionType": 1,
      "Amount": 10.0,
      "Notify": 2,
      "OnHolidayProvision": 3,
      "HolidayType": 1,
      "HolidayId": 1,
      "HolidayDelegate": null,
      "IncludeId": 1,
      "IncludedItem": "",
      "ClaimantMail": true,
      "SingleSignOff": false,
      "SendMail": false,
      "DisplayDeclaration": true,
      "EmployeeId": 0,
      "ExtraLevels": 1,
      "ApproveHigherLevelsOnly": false,
      "AllocateForPayment": false,
      "IsPostValidationCleanupStage": false,
      "ValidationCorrectionThreshold": null,
      "ApproverJustificationsRequired": false,
      "ClaimPercentageToValidate": null
    }
  ],
  "NotifyClaimantWhenEnvelopeReceived": null,
  "NotifyClaimantWhenEnvelopeNotReceived": null
}

application/xml, text/xml

Sample:

<SignOffGroup xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SpendManagementApi.Models.Types">
  <Description>TestGroupDescription</Description>
  <GroupId>10</GroupId>
  <GroupName>TestGroupName</GroupName>
  <NotifyClaimantWhenEnvelopeNotReceived i:nil="true" />
  <NotifyClaimantWhenEnvelopeReceived i:nil="true" />
  <OneClickAuthorization>true</OneClickAuthorization>
  <Stages>
    <Stage>
      <AllocateForPayment>false</AllocateForPayment>
      <Amount>10</Amount>
      <ApproveHigherLevelsOnly>false</ApproveHigherLevelsOnly>
      <ApproverJustificationsRequired>false</ApproverJustificationsRequired>
      <ClaimPercentageToValidate i:nil="true" />
      <ClaimantMail>true</ClaimantMail>
      <DisplayDeclaration>true</DisplayDeclaration>
      <EmployeeId>0</EmployeeId>
      <ExtraLevels>1</ExtraLevels>
      <HolidayId>1</HolidayId>
      <HolidayType>BudgetHolder</HolidayType>
      <IncludeId>1</IncludeId>
      <IsPostValidationCleanupStage>false</IsPostValidationCleanupStage>
      <Notify>UserIsToCheckClaim</Notify>
      <OnHolidayProvision>AssignClaimToSomeoneElse</OnHolidayProvision>
      <Relid>1</Relid>
      <SendMail>false</SendMail>
      <SignOffId>1</SignOffId>
      <SignOffStage>1</SignOffStage>
      <SignOffType>BudgetHolder</SignOffType>
      <SingleSignOff>false</SingleSignOff>
      <StageInclusionType>Always</StageInclusionType>
      <ValidationCorrectionThreshold i:nil="true" />
    </Stage>
  </Stages>
</SignOffGroup>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response body formats

An SignOffGroupsResponse object containing the edited SignOffGroups.

application/json, text/json

Sample:

{
  "Item": {
    "GroupId": 1,
    "GroupName": "sample string 2",
    "Description": "sample string 3",
    "OneClickAuthorization": true,
    "Stages": [
      null,
      {
        "SignOffId": 1,
        "SignOffType": 0,
        "SignOffStage": 64,
        "Relid": 3,
        "RelSignOffPerson": "sample string 4",
        "StageInclusionType": 0,
        "Amount": 5.0,
        "Notify": 1,
        "OnHolidayProvision": 1,
        "HolidayType": 0,
        "HolidayId": 6,
        "HolidayDelegate": "sample string 7",
        "IncludeId": 8,
        "IncludedItem": "",
        "ClaimantMail": false,
        "SingleSignOff": false,
        "SendMail": false,
        "DisplayDeclaration": false,
        "EmployeeId": 0,
        "ExtraLevels": 0,
        "ApproveHigherLevelsOnly": false,
        "AllocateForPayment": false,
        "IsPostValidationCleanupStage": false,
        "ValidationCorrectionThreshold": null,
        "ApproverJustificationsRequired": false,
        "ClaimPercentageToValidate": null
      },
      {
        "SignOffId": 1,
        "SignOffType": 0,
        "SignOffStage": 64,
        "Relid": 3,
        "RelSignOffPerson": "sample string 4",
        "StageInclusionType": 0,
        "Amount": 5.0,
        "Notify": 1,
        "OnHolidayProvision": 1,
        "HolidayType": 0,
        "HolidayId": 6,
        "HolidayDelegate": "sample string 7",
        "IncludeId": 8,
        "IncludedItem": "",
        "ClaimantMail": false,
        "SingleSignOff": false,
        "SendMail": false,
        "DisplayDeclaration": false,
        "EmployeeId": 0,
        "ExtraLevels": 0,
        "ApproveHigherLevelsOnly": false,
        "AllocateForPayment": false,
        "IsPostValidationCleanupStage": false,
        "ValidationCorrectionThreshold": null,
        "ApproverJustificationsRequired": false,
        "ClaimPercentageToValidate": null
      }
    ],
    "NotifyClaimantWhenEnvelopeReceived": true,
    "NotifyClaimantWhenEnvelopeNotReceived": true
  },
  "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:

<SignOffGroupResponse 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:Description>sample string 3</d2p1:Description>
    <d2p1:GroupId>1</d2p1:GroupId>
    <d2p1:GroupName>sample string 2</d2p1:GroupName>
    <d2p1:NotifyClaimantWhenEnvelopeNotReceived>true</d2p1:NotifyClaimantWhenEnvelopeNotReceived>
    <d2p1:NotifyClaimantWhenEnvelopeReceived>true</d2p1:NotifyClaimantWhenEnvelopeReceived>
    <d2p1:OneClickAuthorization>true</d2p1:OneClickAuthorization>
    <d2p1:Stages>
      <d2p1:Stage i:nil="true" />
      <d2p1:Stage>
        <d2p1:AllocateForPayment>false</d2p1:AllocateForPayment>
        <d2p1:Amount>5</d2p1:Amount>
        <d2p1:ApproveHigherLevelsOnly>false</d2p1:ApproveHigherLevelsOnly>
        <d2p1:ApproverJustificationsRequired>false</d2p1:ApproverJustificationsRequired>
        <d2p1:ClaimPercentageToValidate i:nil="true" />
        <d2p1:ClaimantMail>false</d2p1:ClaimantMail>
        <d2p1:DisplayDeclaration>false</d2p1:DisplayDeclaration>
        <d2p1:EmployeeId>0</d2p1:EmployeeId>
        <d2p1:ExtraLevels>0</d2p1:ExtraLevels>
        <d2p1:HolidayId>6</d2p1:HolidayId>
        <d2p1:HolidayType>None</d2p1:HolidayType>
        <d2p1:IncludeId>8</d2p1:IncludeId>
        <d2p1:IsPostValidationCleanupStage>false</d2p1:IsPostValidationCleanupStage>
        <d2p1:Notify>JustNotifyUserOfClaim</d2p1:Notify>
        <d2p1:OnHolidayProvision>TakeNoAction</d2p1:OnHolidayProvision>
        <d2p1:Relid>3</d2p1:Relid>
        <d2p1:SendMail>false</d2p1:SendMail>
        <d2p1:SignOffId>1</d2p1:SignOffId>
        <d2p1:SignOffStage>64</d2p1:SignOffStage>
        <d2p1:SignOffType>None</d2p1:SignOffType>
        <d2p1:SingleSignOff>false</d2p1:SingleSignOff>
        <d2p1:StageInclusionType>None</d2p1:StageInclusionType>
        <d2p1:ValidationCorrectionThreshold i:nil="true" />
      </d2p1:Stage>
      <d2p1:Stage>
        <d2p1:AllocateForPayment>false</d2p1:AllocateForPayment>
        <d2p1:Amount>5</d2p1:Amount>
        <d2p1:ApproveHigherLevelsOnly>false</d2p1:ApproveHigherLevelsOnly>
        <d2p1:ApproverJustificationsRequired>false</d2p1:ApproverJustificationsRequired>
        <d2p1:ClaimPercentageToValidate i:nil="true" />
        <d2p1:ClaimantMail>false</d2p1:ClaimantMail>
        <d2p1:DisplayDeclaration>false</d2p1:DisplayDeclaration>
        <d2p1:EmployeeId>0</d2p1:EmployeeId>
        <d2p1:ExtraLevels>0</d2p1:ExtraLevels>
        <d2p1:HolidayId>6</d2p1:HolidayId>
        <d2p1:HolidayType>None</d2p1:HolidayType>
        <d2p1:IncludeId>8</d2p1:IncludeId>
        <d2p1:IsPostValidationCleanupStage>false</d2p1:IsPostValidationCleanupStage>
        <d2p1:Notify>JustNotifyUserOfClaim</d2p1:Notify>
        <d2p1:OnHolidayProvision>TakeNoAction</d2p1:OnHolidayProvision>
        <d2p1:Relid>3</d2p1:Relid>
        <d2p1:SendMail>false</d2p1:SendMail>
        <d2p1:SignOffId>1</d2p1:SignOffId>
        <d2p1:SignOffStage>64</d2p1:SignOffStage>
        <d2p1:SignOffType>None</d2p1:SignOffType>
        <d2p1:SingleSignOff>false</d2p1:SingleSignOff>
        <d2p1:StageInclusionType>None</d2p1:StageInclusionType>
        <d2p1:ValidationCorrectionThreshold i:nil="true" />
      </d2p1:Stage>
    </d2p1:Stages>
  </Item>
</SignOffGroupResponse>

PUT SignOffGroups/{id}

Parameters

Request body formats

application/json, text/json

application/xml, text/xml

application/x-www-form-urlencoded

Response body formats

application/json, text/json

application/xml, text/xml

URI parameters

Headers | Add header

Body

Status

Headers

Body