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

Name	Description	Type	Additional 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/xml

Sample:

<FunctionalAcknowledgementRequest>
  <apikey>8881BA2F-5FE2-4CF1-D99E-5963J9192806</apikey>
  <ctoken>af52c0ec-04d7-4a39-919a-2d3ccdc2d6bc</ctoken>
  <password>dpassword</password>
  <username>demoapi</username>
  <ackstatus>AcceptedWithErrors</ackstatus>
  <msgid>93a19fad-2463-4f5d-a837-fadd07afc6d4</msgid>
  <msgkey>api/pushtracking</msgkey>
  <reporterrors>
    <ReportError>
      <code>EFA104</code>
      <detail>Missing Unlocode.</detail>
      <element>$.result.CONTAINERS[0].EVENTS[1].EventLocation.UnLocode</element>
    </ReportError>
  </reporterrors>
</FunctionalAcknowledgementRequest>

application/json, text/json

Sample:

{
  "ackstatus": 3,
  "msgkey": "api/pushtracking",
  "msgid": "93a19fad-2463-4f5d-a837-fadd07afc6d4",
  "reporterrors": [
    {
      "code": "EFA104",
      "element": "$.result.CONTAINERS[0].EVENTS[1].EventLocation.UnLocode",
      "detail": "Missing Unlocode."
    }
  ],
  "apikey": "8881BA2F-5FE2-4CF1-D99E-5963J9192806",
  "username": "demoapi",
  "password": "dpassword",
  "ctoken": "af52c0ec-04d7-4a39-919a-2d3ccdc2d6bc"
}

application/x-www-form-urlencoded

Sample:

ackstatus=AcceptedWithErrors&apikey=8881BA2F-5FE2-4CF1-D99E-5963J9192806&ctoken=af52c0ec-04d7-4a39-919a-2d3ccdc2d6bc&msgid=93a19fad-2463-4f5d-a837-fadd07afc6d4&msgkey=api%2Fpushtracking&password=dpassword&reporterrors=code=EFA104&detail=Missing%20Unlocode.&element=$.result.CONTAINERS%5B0%5D.EVENTS%5B1%5D.EventLocation.UnLocode&username=demoapi

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>

Response Information

Resource Description

response

FunctionalAcknowledgementResponse

Name	Description	Type	Additional 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/xml

Sample:

<FunctionalAcknowledgementResponse>
  <ack>1</ack>
  <ctoken>af52c0ec-04d7-4a39-919a-2d3ccdc2d6bc</ctoken>
  <exceptions />
</FunctionalAcknowledgementResponse>

application/json, text/json

Sample:

{
  "ack": 1,
  "exceptions": null,
  "ctoken": "af52c0ec-04d7-4a39-919a-2d3ccdc2d6bc"
}

text/xml

Sample:

<FunctionalAcknowledgementResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ExternalRestService.Models">
  <ack>0</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>
      <validationdetails i:nil="true" />
    </ResponseExceptionDto>
    <ResponseExceptionDto>
      <errorcode>sample string 1</errorcode>
      <msg>sample string 2</msg>
      <suggestion>sample string 4</suggestion>
      <validationcodes>sample string 3</validationcodes>
      <validationdetails i:nil="true" />
    </ResponseExceptionDto>
  </exceptions>
</FunctionalAcknowledgementResponse>