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 .csv suffix or ?format=csv

HTTP + CSV

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: text/csv
Content-Type: text/csv
Content-Length: length

{"StartDate":"0001-01-01T00:00:00.0000000+00:00","RetentionCutOffDate":"0001-01-01T00:00:00.0000000+00:00"}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"StagedCount":0}