Web Service: SiteService

Port type SiteServiceInterfaceSource code

1. createSites
   Source code
   Description:
   Creates new {@link Site} objects.
   Operation type:
   Request-response. The endpoint receives a message, and sends a correlated message.
   Input:
   createSitesRequest (wsdlsoap:header, use = literal, part = RequestHeader)Source code
   parameters type createSites

   Creates new {@link Site} objects.

   • sites - optional, unbounded; type Site
     • id - optional; type long
     • url - optional; type string
     • childNetworkCode - optional; type string
     • approvalStatus - optional; type ApprovalStatus - type string with restriction - enum { 'DRAFT', 'UNCHECKED', 'APPROVED', 'DISAPPROVED', 'REQUIRES_REVIEW', 'UNKNOWN' }
     • approvalStatusUpdateTime - optional; type DateTime
       • date - optional; type Date
         • year - optional; type int
         • month - optional; type int
         • day - optional; type int
       • hour - optional; type int
       • minute - optional; type int
       • second - optional; type int
       • timeZoneId - optional; type string
     • disapprovalReasons - optional, unbounded; type DisapprovalReason
       • type - optional; type DisapprovalReason.Type - type string with restriction - enum { 'CONTENT', 'OWNERSHIP', 'OTHER', 'UNKNOWN' }
       • details - optional; type string
   Output:
   createSitesResponse (wsdlsoap:header, use = literal, part = ResponseHeader)Source code
   parameters type createSitesResponse

   • rval - optional, unbounded; type Site
     • id - optional; type long
     • url - optional; type string
     • childNetworkCode - optional; type string
     • approvalStatus - optional; type ApprovalStatus - type string with restriction - enum { 'DRAFT', 'UNCHECKED', 'APPROVED', 'DISAPPROVED', 'REQUIRES_REVIEW', 'UNKNOWN' }
     • approvalStatusUpdateTime - optional; type DateTime
       • date - optional; type Date
         • year - optional; type int
         • month - optional; type int
         • day - optional; type int
       • hour - optional; type int
       • minute - optional; type int
       • second - optional; type int
       • timeZoneId - optional; type string
     • disapprovalReasons - optional, unbounded; type DisapprovalReason
       • type - optional; type DisapprovalReason.Type - type string with restriction - enum { 'CONTENT', 'OWNERSHIP', 'OTHER', 'UNKNOWN' }
       • details - optional; type string
   Fault:
   ApiException (wsdlsoap:fault, use = literal)Source code
   ApiException type ApiExceptionFault

   • message - optional; type string

   • errors - optional, unbounded; type ApiError
     • fieldPath - optional; type string
     • fieldPathElements - optional, unbounded; type FieldPathElement
       • field - optional; type string
       • index - optional; type int
     • trigger - optional; type string
     • errorString - optional; type string

   A fault element of type ApiException.
