pt-fid-workcompensation-tap-b2b-soap-xapi

1.0.x
(0 reviews)
This API provides the B2B partner consumer with a SOAP interface to access RasisServices webservice

Overview

The pt-fid-workcompensation-tap-b2b-soap-xapi provides the consumer with a SOAP interface to access AtisServices and RasisServices webservices.

This API offers a variety of operations to work with claims and reports related to workcompensation.

Communication

This section indicates how the connection with the API is achieved and regarding the output of the same.

Security

The communication with the API is performed over HTTPS, meaning that the communication is encrypted, providing an additional layer of protection when transporting your information.

Moreover, all requests are performed applying a Client ID Enforcement policy, enabling only authorized consumers to access the API resources.

SLA Tiers

The Standard SLA tier allows you to perform up to 30 requests per minute on the resources of this API.

If your needs exceed these limits, please contact Fidelidade to negotiate access to a higher SLA tier.

Error Handling

The pt-fid-workcompensation-tap-b2b-soap-xapi SOAP API V1 always responds with standard HTTP status code 200.

It differentiates between success and error using either SOAP Faults or error messages in the message body, to indicate a server error.

The specific status codes used in the API are:

200 (OK): Success or error, the response always contains a SOAP Envelope.

500 (Internal Server Error): Unexpected error

Successful requests to the API will return a 2xx status code.

When an error occurs, the API will also respond with 2xx status code, and specific SOAP Faults or error messages.

As for the error structure, the API uses a standard structure, that contains the details of the error itself.

Consumers can use the details present in this error message to help troubleshoot errors.

The workcompensation SOAP API V1 was designed to receive and return the messages already used in the former webservice.

The intended Consumers are TAP's Clinical Services (UCS).

Use Cases

createProcess
  • SOAPAction: urn:cgdaplic.com/ws/ATISB2BServices/createProcess
  • A user wants to create a process using the AtisServices.
getProcess
  • SOAPAction: urn:cgdaplic.com/ws/ATISB2BServices/getProcess
  • A user wants to retrieve a specific process from the AtisServices by providing a provider code and a claim number.
getStates
  • SOAPAction: urn:cgdaplic.com/ws/ATISB2BServices/getStates
  • A user wants to retrieve the states of selected claims from the AtisServices.
registerClaim
  • SOAPAction: urn:cgdaplic.com/ws/ATISB2BServices/registerClaim
  • A user wants to register a claim into the AtisServices.
getReports
  • SOAPAction: urn:cgdaplic.com/ws/ATISB2BServices/getReports
  • A user wants to retrieve reports from the AtisServices.
getClaimDescription
  • SOAPAction: urn:cgdaplic.com/ws/ATISB2BServices/getClaimDescription
  • A user wants to retrieve the description of a selected claim from the AtisServices.
getKeyValueListsInRasis
  • SOAPAction: urn:cgdaplic.com/ws/bsgClaims/RasisServices/getKeyValueListsInRasis
  • Returns all parameters of participations.
findClaimsWithNoPATB2BInRasis
  • SOAPAction: urn:cgdaplic.com/ws/bsgClaims/RasisServices/findClaimsWithNoPATB2BInRasis
  • Returns all claims with no PAT.
getParticipationATInRasis
  • SOAPAction: urn:cgdaplic.com/ws/bsgClaims/RasisServices/getParticipationATInRasis
insertParticipationATInRasis
  • SOAPAction: urn:cgdaplic.com/ws/bsgClaims/RasisServices/insertParticipationATInRasis
  • Creates a participation for a given claim.
insertQuickReportInRasis
  • SOAPAction: urn:cgdaplic.com/ws/bsgClaims/RasisServices/insertQuickReportInRasis
  • Creates a quick report.
getParticipationATInRasisPDF
  • SOAPAction: urn:cgdaplic.com/ws/bsgAdobe/ClaimsServices/getParticipationATInRasisPDF
  • Returns pdf of participations.

Reviews