POST api/StatusHistory

Used to retrieve the historical statuses and lifecycle events for a token, such as when it was initially activated, subsequently suspended or resumed, and finally deleted.

Request Information

URI Parameters

None.

Body Parameters

TokenStatusHistoryRequest

StatusHistoryRequest

Name	Description	Type	Additional information
TokenUniqueReference	The TokenUniqueReference of the token. Length - 48 Characters Example: DWSPMC00000000010906a349d9ca4eb1a4d53e3c90a11d9c	string	Required
AuditInfo	Audit Info - See AuditInfo Object Documentation	AuditInfo	Required

Request Formats

application/json, text/json

Sample:

{
  "tokenUniqueReference": "sample string 1",
  "auditInfo": {
    "userId": "sample string 1",
    "userName": "sample string 2",
    "organization": "sample string 3",
    "phone": "sample string 4"
  }
}

application/xml, text/xml

Sample:

<StatusHistoryRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MDES.CustomerService.Models">
  <AuditInfo>
    <Organization>sample string 3</Organization>
    <Phone>sample string 4</Phone>
    <UserId>sample string 1</UserId>
    <UserName>sample string 2</UserName>
  </AuditInfo>
  <TokenUniqueReference>sample string 1</TokenUniqueReference>
</StatusHistoryRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

TokenStatusHistoryResponse

StatusHistoryResponse

Name	Description	Type	Additional information
Statuses	Collection of Status Objects	Collection of Status	None.

Response Formats

application/json, text/json

Sample:

{
  "statuses": [
    {
      "statusCode": "sample string 1",
      "statusDescription": "sample string 2",
      "statusDateTime": "sample string 3",
      "initiator": "sample string 4",
      "commentId": "sample string 5",
      "reasonCode": "sample string 6",
      "auditInfo": {
        "userId": "sample string 1",
        "userName": "sample string 2",
        "organization": "sample string 3",
        "phone": "sample string 4"
      }
    },
    {
      "statusCode": "sample string 1",
      "statusDescription": "sample string 2",
      "statusDateTime": "sample string 3",
      "initiator": "sample string 4",
      "commentId": "sample string 5",
      "reasonCode": "sample string 6",
      "auditInfo": {
        "userId": "sample string 1",
        "userName": "sample string 2",
        "organization": "sample string 3",
        "phone": "sample string 4"
      }
    }
  ]
}

application/xml, text/xml

Sample:

<StatusHistoryResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MDES.CustomerService.Models">
  <Statuses>
    <Status>
      <AuditInfo>
        <Organization>sample string 3</Organization>
        <Phone>sample string 4</Phone>
        <UserId>sample string 1</UserId>
        <UserName>sample string 2</UserName>
      </AuditInfo>
      <CommentId>sample string 5</CommentId>
      <Initiator>sample string 4</Initiator>
      <ReasonCode>sample string 6</ReasonCode>
      <StatusCode>sample string 1</StatusCode>
      <StatusDateTime>sample string 3</StatusDateTime>
      <StatusDescription>sample string 2</StatusDescription>
    </Status>
    <Status>
      <AuditInfo>
        <Organization>sample string 3</Organization>
        <Phone>sample string 4</Phone>
        <UserId>sample string 1</UserId>
        <UserName>sample string 2</UserName>
      </AuditInfo>
      <CommentId>sample string 5</CommentId>
      <Initiator>sample string 4</Initiator>
      <ReasonCode>sample string 6</ReasonCode>
      <StatusCode>sample string 1</StatusCode>
      <StatusDateTime>sample string 3</StatusDateTime>
      <StatusDescription>sample string 2</StatusDescription>
    </Status>
  </Statuses>
</StatusHistoryResponse>