POST credential/format

Handle request to format a Credential document as CTDL Json-LD

Request Information

URI Parameters

None.

Body Parameters

RA.Models.Input.CredentialRequest
NameDescriptionTypeAdditional information
Credential

RA.Models.Input.Credential

None.

Credentials

Collection of RA.Models.Input.Credential

None.

DefaultLanguage

string

None.

PublishForOrganizationIdentifier

string

None.

RegistryEnvelopeId

string

None.

Community

string

None.

Request Formats

application/json

Sample:

Sample not available.

text/json

Sample:

Sample not available.

text/html

Sample:

Sample not available.

application/xml

Sample:

Sample not available.

text/xml

Sample:

Sample not available.

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

RA.Models.RegistryAssistantFormatResponse
NameDescriptionTypeAdditional information
Successful

boolean

None.

Messages

Collection of string

None.

Payload

string

None.

Response Formats

application/json, text/json

Sample:
{
  "Successful": true,
  "Messages": [
    "sample string 1",
    "sample string 2"
  ],
  "Payload": "sample string 2"
}

text/html

Sample:
{"Successful":true,"Messages":["sample string 1","sample string 2"],"Payload":"sample string 2"}

application/xml, text/xml

Sample:
<RegistryAssistantFormatResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RA.Models">
  <Messages xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </Messages>
  <Payload>sample string 2</Payload>
  <Successful>true</Successful>
</RegistryAssistantFormatResponse>