POST api/certificaciones/patrono/getpatronalcertification

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
FEIN	string	None.
SEIN	string	None.
EmployerName	string	None.
EmailAddress	string	None.
TerminalId	integer	None.
OGPCorrelationID	string	None.
OGPATGNumber	string	None.
Source	string	None.
UserId	string	None.
SendByEmail	boolean	None.
SendCertificate	boolean	None.

Request Formats

application/json, text/json

Sample:

{
  "FEIN": "sample string 1",
  "SEIN": "sample string 2",
  "EmployerName": "sample string 3",
  "EmailAddress": "sample string 4",
  "TerminalId": 1,
  "OGPCorrelationID": "sample string 5",
  "OGPATGNumber": "sample string 6",
  "Source": "sample string 7",
  "UserId": "sample string 8",
  "SendByEmail": true,
  "SendCertificate": true
}

application/xml, text/xml

Sample:

<PatronalCertificationRequestViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/asume.api.data.ViewModels">
  <EmailAddress>sample string 4</EmailAddress>
  <EmployerName>sample string 3</EmployerName>
  <FEIN>sample string 1</FEIN>
  <OGPATGNumber>sample string 6</OGPATGNumber>
  <OGPCorrelationID>sample string 5</OGPCorrelationID>
  <SEIN>sample string 2</SEIN>
  <SendByEmail>true</SendByEmail>
  <SendCertificate>true</SendCertificate>
  <Source>sample string 7</Source>
  <TerminalId>1</TerminalId>
  <UserId>sample string 8</UserId>
</PatronalCertificationRequestViewModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

PatronalCertificationResponseViewModel

Name	Type	Additional information
ResultingRequest	PatronalResultingRequestViewModel	None.
EvaluationResult	PatronalEvaluationResultViewModel	None.
CertificationPDFBytes	string	None.
SentByEmail	boolean	None.
SentByEmailSuccess	boolean	None.
Message	string	None.
CertificationKey	string	None.

Response Formats

application/json, text/json

Sample:

{
  "ResultingRequest": {
    "Id": 1,
    "Patrono": "sample string 2",
    "RequestDate": "2025-05-02T08:46:58.982401-04:00",
    "CertificationRequestStatus": 4,
    "Language": 5,
    "OGPCorrelationID": "sample string 6",
    "EmissionDate": "2025-05-02T08:46:58.982401-04:00",
    "Reason": "sample string 8",
    "Owner": "sample string 9",
    "OGPATGNumber": "sample string 10",
    "SolicitantName": "sample string 11",
    "SolicitantIDNumber": "sample string 12",
    "ExpirationDate": "2025-05-02T08:46:58.982401-04:00",
    "CommitedToPRACSES": true,
    "Resolution": "sample string 15",
    "Kiosco": "sample string 16",
    "Comments": "sample string 17",
    "PorAcuerdo": true,
    "KioscoId": 1,
    "EvaluationResult": "sample string 19"
  },
  "EvaluationResult": {
    "FEIN": "sample string 1",
    "SEIN": "sample string 2",
    "ParticipantNumber": "sample string 3",
    "IsUnderInvestigation": true,
    "InvestigationReasonId": 1,
    "EmployerName": "sample string 5",
    "CertificationType": "sample string 6",
    "Address": "sample string 7",
    "Employees": [
      {
        "ResultFullName": "sample string 1",
        "ResultName": "sample string 2",
        "ResultInitial": "sample string 3",
        "ResultLastName1": "sample string 4",
        "ResultLastName2": "sample string 5",
        "SSN": "sample string 6",
        "ResultDateOfBirth": "2025-05-02T08:46:58.982401-04:00",
        "ParticipantNumber": "sample string 8",
        "Cases": [
          {
            "CaseNumber": "sample string 1",
            "InCompliance": true,
            "Pension": 3.0,
            "Arrears": 4.0,
            "PaymentPlan": 5.0,
            "PaymentPlanCycle": "sample string 6",
            "PaymentPlanStartDate": "2025-05-02T08:46:58.982401-04:00",
            "PaymentPlanLatestPaymentDate": "2025-05-02T08:46:58.982401-04:00",
            "ActivePNCParticipant": "sample string 7",
            "ActivePNCName": "sample string 8"
          },
          {
            "CaseNumber": "sample string 1",
            "InCompliance": true,
            "Pension": 3.0,
            "Arrears": 4.0,
            "PaymentPlan": 5.0,
            "PaymentPlanCycle": "sample string 6",
            "PaymentPlanStartDate": "2025-05-02T08:46:58.982401-04:00",
            "PaymentPlanLatestPaymentDate": "2025-05-02T08:46:58.982401-04:00",
            "ActivePNCParticipant": "sample string 7",
            "ActivePNCName": "sample string 8"
          }
        ],
        "InCompliance": true,
        "Eliminado": true
      },
      {
        "ResultFullName": "sample string 1",
        "ResultName": "sample string 2",
        "ResultInitial": "sample string 3",
        "ResultLastName1": "sample string 4",
        "ResultLastName2": "sample string 5",
        "SSN": "sample string 6",
        "ResultDateOfBirth": "2025-05-02T08:46:58.982401-04:00",
        "ParticipantNumber": "sample string 8",
        "Cases": [
          {
            "CaseNumber": "sample string 1",
            "InCompliance": true,
            "Pension": 3.0,
            "Arrears": 4.0,
            "PaymentPlan": 5.0,
            "PaymentPlanCycle": "sample string 6",
            "PaymentPlanStartDate": "2025-05-02T08:46:58.982401-04:00",
            "PaymentPlanLatestPaymentDate": "2025-05-02T08:46:58.982401-04:00",
            "ActivePNCParticipant": "sample string 7",
            "ActivePNCName": "sample string 8"
          },
          {
            "CaseNumber": "sample string 1",
            "InCompliance": true,
            "Pension": 3.0,
            "Arrears": 4.0,
            "PaymentPlan": 5.0,
            "PaymentPlanCycle": "sample string 6",
            "PaymentPlanStartDate": "2025-05-02T08:46:58.982401-04:00",
            "PaymentPlanLatestPaymentDate": "2025-05-02T08:46:58.982401-04:00",
            "ActivePNCParticipant": "sample string 7",
            "ActivePNCName": "sample string 8"
          }
        ],
        "InCompliance": true,
        "Eliminado": true
      }
    ],
    "EmployeesNotInCompliance": [
      {
        "FullName": "sample string 1",
        "CaseNumber": "sample string 2",
        "SSNLast4": "sample string 3"
      },
      {
        "FullName": "sample string 1",
        "CaseNumber": "sample string 2",
        "SSNLast4": "sample string 3"
      }
    ],
    "ResultMessage": "sample string 8",
    "EvaluationSuccess": true
  },
  "CertificationPDFBytes": "sample string 1",
  "SentByEmail": true,
  "SentByEmailSuccess": true,
  "Message": "sample string 4",
  "CertificationKey": "sample string 5"
}

