Was this page helpful?

request

    Request

    Request tracking resource.

    It is identified by the hash property.

    The creation of the request does not require credentials.

    Request List

    Path:

    /server/{server-name}/request
    

    Get request list

    Method: GET

    Credentials: not required if api key is specified

    Response: object with following properties

    name value description
    item array[request] list of requests
    count integer total number of requests for given list if includeCount request parameter is specified
    lastModified long date in milliseconds of the lates modified request in the returned list if modifiedSince request parameter was specified

    Parameters:

    name value description
    apiKey string authorization key used instead of credentials
    createdSince string restrict result only to request created since given date (including) in ISO format or number of milliseconds since 1.1.1970 
    createdBefore long restrict result only to request created before given date (excluding) in ISO format or number of milliseconds since 1.1.1970
    includeCount true | false whether to include count parameter in result that contais total number if items in result disregarding limit or offset
    lang string two letter ISO language code, defines langugae of textQuery parameter (default is en)
    limit integer maximum number of result to retrieve, -1to retrieve all results, 0 to omit list from result (when includeCount=true) and get only the count
    modifiedSince string restrict result to request modified since the given date in milliseconds, the value of lastModified result parameter is supposed to be used here (formated in ISO format or number of milliseconds since 1.1.1970), optionaly limit can be used to page thru result
    offset integer offset of the first item to retrieve (used together with limit)
    recipient string identifier of the recipient, restricts the list of request to only those whose direct recipient is the resource identified by recipient
    sender string identifier of the sender, restricts the list of request to only those whose sender is the resource identified by recipient
    side enumeration ANY | PENDING | NOT_PENDING - resctrict result only to those where I'm on specified side (default is ANY)
    status string one or more status values delimited with comma, status values: ACCEPTED | CLOSED | DISMISSED | INITIAL | RESOLVING | RESOLVED
    type string one or more type values delimited with the comma; type values: CONFIRMATION_REQUEST | CREATE_ACCOUNT | CREATE_PROVIDER | DOWNLOAD_REQUEST | GENERIC | INVITE_BUDDY | INVITE_PROVIDER_DISPATCHER | INVITE_PROVIDER_ADMIN | INVITE_PROJECT_PARTICIPANT | INVITE_PROVIDER | PAYMENT_REQUEST | SHARE_DOCUMENT | SHARE_PROJECT
    textQuery string full-text search query, for syntax see PostgreSQL doucmentation

    Create request

    Method: POST

    Credentials: not required if api key is specified

    Payload: request object

    Parameters:

    name value description
    apiKey string authorization key used instead of credentials

     

    Request Instance

    Path:

    /server/{server-name}/request/{request.hash}

    Get request

    Method: GET

    Credentials: not required if api key is specified

    Response: request object

    Parameters:

    name value description
    apiKey string authorization key used instead of credentials

     

    Update request

    Method: PUT

    Credentials: not required if api key is specified

    Payload: request object

    Response: request object (updated)

    Parameters:

    name value description
    apiKey string authorization key used instead of credentials

    Delete request

    Method: DELETE

    Credentials: not required if api key is specified

    Parameters:

    name value description
    apiKey string authorization key used instead of credentials

    Definitions

    request

    property value description
    address1 string address field of the author
    address2 string second address field of the author
    attachments array[attachment] list of documents, requests and other resources attached to the request
    author string(w/o) resource identifier of the author of the request update, additionaly to authorized resource (logged user) it can be to organization resource where the authorized resource is administrator or dispatcher and that is also participant on that request
    changeSets array[changeSet](r/o) list of changes made to the request since creation
    comment string(w/o) Comment added then to set of changes made to the request. Ignored when creating request.
    companyName string name of the company of the author
    countryCode string two character ISO code of the country of the author
    created date(r/o) date and time when the request was created
    customFields array[customField] list of custom form fields
    customType string custom request type
    emailAddress string email address, if sender is also specified and sender is resource of type organization then email address is converted to supplemental sender resource, if sender is person then email address must be either omited or must match the sender identifier if sender is not specified the email address is assigned to sender
    estimatedDuration integer estimated duration as integer units-independent (extranet now uses hours)
    firstName string first name of the author
    formIdentifier string(r/o after creation) custom string identifying form, strings starting with com.atollon. are reserved by Atollon Ltd.
    hash string(r/o) unique hash identifier of the request
    language string langugae of the request, two letter ISO language code optionaly supplemented with two capital letter ISO country code separated by underscore (i.e. "en_US")
    lastName string last name of the author
    messageBody string request body
    modified date(r/o) date and time when the request was modified
    mySide enumeration(r/o) on behalf of which party is currently logged user authorized to manipulate the request: NONE | SENDER | RECIPIENT | BOTH. Note that this propert is influenced by the side parameter of the query as it filters out the other side of the relation if any so that BOTH can change to SENDER or RECIPIENT for the same request if the side parameter is set
    ownerInstanceName string deprecated - (required if not ownerUserName specified) name of request owner instance, request owner is entity that alowed creation of the request
    ownerUserName string deprecated - (required if not ownerInstanceName specified) name of the user owner (see ownerInstanceName)
    pendingSide enumeration required - which party is now "having the ball" : SENDER | RECIPIENT
    phoneNumber string phone number
    priceAmount number price amount as decimal number (0-999999999999.9999) 
    priceCurrency string three letter ISO currency code in upper case
    priceTaxAmount number price tax amount as decimal number (0-999999999999.9999) 
    project requestResource project resource assigned as recipient to the request (value must be resource of type PROJECT)
    recipient requestResource(r/o) primary recipient of the resource (preferrably organization resource)
    recipientBaseId integer serial id of the request unique for recipient, null if the request has not such id
    recipients array[recipient] required at least one item - list of request recipinets, it should be only resources of type PERSON or ORGANIZATION, for backward compatibility the PROJECT type of resource is also supported but it's support is deprecated, use project property of the request to set project
    region string region of the author
    requestSource string(r/o) the origin of the request (web site or server address)
    sender string resource identifier of the sender, either of type person or organization
    senderName string(r/o) name of the sender resource
    severity short severity of the request (0 - 10)
    status enumeration required - request status: ACCEPTED | CLOSED | DISMISSED | INITIAL | RESOLVING | RESOLVED
    statusColor string color of the status
    statusComment string further description of the status
    subject string required - request subject
    supplementalSender requestResource

    supplement to sender, either person or organization, can specify additional sender resource to the sender itself

    transactionId integer(w/o) id of the transaction associated with changes made to subresource (attached file) that is put in one transaction with request update designated with this id resulting in single change set to be created for the change including also the subresource changes
    type enumeration required - type of the message: CONFIRMATION_REQUEST | CREATE_ACCOUNT | CREATE_PROVIDER | DOWNLOAD_REQUEST | GENERIC | INVITE_BUDDY | INVITE_PROVIDER_DISPATCHER | INVITE_PROVIDER_ADMIN | INVITE_PROJECT_PARTICIPANT | INVITE_PROVIDER | PAYMENT_REQUEST | SHARE_DOCUMENT | SHARE_PROJECT

    attachment

    property value description
    (one of the property must be specified)
    id string required - identifier of the attachment - hash of the request, id of the document, external resource identifier
    kind enumeration kind of attachment: DOCUMENT | EXTERNAL_RESOURCE | REQUEST
    name string human readable name of the attachment

    changeSet

    property value description
    changes array[change] list of changes made in one change set
    comment string comment added to the change set
    created date date and time the request was created
    madeBy string identifier of the resource that made the changes

    customField

    property value description
    name string required - custom field name
    value string required - custom field value in string representation

    recipient

    property value description
    extnds requestResource
    ... requestResource(r/o) rest of the fields are inherited from the requets resource

    requestChange

    property value description
    fieldName string name of the field that changed
    kind enumeration kind of change: UPDATE | ADD | REMOVE
    newValue string string representation of the value to which the field was changed
    newValueName string user readable representation of the value to which the field was changed
    value string string representation of the original value
    valueName string user readable representation of the original value
    Was this page helpful?
    Tag page (Edit tags)
    • No tags
    Pages that link here
    Page statistics
    7441 view(s), 40 edit(s), and 19498 character(s)

    Comments

    You must login to post a comment.

    Attach file

    Attachments