GET api/Info/GetPurgeStatus?personId={personId}

Documentation for 'GetPurgeStatus'.

Request Information

Parameters

Name	Description	Additional information
personId	Documentation for 'personId'.	Define this parameter in the request URI.

Response Information

Response body formats

application/json, text/json

Sample:

{
  "StudentId": "sample string 1",
  "FirstName": "sample string 2",
  "LastName": "sample string 3",
  "Status": "sample string 4",
  "Message": "sample string 5",
  "Options": [
    "sample string 1",
    "sample string 2",
    "sample string 3"
  ],
  "Balance": 1.0,
  "Term": "sample string 6",
  "PurgeStart": "2025-11-05T16:56:51.050901-05:00",
  "PurgeEnd": "2025-11-05T16:56:51.050901-05:00"
}

application/xml, text/xml

Sample:

<PurgeStatus xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GTCAPI.Models">
  <Balance>1</Balance>
  <FirstName>sample string 2</FirstName>
  <LastName>sample string 3</LastName>
  <Message>sample string 5</Message>
  <Options xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
    <d2p1:string>sample string 3</d2p1:string>
  </Options>
  <PurgeEnd>2025-11-05T16:56:51.050901-05:00</PurgeEnd>
  <PurgeStart>2025-11-05T16:56:51.050901-05:00</PurgeStart>
  <Status>sample string 4</Status>
  <StudentId>sample string 1</StudentId>
  <Term>sample string 6</Term>
</PurgeStatus>