ProRoster - Delete a snapshot.

API Url

Use it for deleting snapshot with all demands.

DELETE
http://localhost:16010/ProMarkREST/rest/ProRoster/snapshots/{id}

Permissions: user

Path parameters

FieldTypeDescription
idNumber

The snapshot's unique identifier.

Success 200

FieldTypeDescription
responseObject

Main object containing the response data.

  messageoptionalObject

Object containing response messages.

    codeNumber

Message code.

    textString

Message text.

    typeString

Type of message.

Allowed values:"warning""info"

Error 4xx

FieldTypeDescription
responseObject

Main object containing the response data.

  errorCodeNumber

Error code.

  errorMessageString

Error description.

Error example when a snapshot does not exist :

{
"response": {
"errorCode": 1,
"errorMessage": "The selected snapshot does not exist."
}
}