Billhighway Cloud API

<back to all web services

StageCardRefDeleteCandidatesRq

The following routes are available for this service:
POST/api/dataRetention/stageCardRefDeleteCandidates
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class StageCardRefDeleteCandidatesRs(IApiResponse):
    staged_count: Optional[int] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class StageCardRefDeleteCandidatesRq(StageCardRefDeleteCandidatesRq):
    pass

Python StageCardRefDeleteCandidatesRq DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /api/dataRetention/stageCardRefDeleteCandidates HTTP/1.1 
Host: devapi.billhighway.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<StageCardRefDeleteCandidatesRq xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common4.DTO.DataRetention">
  <RetentionCutOffDate xmlns:d2p1="http://schemas.datacontract.org/2004/07/System" xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common.DTO.DataRetention">
    <d2p1:DateTime>0001-01-01T00:00:00Z</d2p1:DateTime>
    <d2p1:OffsetMinutes>0</d2p1:OffsetMinutes>
  </RetentionCutOffDate>
  <StartDate xmlns:d2p1="http://schemas.datacontract.org/2004/07/System" xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common.DTO.DataRetention">
    <d2p1:DateTime>0001-01-01T00:00:00Z</d2p1:DateTime>
    <d2p1:OffsetMinutes>0</d2p1:OffsetMinutes>
  </StartDate>
</StageCardRefDeleteCandidatesRq>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<StageCardRefDeleteCandidatesRs xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common4.DTO.DataRetention">
  <StagedCount>0</StagedCount>
</StageCardRefDeleteCandidatesRs>