application/xml, text/xml

Sample:

<PatronalCertificationResponseViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/asume.api.data.ViewModels">
  <CertificationKey>sample string 5</CertificationKey>
  <CertificationPDFBytes>sample string 1</CertificationPDFBytes>
  <EvaluationResult>
    <Address>sample string 7</Address>
    <CertificationType>sample string 6</CertificationType>
    <Employees>
      <EmployeeViewModel>
        <Cases>
          <EmployeeCaseViewModel>
            <ActivePNCName>sample string 8</ActivePNCName>
            <ActivePNCParticipant>sample string 7</ActivePNCParticipant>
            <Arrears>4</Arrears>
            <CaseNumber>sample string 1</CaseNumber>
            <InCompliance>true</InCompliance>
            <PaymentPlan>5</PaymentPlan>
            <PaymentPlanCycle>sample string 6</PaymentPlanCycle>
            <PaymentPlanLatestPaymentDate>2025-05-02T08:46:58.982401-04:00</PaymentPlanLatestPaymentDate>
            <PaymentPlanStartDate>2025-05-02T08:46:58.982401-04:00</PaymentPlanStartDate>
            <Pension>3</Pension>
          </EmployeeCaseViewModel>
          <EmployeeCaseViewModel>
            <ActivePNCName>sample string 8</ActivePNCName>
            <ActivePNCParticipant>sample string 7</ActivePNCParticipant>
            <Arrears>4</Arrears>
            <CaseNumber>sample string 1</CaseNumber>
            <InCompliance>true</InCompliance>
            <PaymentPlan>5</PaymentPlan>
            <PaymentPlanCycle>sample string 6</PaymentPlanCycle>
            <PaymentPlanLatestPaymentDate>2025-05-02T08:46:58.982401-04:00</PaymentPlanLatestPaymentDate>
            <PaymentPlanStartDate>2025-05-02T08:46:58.982401-04:00</PaymentPlanStartDate>
            <Pension>3</Pension>
          </EmployeeCaseViewModel>
        </Cases>
        <Eliminado>true</Eliminado>
        <InCompliance>true</InCompliance>
        <ParticipantNumber>sample string 8</ParticipantNumber>
        <ResultDateOfBirth>2025-05-02T08:46:58.982401-04:00</ResultDateOfBirth>
        <ResultFullName>sample string 1</ResultFullName>
        <ResultInitial>sample string 3</ResultInitial>
        <ResultLastName1>sample string 4</ResultLastName1>
        <ResultLastName2>sample string 5</ResultLastName2>
        <ResultName>sample string 2</ResultName>
        <SSN>sample string 6</SSN>
      </EmployeeViewModel>
      <EmployeeViewModel>
        <Cases>
          <EmployeeCaseViewModel>
            <ActivePNCName>sample string 8</ActivePNCName>
            <ActivePNCParticipant>sample string 7</ActivePNCParticipant>
            <Arrears>4</Arrears>
            <CaseNumber>sample string 1</CaseNumber>
            <InCompliance>true</InCompliance>
            <PaymentPlan>5</PaymentPlan>
            <PaymentPlanCycle>sample string 6</PaymentPlanCycle>
            <PaymentPlanLatestPaymentDate>2025-05-02T08:46:58.982401-04:00</PaymentPlanLatestPaymentDate>
            <PaymentPlanStartDate>2025-05-02T08:46:58.982401-04:00</PaymentPlanStartDate>
            <Pension>3</Pension>
          </EmployeeCaseViewModel>
          <EmployeeCaseViewModel>
            <ActivePNCName>sample string 8</ActivePNCName>
            <ActivePNCParticipant>sample string 7</ActivePNCParticipant>
            <Arrears>4</Arrears>
            <CaseNumber>sample string 1</CaseNumber>
            <InCompliance>true</InCompliance>
            <PaymentPlan>5</PaymentPlan>
            <PaymentPlanCycle>sample string 6</PaymentPlanCycle>
            <PaymentPlanLatestPaymentDate>2025-05-02T08:46:58.982401-04:00</PaymentPlanLatestPaymentDate>
            <PaymentPlanStartDate>2025-05-02T08:46:58.982401-04:00</PaymentPlanStartDate>
            <Pension>3</Pension>
          </EmployeeCaseViewModel>
        </Cases>
        <Eliminado>true</Eliminado>
        <InCompliance>true</InCompliance>
        <ParticipantNumber>sample string 8</ParticipantNumber>
        <ResultDateOfBirth>2025-05-02T08:46:58.982401-04:00</ResultDateOfBirth>
        <ResultFullName>sample string 1</ResultFullName>
        <ResultInitial>sample string 3</ResultInitial>
        <ResultLastName1>sample string 4</ResultLastName1>
        <ResultLastName2>sample string 5</ResultLastName2>
        <ResultName>sample string 2</ResultName>
        <SSN>sample string 6</SSN>
      </EmployeeViewModel>
    </Employees>
    <EmployeesNotInCompliance>
      <EmployeeComplianceSummaryViewModel>
        <CaseNumber>sample string 2</CaseNumber>
        <FullName>sample string 1</FullName>
        <SSNLast4>sample string 3</SSNLast4>
      </EmployeeComplianceSummaryViewModel>
      <EmployeeComplianceSummaryViewModel>
        <CaseNumber>sample string 2</CaseNumber>
        <FullName>sample string 1</FullName>
        <SSNLast4>sample string 3</SSNLast4>
      </EmployeeComplianceSummaryViewModel>
    </EmployeesNotInCompliance>
    <EmployerName>sample string 5</EmployerName>
    <EvaluationSuccess>true</EvaluationSuccess>
    <FEIN>sample string 1</FEIN>
    <InvestigationReasonId>1</InvestigationReasonId>
    <IsUnderInvestigation>true</IsUnderInvestigation>
    <ParticipantNumber>sample string 3</ParticipantNumber>
    <ResultMessage>sample string 8</ResultMessage>
    <SEIN>sample string 2</SEIN>
  </EvaluationResult>
  <Message>sample string 4</Message>
  <ResultingRequest>
    <CertificationRequestStatus>4</CertificationRequestStatus>
    <Comments>sample string 17</Comments>
    <CommitedToPRACSES>true</CommitedToPRACSES>
    <EmissionDate>2025-05-02T08:46:58.982401-04:00</EmissionDate>
    <EvaluationResult>sample string 19</EvaluationResult>
    <ExpirationDate>2025-05-02T08:46:58.982401-04:00</ExpirationDate>
    <Id>1</Id>
    <Kiosco>sample string 16</Kiosco>
    <KioscoId>1</KioscoId>
    <Language>5</Language>
    <OGPATGNumber>sample string 10</OGPATGNumber>
    <OGPCorrelationID>sample string 6</OGPCorrelationID>
    <Owner>sample string 9</Owner>
    <Patrono>sample string 2</Patrono>
    <PorAcuerdo>true</PorAcuerdo>
    <Reason>sample string 8</Reason>
    <RequestDate>2025-05-02T08:46:58.982401-04:00</RequestDate>
    <Resolution>sample string 15</Resolution>
    <SolicitantIDNumber>sample string 12</SolicitantIDNumber>
    <SolicitantName>sample string 11</SolicitantName>
  </ResultingRequest>
  <SentByEmail>true</SentByEmail>
  <SentByEmailSuccess>true</SentByEmailSuccess>
</PatronalCertificationResponseViewModel>