POST api/FunctionalAcknowledgement

This method is used for reporting a Functional Acknowledgement. RestFUL version of an X12 997 or EDIFACT CONTROL

Request Information


URI Parameters

None.

Body Parameters

FunctionalAcknowledgementRequest
NameDescriptionTypeAdditional information
ackstatus

Functional Acknowledgement Indicator

FunctionalAcknowledgementType

None.

msgkey

API method resource name

string

None.

msgid

API method Message ID Header Key = MSGID

string

None.

reporterrors

List of errors

Collection of ReportError

None.

apikey

Unique Value assigned by an administrator during account setup.

string

None.

username

Username Assigned by an administrator during account setup

string

None.

password

Password Assigned by an administrator during account setup

string

None.

ctoken

Optional Client Token

string

None.

Request Formats

application/json, text/json

Sample:
{
  "ackstatus": 3,
  "msgkey": "api/pushtracking",
  "msgid": "f974d7e5-1d9e-4b3f-951a-773a06ba1e4d",
  "reporterrors": [
    {
      "code": "EFA104",
      "element": "$.result.CONTAINERS[0].EVENTS[1].EventLocation.UnLocode",
      "detail": "Missing Unlocode."
    }
  ],
  "apikey": null,
  "username": null,
  "password": null,
  "ctoken": null
}

application/xml, text/xml

Sample:
<FunctionalAcknowledgementRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ExternalRestService.Models">
  <apikey>sample string 3</apikey>
  <ctoken>sample string 6</ctoken>
  <password>sample string 5</password>
  <username>sample string 4</username>
  <ackstatus>Rejected</ackstatus>
  <msgid>sample string 2</msgid>
  <msgkey>sample string 1</msgkey>
  <reporterrors>
    <ReportError>
      <code>sample string 1</code>
      <detail>sample string 3</detail>
      <element>sample string 2</element>
    </ReportError>
    <ReportError>
      <code>sample string 1</code>
      <detail>sample string 3</detail>
      <element>sample string 2</element>
    </ReportError>
  </reporterrors>
</FunctionalAcknowledgementRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information


Resource Description

response

FunctionalAcknowledgementResponse
NameDescriptionTypeAdditional information
ack

A flag indicating success or failure of the web service response back to the client. Default is success.

AcknowledgeType

None.

exceptions

Message back to client. Mostly used when a web service failure occurs.

Collection of ResponseExceptionDto

None.

ctoken

Optional Client Token

string

None.

Response Formats

application/json, text/json

Sample:
{
  "ackstatus": null,
  "msgkey": null,
  "msgid": null,
  "reporterrors": null,
  "apikey": null,
  "username": null,
  "password": null,
  "ctoken": null
}

application/xml, text/xml

Sample:
<FunctionalAcknowledgementResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ExternalRestService.Models">
  <ack>Failure</ack>
  <ctoken>sample string 1</ctoken>
  <exceptions>
    <ResponseExceptionDto>
      <errorcode>sample string 1</errorcode>
      <msg>sample string 2</msg>
      <suggestion>sample string 4</suggestion>
      <validationcodes>sample string 3</validationcodes>
    </ResponseExceptionDto>
    <ResponseExceptionDto>
      <errorcode>sample string 1</errorcode>
      <msg>sample string 2</msg>
      <suggestion>sample string 4</suggestion>
      <validationcodes>sample string 3</validationcodes>
    </ResponseExceptionDto>
  </exceptions>
</FunctionalAcknowledgementResponse>