2. getSitesByStatement
   Source code
   Description:
   Gets a {@link SitePage} of {@link Site} objects that satisfy the given {@link Statement#query}. The following fields are supported for filtering:

   PQL Property	Object Property
   {@code id}	{@link Site#id}
   {@code url}	{@link Site#url}
   {@code childNetworkCode}	{@link Site#childNetworkCode}
   {@code approvalStatus}	{@link Site#approvalStatus}
   {@code lastModifiedApprovalStatusDateTime}

   Restriction: The {@code lastModifiedApprovalStatusDateTime} PQL property can only be used in a top-level expression scoping the {@code filterStatement} to {@link Site}s whose {@code approvalStatus} was modified on or after a specified date and time. (e.x. {@code "WHERE lastModifiedApprovalStatusDateTime >= '2022-01-01T00:00:00'"}).
   Operation type:
   Request-response. The endpoint receives a message, and sends a correlated message.
   Input:
   getSitesByStatementRequest (wsdlsoap:header, use = literal, part = RequestHeader)Source code
   parameters type getSitesByStatement

   Gets a {@link SitePage} of {@link Site} objects that satisfy the given {@link Statement#query}. The following fields are supported for filtering:

   PQL Property	Object Property
   {@code id}	{@link Site#id}
   {@code url}	{@link Site#url}
   {@code childNetworkCode}	{@link Site#childNetworkCode}
   {@code approvalStatus}	{@link Site#approvalStatus}
   {@code lastModifiedApprovalStatusDateTime}

   Restriction: The {@code lastModifiedApprovalStatusDateTime} PQL property can only be used in a top-level expression scoping the {@code filterStatement} to {@link Site}s whose {@code approvalStatus} was modified on or after a specified date and time. (e.x. {@code "WHERE lastModifiedApprovalStatusDateTime >= '2022-01-01T00:00:00'"}).

   • filterStatement - optional; type Statement
     • query - optional; type string
     • values - optional, unbounded; type String_ValueMapEntry
       This represents an entry in a map with a key of type String and value of type Value.
       • key - optional; type string
       • value - optional; type Value
   Output:
   getSitesByStatementResponse (wsdlsoap:header, use = literal, part = ResponseHeader)Source code
   parameters type getSitesByStatementResponse

   • rval - optional; type SitePage
     • totalResultSetSize - optional; type int
     • startIndex - optional; type int
     • results - optional, unbounded; type Site
       • id - optional; type long
       • url - optional; type string
       • childNetworkCode - optional; type string
       • approvalStatus - optional; type ApprovalStatus - type string with restriction - enum { 'DRAFT', 'UNCHECKED', 'APPROVED', 'DISAPPROVED', 'REQUIRES_REVIEW', 'UNKNOWN' }
       • approvalStatusUpdateTime - optional; type DateTime
         • date - optional; type Date
           • year - optional; type int
           • month - optional; type int
           • day - optional; type int
         • hour - optional; type int
         • minute - optional; type int
         • second - optional; type int
         • timeZoneId - optional; type string
       • disapprovalReasons - optional, unbounded; type DisapprovalReason
         • type - optional; type DisapprovalReason.Type - type string with restriction - enum { 'CONTENT', 'OWNERSHIP', 'OTHER', 'UNKNOWN' }
         • details - optional; type string
   Fault:
   ApiException (wsdlsoap:fault, use = literal)Source code
   ApiException type ApiExceptionFault

   • message - optional; type string

   • errors - optional, unbounded; type ApiError
     • fieldPath - optional; type string
     • fieldPathElements - optional, unbounded; type FieldPathElement
       • field - optional; type string
       • index - optional; type int
     • trigger - optional; type string
     • errorString - optional; type string

   A fault element of type ApiException.
3. performSiteAction
   Source code
   Description:
   Performs actions on {@link Site} objects that match the given {@link Statement#query}.
   Operation type:
   Request-response. The endpoint receives a message, and sends a correlated message.
   Input:
   performSiteActionRequest (wsdlsoap:header, use = literal, part = RequestHeader)Source code
   parameters type performSiteAction

   Performs actions on {@link Site} objects that match the given {@link Statement#query}.

   • siteAction - optional; type SiteAction
     • filterStatement - optional; type Statement
       • query - optional; type string
       • values - optional, unbounded; type String_ValueMapEntry
         This represents an entry in a map with a key of type String and value of type Value.
         • key - optional; type string
         • value - optional; type Value
   Output:
   performSiteActionResponse (wsdlsoap:header, use = literal, part = ResponseHeader)Source code
   parameters type performSiteActionResponse

   • rval - optional; type UpdateResult
     • numChanges - optional; type int
   Fault:
   ApiException (wsdlsoap:fault, use = literal)Source code
   ApiException type ApiExceptionFault

   • message - optional; type string

   • errors - optional, unbounded; type ApiError
     • fieldPath - optional; type string
     • fieldPathElements - optional, unbounded; type FieldPathElement
       • field - optional; type string
       • index - optional; type int
     • trigger - optional; type string
     • errorString - optional; type string

   A fault element of type ApiException.
4. updateSites
   Source code
   Description:
   Updates the specified {@link Site} objects.

   The {@link Site#childNetworkCode} can be updated in order to 1) change the child network, 2) move a site from O&O to represented, or 3) move a site from represented to O&O.

   Operation type:
   Request-response. The endpoint receives a message, and sends a correlated message.
   Input:
   updateSitesRequest (wsdlsoap:header, use = literal, part = RequestHeader)Source code
   parameters type updateSites

   Updates the specified {@link Site} objects.

   The {@link Site#childNetworkCode} can be updated in order to 1) change the child network, 2) move a site from O&O to represented, or 3) move a site from represented to O&O.

   • sites - optional, unbounded; type Site
     • id - optional; type long
     • url - optional; type string
     • childNetworkCode - optional; type string
     • approvalStatus - optional; type ApprovalStatus - type string with restriction - enum { 'DRAFT', 'UNCHECKED', 'APPROVED', 'DISAPPROVED', 'REQUIRES_REVIEW', 'UNKNOWN' }
     • approvalStatusUpdateTime - optional; type DateTime
       • date - optional; type Date
         • year - optional; type int
         • month - optional; type int
         • day - optional; type int
       • hour - optional; type int
       • minute - optional; type int
       • second - optional; type int
       • timeZoneId - optional; type string
     • disapprovalReasons - optional, unbounded; type DisapprovalReason
       • type - optional; type DisapprovalReason.Type - type string with restriction - enum { 'CONTENT', 'OWNERSHIP', 'OTHER', 'UNKNOWN' }
       • details - optional; type string
   Output:
   updateSitesResponse (wsdlsoap:header, use = literal, part = ResponseHeader)Source code
   parameters type updateSitesResponse

   • rval - optional, unbounded; type Site
     • id - optional; type long
     • url - optional; type string
     • childNetworkCode - optional; type string
     • approvalStatus - optional; type ApprovalStatus - type string with restriction - enum { 'DRAFT', 'UNCHECKED', 'APPROVED', 'DISAPPROVED', 'REQUIRES_REVIEW', 'UNKNOWN' }
     • approvalStatusUpdateTime - optional; type DateTime
       • date - optional; type Date
         • year - optional; type int
         • month - optional; type int
         • day - optional; type int
       • hour - optional; type int
       • minute - optional; type int
       • second - optional; type int
       • timeZoneId - optional; type string
     • disapprovalReasons - optional, unbounded; type DisapprovalReason
       • type - optional; type DisapprovalReason.Type - type string with restriction - enum { 'CONTENT', 'OWNERSHIP', 'OTHER', 'UNKNOWN' }
       • details - optional; type string
   Fault:
   ApiException (wsdlsoap:fault, use = literal)Source code
   ApiException type ApiExceptionFault

   • message - optional; type string

   • errors - optional, unbounded; type ApiError
     • fieldPath - optional; type string
     • fieldPathElements - optional, unbounded; type FieldPathElement
       • field - optional; type string
       • index - optional; type int
     • trigger - optional; type string
     • errorString - optional; type string

   A fault element of type ApiException.