POST api/PFMS/pfms_get_objecthead

Documentation for 'pfms_get_objecthead'.

Request Information

Parameters

Name	Description	Additional information
model	Documentation for 'model'.	Define this parameter in the request body.

Request body formats

application/json, text/json

Sample:

{
  "stateCode": "sample string 1",
  "AuthString": "sample string 2"
}

application/xml, text/xml

Sample:

<RequestModelGetObjectHead xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BLL.PFMS">
  <AuthString>sample string 2</AuthString>
  <stateCode>sample string 1</stateCode>
</RequestModelGetObjectHead>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'RequestModelGetObjectHead'.

Response Information

Response body formats

application/json, text/json

Sample:

{
  "AckCode": "sample string 1",
  "Status": "sample string 2",
  "Remarks": "sample string 3",
  "DateOfData": "sample string 4",
  "ObjectHeadResponse": {
    "SuccessResponse": {
      "responseData": {
        "RequestStatus": [
          {
            "UniqueIdentifier": "sample string 1",
            "RequestSource": "sample string 2",
            "ObjectHeadDetails": [
              {
                "ObjectHead": "sample string 1",
                "ObjectHeadName": "sample string 2"
              },
              {
                "ObjectHead": "sample string 1",
                "ObjectHeadName": "sample string 2"
              },
              {
                "ObjectHead": "sample string 1",
                "ObjectHeadName": "sample string 2"
              }
            ]
          },
          {
            "UniqueIdentifier": "sample string 1",
            "RequestSource": "sample string 2",
            "ObjectHeadDetails": [
              {
                "ObjectHead": "sample string 1",
                "ObjectHeadName": "sample string 2"
              },
              {
                "ObjectHead": "sample string 1",
                "ObjectHeadName": "sample string 2"
              },
              {
                "ObjectHead": "sample string 1",
                "ObjectHeadName": "sample string 2"
              }
            ]
          },
          {
            "UniqueIdentifier": "sample string 1",
            "RequestSource": "sample string 2",
            "ObjectHeadDetails": [
              {
                "ObjectHead": "sample string 1",
                "ObjectHeadName": "sample string 2"
              },
              {
                "ObjectHead": "sample string 1",
                "ObjectHeadName": "sample string 2"
              },
              {
                "ObjectHead": "sample string 1",
                "ObjectHeadName": "sample string 2"
              }
            ]
          }
        ]
      },
      "errorMessage": "sample string 1",
      "successMessage": "sample string 2",
      "isSuccess": "sample string 3",
      "errorCode": "sample string 4"
    },
    "ErrorResponse": {
      "responseData": {
        "RequestStatus": [
          {
            "UniqueIdentifier": "sample string 1",
            "RequestSource": "sample string 2",
            "Errors": [
              {
                "ErrorCode": "sample string 1",
                "ErrorMessage": "sample string 2"
              },
              {
                "ErrorCode": "sample string 1",
                "ErrorMessage": "sample string 2"
              },
              {
                "ErrorCode": "sample string 1",
                "ErrorMessage": "sample string 2"
              }
            ]
          },
          {
            "UniqueIdentifier": "sample string 1",
            "RequestSource": "sample string 2",
            "Errors": [
              {
                "ErrorCode": "sample string 1",
                "ErrorMessage": "sample string 2"
              },
              {
                "ErrorCode": "sample string 1",
                "ErrorMessage": "sample string 2"
              },
              {
                "ErrorCode": "sample string 1",
                "ErrorMessage": "sample string 2"
              }
            ]
          },
          {
            "UniqueIdentifier": "sample string 1",
            "RequestSource": "sample string 2",
            "Errors": [
              {
                "ErrorCode": "sample string 1",
                "ErrorMessage": "sample string 2"
              },
              {
                "ErrorCode": "sample string 1",
                "ErrorMessage": "sample string 2"
              },
              {
                "ErrorCode": "sample string 1",
                "ErrorMessage": "sample string 2"
              }
            ]
          }
        ]
      },
      "errorMessage": "sample string 1",
      "isSuccess": "sample string 2",
      "successMessage": "sample string 3",
      "errorCode": "sample string 4"
    }
  }
}

application/xml, text/xml

Sample:

