Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

Entity value for the user (database value)

integer

Required

Body Parameters

None.

Response Information

Resource Description

DeleteAtmResponse

DeleteUserResponse
NameDescriptionTypeAdditional information
Header

ResponseHeader

None.

Body

DeleteUserResponseBody

None.

Response Header Description

ResponseHeader
NameDescriptionTypeAdditional information
Message

Message

string

None.

StatusCode

Status code

ResponseStatus

None.

Status

Status

string

None.

ErrorId

Error id

string

None.

Response Body Description

DeleteUserResponseBody
NameDescriptionTypeAdditional information
UserDeleted

Flag to show if user successfully deleted

boolean

None.

Response Formats

application/json, text/json

Sample:
{
  "Header": {
    "Message": "",
    "StatusCode": 0,
    "Status": "Ok",
    "ErrorId": null
  },
  "Body": {
    "UserDeleted": true
  }
}

application/xml, text/xml

Sample:
<DeleteUserResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SaG.API.Models.Responses.User">
  <Body xmlns:d2p1="http://schemas.datacontract.org/2004/07/SaG.API.Models.Responses.User" xmlns="http://schemas.datacontract.org/2004/07/SaG.API.Models.Responses">
    <d2p1:UserDeleted>true</d2p1:UserDeleted>
  </Body>
  <Header xmlns="http://schemas.datacontract.org/2004/07/SaG.API.Models.Responses">
    <ErrorId i:nil="true" />
    <Message></Message>
    <Status>Ok</Status>
    <StatusCode>Ok</StatusCode>
  </Header>
</DeleteUserResponse>

© 2025 Sargent and Greenleaf