PUT api/v1/{facilityId}/{ledgerId}/update_autopay

Request Information

URI Parameters

Name	Description	Type	Additional information
facilityId		globally unique identifier	Required
ledgerId		globally unique identifier	Required

Body Parameters

AutopayUpdateRequestModel

Name	Description	Type	Additional information
autopay		AutopayRequestData	None.
payment_method		PaymentMethodRequestData	None.

Request Formats

application/json, text/json

Sample:

{
  "autopay": {
    "autopay_day": 1,
    "autopay_enabled": true
  },
  "payment_method": {
    "payment_method_id": "0bda6d21-51c4-4a8c-8935-46b423066190"
  }
}

application/xml, text/xml

Sample:

<AutopayUpdateRequestModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Ross.SSPMS.Services.Models.ShieldAPI.Payments.Requests">
  <Autopay>
    <AutopayDay>1</AutopayDay>
    <AutopayEnabled>true</AutopayEnabled>
  </Autopay>
  <PaymentMethod>
    <PaymentMethodId>0bda6d21-51c4-4a8c-8935-46b423066190</PaymentMethodId>
  </PaymentMethod>
</AutopayUpdateRequestModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ApiResponseMeta

Name	Type	Additional information
message	string	None.
status_code	integer	None.
request_id	globally unique identifier	None.
error_code	integer	None.
status_message	string	None.
status_cat	string	None.
request_method	string	None.
pagination	ApiResponsePaginationData	None.
parameters	ApiBaseParameters	None.

Response Formats

application/json, text/json

Sample:

{
  "message": "sample string 1",
  "status_code": 2,
  "request_id": "7446d7d9-c06d-4ad7-929c-0d873af75f22",
  "error_code": 1,
  "status_message": "sample string 3",
  "status_cat": "http://httpcats.herokuapp.com/2",
  "request_method": "sample string 4",
  "pagination": {
    "current_page": 1,
    "total_pages": 1,
    "per_page": 1,
    "total_entries": 1,
    "previous_page": 1,
    "next_page": 1
  },
  "parameters": {}
}

application/xml, text/xml

Sample:

<ApiResponseMeta xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Ross.SSPMS.Services.Models.ShieldAPI.ApiResponseBase">
  <ErrorCode>1</ErrorCode>
  <HttpStatusCode>2</HttpStatusCode>
  <HttpStatusMessage>sample string 3</HttpStatusMessage>
  <Message>sample string 1</Message>
  <PaginationData>
    <CurrentPage>1</CurrentPage>
    <NextPage>1</NextPage>
    <PerPage>1</PerPage>
    <PreviousPage>1</PreviousPage>
    <TotalEntries>1</TotalEntries>
    <TotalPages>1</TotalPages>
  </PaginationData>
  <Parameters xmlns:d2p1="http://schemas.datacontract.org/2004/07/Ross.SSPMS.Services.Models.ShieldAPI.ApiResponseBase.ParameterClasses" />
  <RequestId>7446d7d9-c06d-4ad7-929c-0d873af75f22</RequestId>
  <RequestMethod>sample string 4</RequestMethod>
</ApiResponseMeta>