Legals API
{ urn:com.soa.legals.api } LegalsAPI
The Legals service provides the ability to manage legal agreements in the Akana API Platform. Note that these operations are for managing legal agreements general to the platform, such as end-user license agreements. Operations relating to legal agreements for access to a specific API are part of the APIs service.
GET/legalslistAgreementDocuments
Parameters
Name
Type
Description
Model
AgreementType
query
string
ResourceID
query
string
Reponse
Produces application/vnd.soa.v71+xmlapplication/vnd.soa.v72+xmlapplication/vnd.soa.v80+xmlapplication/vnd.soa.v71+jsonapplication/vnd.soa.v72+jsonapplication/vnd.soa.v80+jsonapplication/vnd.soa.v81+jsonapplication/vnd.soa.v81+xml
Status Code
Reason
Model
200
Success
AgreementDocuments
AgreementDocuments {
AgreementDocument {
TargetResource {
Image {
AgreementDocument( Collection of AgreementDocument )
}
AgreementDocument {
AgreementType( string )
DocumentState( string )
Description( string )
FileName( string )
DocumentID( string )
ResourceType( string )
ContentPath( string )
Name( string )
TargetResources( Collection of TargetResource )
Active( boolean )
PrintContentPath( string )
PrintVersion( int )
ResourceID( string )
MetadataResourceURI( string )
MetadataResourceVersion( int )
PrintResourceURI( string )
Link( string )
}
TargetResource {
Type( string )
IsResourceLevelPermissionSupported( boolean )
Visibility( string )
ID( string )
Image( Image )
Avatar( string )
Name( string )
}
Image {
Description( string )
Title( string )
Url( anyURI )
Link( anyURI )
}
GET/legalsgetAgreementDocuments
Parameters
Name
Type
Description
Model
AgreementType
query
string
ResourceID
query
string
Reponse
Produces text/xmlapplication/jsonapplication/xmlapplication/rss+xml
Status Code
Reason
Model
200
Success
rss
rss {
rssChannel {
rssImage {
rssItem {
rssEnclosure {
rssGuid {}
rssSource {}
rssCategory {}
rssSkipHours {
rssSkipDays {
rssCloud {
rssTextInput {
channel( rssChannel )
version( string )
}
rssChannel {
image( rssImage )
copyright( string )
item( rssItem )
skipHours( rssSkipHours )
lastBuildDate( string )
link( anyURI )
rating( string )
description( string )
generator( string )
language( string )
title( string )
managingEditor( string )
webMaster( string )
pubDate( string )
ttl( int )
skipDays( rssSkipDays )
cloud( rssCloud )
textInput( rssTextInput )
docs( anyURI )
category( rssCategory )
}
rssImage {
link( anyURI )
width( int )
description( string )
title( string )
url( string )
height( int )
}
rssItem {
comments( anyURI )
enclosure( rssEnclosure )
author( string )
link( anyURI )
description( string )
guid( rssGuid )
source( rssSource )
title( string )
category( rssCategory )
pubDate( string )
}
rssEnclosure {
length( string )
type( string )
url( string )
}
rssGuid {}
rssSource {}
rssCategory {}
rssSkipHours {
hour( Collection of string )
}
rssSkipDays {
day( Collection of string )
}
rssCloud {
path( string )
protocol( string )
port( int )
registerProcedure( string )
domain( string )
}
rssTextInput {
name( string )
link( anyURI )
description( string )
title( string )
}
POST/legalscreateNewAgreement
Parameters
Accepts application/json application/vnd.soa.v71+json application/vnd.soa.v72+json application/vnd.soa.v80+json application/vnd.soa.v71+xml application/vnd.soa.v72+xml application/vnd.soa.v80+xml application/vnd.soa.v81+json application/vnd.soa.v81+xml
Name
Type
Description
Model
body
entity
AgreementDocument
AgreementDocument {
TargetResource {
Image {
AgreementType( string, required )
DocumentState( string, required )
Description( string )
FileName( string, required )
DocumentID( string )
ResourceType( string )
ContentPath( string, required )
Name( string, required )
TargetResources( Collection of TargetResource, required )
Active( boolean, required )
PrintContentPath( string, required )
PrintVersion( int )
ResourceID( string )
MetadataResourceURI( string )
MetadataResourceVersion( int )
PrintResourceURI( string )
Link( string, required )
}
TargetResource {
Type( string )
IsResourceLevelPermissionSupported( boolean )
Visibility( string )
ID( string )
Image( Image, required )
Avatar( string )
Name( string )
}
Image {
Description( string )
Title( string, required )
Url( anyURI, required )
Link( anyURI, required )
}
Reponse
Produces text/plain
Status Code
Reason
Model
200
Success
any
POST/legals/agreementsacceptAgreement
Parameters
Accepts application/json application/vnd.soa.v71+json application/vnd.soa.v72+json application/vnd.soa.v80+json application/vnd.soa.v81+json application/vnd.soa.v81+xml
Name
Type
Description
Model
body
entity
UserAgreement
UserAgreement {
AgreementID( long )
AgreementDate( dateTime, required )
UserID( string, required )
DocumentID( string, required )
AgreementScopeID( string )
}
Reponse
Produces text/plain
Status Code
Reason
Model
200
Success
any
GET/legals/{DocumentID}getAgreementDocument
Parameters
Accepts */*
Name
Type
Description
Model
DocumentID
path
string
Reponse
Produces application/jsonapplication/vnd.soa.v71+jsonapplication/vnd.soa.v72+jsonapplication/vnd.soa.v80+jsonapplication/vnd.soa.v71+xmlapplication/vnd.soa.v72+xmlapplication/vnd.soa.v80+xmlapplication/vnd.soa.v81+jsonapplication/vnd.soa.v81+xml
Status Code
Reason
Model
200
Success
any
PUT/legals/{DocumentID}updateAgreement
Parameters
Accepts application/json application/vnd.soa.v71+json application/vnd.soa.v72+json application/vnd.soa.v80+json application/vnd.soa.v71+xml application/vnd.soa.v72+xml application/vnd.soa.v80+xml application/vnd.soa.v81+json application/vnd.soa.v81+xml
Name
Type
Description
Model
DocumentID
path
string
body
entity
AgreementDocument
AgreementDocument {
TargetResource {
Image {
AgreementType( string, required )
DocumentState( string, required )
Description( string )
FileName( string, required )
DocumentID( string )
ResourceType( string )
ContentPath( string, required )
Name( string, required )
TargetResources( Collection of TargetResource, required )
Active( boolean, required )
PrintContentPath( string, required )
PrintVersion( int )
ResourceID( string )
MetadataResourceURI( string )
MetadataResourceVersion( int )
PrintResourceURI( string )
Link( string, required )
}
TargetResource {
Type( string )
IsResourceLevelPermissionSupported( boolean )
Visibility( string )
ID( string )
Image( Image, required )
Avatar( string )
Name( string )
}
Image {
Description( string )
Title( string, required )
Url( anyURI, required )
Link( anyURI, required )
}
Reponse
Produces text/plain
Status Code
Reason
Model
200
Success
any
DELETE/legals/{DocumentID}deleteAgreement
Parameters
Name
Type
Description
Model
DocumentID
path
string
Reponse
Produces text/plain
Status Code
Reason
Model
200
Success
any
