POST fxo/Compliance/CorporateOwnership

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
corporate_ownership	Corporate_Ownership	Required
address	Ownership_Address	None.
detail	Collection of Corporate_Ownership_Detail	None.

Request Formats

application/json, text/json

Sample:

{
  "corporate_ownership": {
    "entity_id": 1,
    "first_name": "sample string 2",
    "last_name": "sample string 3",
    "initial": "sample string 4",
    "ownership_percent": 5.0,
    "type": {
      "value": "sample string 1",
      "id": 2
    },
    "occupation": "sample string 6",
    "date_of_birth": "sample string 7",
    "copy_from_source": "sample string 8",
    "copy_from_source_id": 9
  },
  "address": {
    "id": 1,
    "city": "sample string 2",
    "province": "sample string 3",
    "other": "sample string 4",
    "country": {
      "value": "sample string 1",
      "id": 2
    },
    "value": "sample string 5",
    "post_code": "sample string 6",
    "street_address": "sample string 7",
    "address_type": 8
  },
  "detail": [
    {
      "id": 1,
      "identification_type_id": {
        "value": "sample string 1",
        "id": 2
      },
      "identification_number": "sample string 2",
      "place_of_issue": "sample string 3",
      "issue_date": "sample string 4",
      "verification_date": "sample string 5",
      "destination_path": "sample string 6",
      "actual_file_name": "sample string 7",
      "expiry_date": "sample string 8",
      "attestation_method_id": {
        "value": "sample string 1",
        "id": 2
      }
    },
    {
      "id": 1,
      "identification_type_id": {
        "value": "sample string 1",
        "id": 2
      },
      "identification_number": "sample string 2",
      "place_of_issue": "sample string 3",
      "issue_date": "sample string 4",
      "verification_date": "sample string 5",
      "destination_path": "sample string 6",
      "actual_file_name": "sample string 7",
      "expiry_date": "sample string 8",
      "attestation_method_id": {
        "value": "sample string 1",
        "id": 2
      }
    }
  ]
}

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 'CreateCorporateOwnership'.

application/xml

Sample:

An exception has occurred while using the formatter 'CustomXmlFormatter' to generate sample for media type 'application/xml'. Exception message: Cannot access a closed Stream.

text/xml

Sample:

An exception has occurred while using the formatter 'CustomXmlFormatter' to generate sample for media type 'text/xml'. Exception message: Cannot access a closed Stream.

Response Information

Resource Description

DSOutput

Name	Type	Additional information
status	boolean	None.
data	Object	None.
code	integer	None.
message	string	None.
error	Error	None.
paging	Paging	None.
additional_codes	string	None.

Response Formats

application/json, text/json

Sample:

{
  "status": true,
  "data": {},
  "code": 0,
  "message": "sample string 3",
  "error": {
    "code": 0,
    "message": "sample string 1",
    "target": "sample string 2",
    "details": [
      {
        "code": 0,
        "target": "sample string 1",
        "message": "sample string 2"
      },
      {
        "code": 0,
        "target": "sample string 1",
        "message": "sample string 2"
      }
    ]
  },
  "paging": {
    "page_number": 1,
    "page_size": 2,
    "page_from": 3,
    "page_to": 4,
    "record_count": 5
  },
  "additional_codes": "sample string 4"
}

application/xml

Sample:

An exception has occurred while using the formatter 'CustomXmlFormatter' to generate sample for media type 'application/xml'. Exception message: Cannot access a closed Stream.

text/xml

Sample:

An exception has occurred while using the formatter 'CustomXmlFormatter' to generate sample for media type 'text/xml'. Exception message: Cannot access a closed Stream.