<ResponseModelGetObjectHead xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BLL.PFMS">
  <AckCode>sample string 1</AckCode>
  <DateOfData>sample string 4</DateOfData>
  <ObjectHeadResponse>
    <ErrorResponse>
      <errorCode>sample string 4</errorCode>
      <errorMessage>sample string 1</errorMessage>
      <isSuccess>sample string 2</isSuccess>
      <responseData>
        <RequestStatus>
          <MdlGetObjectHeadErrorRequestStatus>
            <Errors>
              <MdlGetObjectHeadErrors>
                <ErrorCode>sample string 1</ErrorCode>
                <ErrorMessage>sample string 2</ErrorMessage>
              </MdlGetObjectHeadErrors>
              <MdlGetObjectHeadErrors>
                <ErrorCode>sample string 1</ErrorCode>
                <ErrorMessage>sample string 2</ErrorMessage>
              </MdlGetObjectHeadErrors>
              <MdlGetObjectHeadErrors>
                <ErrorCode>sample string 1</ErrorCode>
                <ErrorMessage>sample string 2</ErrorMessage>
              </MdlGetObjectHeadErrors>
            </Errors>
            <RequestSource>sample string 2</RequestSource>
            <UniqueIdentifier>sample string 1</UniqueIdentifier>
          </MdlGetObjectHeadErrorRequestStatus>
          <MdlGetObjectHeadErrorRequestStatus>
            <Errors>
              <MdlGetObjectHeadErrors>
                <ErrorCode>sample string 1</ErrorCode>
                <ErrorMessage>sample string 2</ErrorMessage>
              </MdlGetObjectHeadErrors>
              <MdlGetObjectHeadErrors>
                <ErrorCode>sample string 1</ErrorCode>
                <ErrorMessage>sample string 2</ErrorMessage>
              </MdlGetObjectHeadErrors>
              <MdlGetObjectHeadErrors>
                <ErrorCode>sample string 1</ErrorCode>
                <ErrorMessage>sample string 2</ErrorMessage>
              </MdlGetObjectHeadErrors>
            </Errors>
            <RequestSource>sample string 2</RequestSource>
            <UniqueIdentifier>sample string 1</UniqueIdentifier>
          </MdlGetObjectHeadErrorRequestStatus>
          <MdlGetObjectHeadErrorRequestStatus>
            <Errors>
              <MdlGetObjectHeadErrors>
                <ErrorCode>sample string 1</ErrorCode>
                <ErrorMessage>sample string 2</ErrorMessage>
              </MdlGetObjectHeadErrors>
              <MdlGetObjectHeadErrors>
                <ErrorCode>sample string 1</ErrorCode>
                <ErrorMessage>sample string 2</ErrorMessage>
              </MdlGetObjectHeadErrors>
              <MdlGetObjectHeadErrors>
                <ErrorCode>sample string 1</ErrorCode>
                <ErrorMessage>sample string 2</ErrorMessage>
              </MdlGetObjectHeadErrors>
            </Errors>
            <RequestSource>sample string 2</RequestSource>
            <UniqueIdentifier>sample string 1</UniqueIdentifier>
          </MdlGetObjectHeadErrorRequestStatus>
        </RequestStatus>
      </responseData>
      <successMessage>sample string 3</successMessage>
    </ErrorResponse>
    <SuccessResponse>
      <errorCode>sample string 4</errorCode>
      <errorMessage>sample string 1</errorMessage>
      <isSuccess>sample string 3</isSuccess>
      <responseData>
        <RequestStatus>
          <MdlGetObjectHeadRequestStatus>
            <ObjectHeadDetails>
              <MdlObjectHeadDetails>
                <ObjectHead>sample string 1</ObjectHead>
                <ObjectHeadName>sample string 2</ObjectHeadName>
              </MdlObjectHeadDetails>
              <MdlObjectHeadDetails>
                <ObjectHead>sample string 1</ObjectHead>
                <ObjectHeadName>sample string 2</ObjectHeadName>
              </MdlObjectHeadDetails>
              <MdlObjectHeadDetails>
                <ObjectHead>sample string 1</ObjectHead>
                <ObjectHeadName>sample string 2</ObjectHeadName>
              </MdlObjectHeadDetails>
            </ObjectHeadDetails>
            <RequestSource>sample string 2</RequestSource>
            <UniqueIdentifier>sample string 1</UniqueIdentifier>
          </MdlGetObjectHeadRequestStatus>
          <MdlGetObjectHeadRequestStatus>
            <ObjectHeadDetails>
              <MdlObjectHeadDetails>
                <ObjectHead>sample string 1</ObjectHead>
                <ObjectHeadName>sample string 2</ObjectHeadName>
              </MdlObjectHeadDetails>
              <MdlObjectHeadDetails>
                <ObjectHead>sample string 1</ObjectHead>
                <ObjectHeadName>sample string 2</ObjectHeadName>
              </MdlObjectHeadDetails>
              <MdlObjectHeadDetails>
                <ObjectHead>sample string 1</ObjectHead>
                <ObjectHeadName>sample string 2</ObjectHeadName>
              </MdlObjectHeadDetails>
            </ObjectHeadDetails>
            <RequestSource>sample string 2</RequestSource>
            <UniqueIdentifier>sample string 1</UniqueIdentifier>
          </MdlGetObjectHeadRequestStatus>
          <MdlGetObjectHeadRequestStatus>
            <ObjectHeadDetails>
              <MdlObjectHeadDetails>
                <ObjectHead>sample string 1</ObjectHead>
                <ObjectHeadName>sample string 2</ObjectHeadName>
              </MdlObjectHeadDetails>
              <MdlObjectHeadDetails>
                <ObjectHead>sample string 1</ObjectHead>
                <ObjectHeadName>sample string 2</ObjectHeadName>
              </MdlObjectHeadDetails>
              <MdlObjectHeadDetails>
                <ObjectHead>sample string 1</ObjectHead>
                <ObjectHeadName>sample string 2</ObjectHeadName>
              </MdlObjectHeadDetails>
            </ObjectHeadDetails>
            <RequestSource>sample string 2</RequestSource>
            <UniqueIdentifier>sample string 1</UniqueIdentifier>
          </MdlGetObjectHeadRequestStatus>
        </RequestStatus>
      </responseData>
      <successMessage>sample string 2</successMessage>
    </SuccessResponse>
  </ObjectHeadResponse>
  <Remarks>sample string 3</Remarks>
  <Status>sample string 2</Status>
</ResponseModelGetObjectHead>